GroupDocs.Translation-Cloud 23.6.1-pre

GroupDocs.Translation.Cloud.Sdk.NET (.NET)

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• SDK version: 1.0.0
• Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen

<a name="frameworks-supported"></a>

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext

<a name="dependencies"></a>

Dependencies

• RestSharp - 106.13.0 or later
• Json.NET - 13.0.2 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

<a name="installation"></a>

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using GroupDocs.Translation.Cloud.Sdk.NET.Api;
using GroupDocs.Translation.Cloud.Sdk.NET.Client;
using GroupDocs.Translation.Cloud.Sdk.NET.Model;

<a name="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

<a name="getting-started"></a>

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using GroupDocs.Translation.Cloud.Sdk.NET.Api;
using GroupDocs.Translation.Cloud.Sdk.NET.Client;
using GroupDocs.Translation.Cloud.Sdk.NET.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api.groupdocs.cloud/v2.0/translation";
            // Configure OAuth2 ClientId and ClientSecret: JWT
            config.OAuthClientId = "YOU_CLIENT_ID";
            config.OAuthClientSecret = "YOU_CLIENT_SECRET";

            var apiInstance = new TransportApi(config);
            var format = "Unknown";  // string | Input file format (default to Unknown)
            var outFormat = "outFormat_example";  // string | output file format
            var source = "\"en\"";  // string | Language of original file (default to "en")
            var targets = new List<string>(); // List<string> | List of target languages
            var file = new System.IO.MemoryStream(System.IO.File.ReadAllBytes("/path/to/file.txt"));  // System.IO.Stream | File as byte array
            var url = "url_example";  // string | Link to file for translation (optional) 
            var masters = false;  // bool? | If translate master slides (optional)  (default to false)
            var formatting = true;  // bool? | If document's formatting should be preserved, default true (optional)  (default to true)
            var origin = "origin_example";  // string | for analysis only (optional) 
            var route = "route_example";  // string | endpoints route (optional) 
            var separator = "separator_example";  // string | Separator in files (optional) 
            var elements = new List<int>(); // List<int> | List of slides to translate (optional) 
            var shortCodeList = new List<List<string>>(); // List<List<string>> | Dictiory of short code names and parameters names to translate (optional) 
            var frontMatterList = new List<List<string>>(); // List<List<string>> | Dictionary where key is zero-based front matter index and value is list of lists of front matter paths (optional) 
            var savingMode = "Files";  // string | Toggle file saving mode for storage.  Is Files by default. (optional) 

            try
            {
                // Translate any supported file
                StatusResponse result = apiInstance.AllFormatsPost(format, outFormat, source, targets, file, url, masters, formatting, origin, route, separator, elements, shortCodeList, frontMatterList, savingMode);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling TransportApi.AllFormatsPost: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

<a name="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

All URIs are relative to https://api.groupdocs.cloud/v2.0/translation

<a name="documentation-for-models"></a>

Documentation for Models

• Model.CloudFileResponse
• Model.CloudHugoResponse
• Model.CloudTextResponse
• Model.HealthCheckStatus
• Model.LanguagePairData
• Model.StatusResponse
• Model.TextRequest
• Model.UrlFileInfo

<a name="documentation-for-authorization"></a>

Documentation for Authorization

<a name="JWT"></a>

JWT

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A