Skip to content

Contracts

The request and response types used by PdfClient live in PdfAPI.Core, a single assembly referenced by both the client and the API. This page identifies that assembly and points to its canonical documentation; it does not restate its types.

Field Value
Contracts assembly PdfAPI.Core
Referenced by PdfAPI.Client and PdfAPI
Shipped in this package Yes (lib\net45\PdfAPI.Core.dll and src\PdfAPI.Core)
Documented by this run Yes
Canonical documentation PdfAPI.Core

PdfAPI.Core is also referenced by Pdf.Local.Client — a shared contracts assembly is evidence of a shared type vocabulary, never of client status; Pdf.Local.Client performs no HTTP and is not documented under docs/clients/.

Types used by this client

The table lists only the contract types that appear on the public surface of IPdfClient/ PdfClient. Each type's fields, validation, and semantics are documented in the canonical set linked above.

Type Kind Used as Members that use it
ConvertRequest Class Request Convert(ConvertRequest request)
MergeRequest Class Request Merge(MergeRequest request)
PdfResult Class Response Convert(ConvertRequest request), Convert(byte[] file, string fileExtension, PdfFormat format = PdfFormat.Pdf), Extract(DocumentRange range), Merge(MergeRequest request)
PdfTrackingInfo Class Response Track(long trackingId)
PdfFormat Enum Request Convert(byte[] file, string fileExtension, PdfFormat format = PdfFormat.Pdf)
DocumentRange Class Request Extract(DocumentRange range)

Versioning and drift

Risk Detail
Assembly shipped in this package PdfAPI.Core.dll built alongside PdfAPI.Client.dll from the same repository and packed via IncludeReferencedProjects: true
Version consumed by the API The API references the same in-repository PdfAPI.Core project
Drift consequence A consumer resolving a different PdfAPI.Core than the API serializes against would see deserialization failures rather than compile errors — not observed as an active risk in this repository, since both the API and the client build from the same PdfAPI.Core project

Sources

  • PdfAPI.Client\PdfClient.cs
  • PdfAPI.Client\IPdfClient.cs
  • PdfAPI.Client\PdfAPI.Client.csproj
  • PdfAPI.Core\ConvertRequest.cs
  • PdfAPI.Core\MergeRequest.cs
  • PdfAPI.Core\PdfResult.cs
  • PdfAPI.Core\PdfTrackingInfo.cs
  • PdfAPI.Core\PdfFormat.cs
  • PdfAPI.Core\Extract\DocumentRange.cs