Nethouse.DocumentGenerator.Client 1.0.8

dotnet add package Nethouse.DocumentGenerator.Client --version 1.0.8
                    
NuGet\Install-Package Nethouse.DocumentGenerator.Client -Version 1.0.8
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Nethouse.DocumentGenerator.Client" Version="1.0.8" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Nethouse.DocumentGenerator.Client" Version="1.0.8" />
                    
Directory.Packages.props
<PackageReference Include="Nethouse.DocumentGenerator.Client" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Nethouse.DocumentGenerator.Client --version 1.0.8
                    
#r "nuget: Nethouse.DocumentGenerator.Client, 1.0.8"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Nethouse.DocumentGenerator.Client@1.0.8
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Nethouse.DocumentGenerator.Client&version=1.0.8
                    
Install as a Cake Addin
#tool nuget:?package=Nethouse.DocumentGenerator.Client&version=1.0.8
                    
Install as a Cake Tool

Nethouse Document Generator .NET SDK

Turn structured business data into polished DOCX and PDF documents with reusable Word templates.

Nethouse.DocumentGenerator.Client gives .NET applications a typed, fluent way to integrate with a Nethouse Document Generator deployment. Keep document layout in Word templates while your application focuses on its business data and workflows.

Why use the SDK?

  • Build faster with a typed .NET integration instead of hand-written HTTP calls.
  • Reuse templates across applications, document types, languages, and business processes.
  • Generate DOCX or PDF from strongly typed models or existing JSON data.
  • Scale document workflows from individual documents to asynchronous batches.
  • Keep ownership clear: applications provide data and choose outputs; templates control presentation.

Typical use cases include invoices, contracts, reports, customer communications, forms, and other business documents that need consistent, maintainable formatting.

Install

dotnet add package Nethouse.DocumentGenerator.Client

The client targets .NET 10. It connects to a Nethouse Document Generator deployment supplied by your organization or deployment provider.

Quick start

Register the client in your application at startup:

builder.Services.AddDocumentsGeneratorClient(builder.Configuration);

Resolve the factory from dependency injection and create a client for the default deployment:

var apiClientFactory = serviceProvider.GetRequiredService<IApiClientFactory>();
var client = apiClientFactory.Create();

Define a model that represents the data used by your template, then generate a document:

public sealed record OrderLine(string Description, int Quantity, decimal UnitPrice);

public sealed record OrderDocument(
    string OrderNumber,
    string CustomerName,
    IReadOnlyList<OrderLine> Lines);

var order = new OrderDocument(
    "ORD-42",
    "A. Example",
    [new OrderLine("Installation", 1, 120.00m)]);

var document = await client.For(order)
    .UsingTemplate("OrderConfirmation", "en-US")
    .AsPdf()
    .WithGeneratedFileName($"order-{order.OrderNumber}.pdf")
    .GenerateAsync(cancellationToken);

await File.WriteAllBytesAsync(document.FileName, document.FileContent, cancellationToken);

The deployment must contain a compatible template, and your application must be configured with the connection and authentication settings provided by the deployment owner. Keep credentials in a secret provider or environment variables, never in source control.

What you can build

The SDK supports the main application workflows around document generation:

  • typed model and raw JSON generation;
  • DOCX and PDF output;
  • streaming and batch document processing;
  • schema and template access;
  • generated-document retrieval and archive workflows;
  • reusable shared data for templates.

For exact deployment capabilities and configuration requirements, use the documentation supplied with your Nethouse deployment.

Learn more

Visit documentsgenerator.org for product information and documentation.

The SDK is intended for integration with a Nethouse Document Generator deployment. It does not deploy the service or create templates; those capabilities are provided by the surrounding Nethouse platform and its deployment tools.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Current .NET 10 client for typed and raw JSON document generation, DOCX/PDF and signed PDF output, template-version selection, streaming and batch workflows, archive/schema/template/common-data/audit/data-package APIs, and environment snapshot export/import/replacement plus reset operations. Shared API contracts are bundled without a separate contracts package dependency.