gotenberg

Oct 5, 2025

Changes in this version

type Client

+ func (c *Client) SetTransport(rt http.RoundTripper) *Client

+ func (c *Client) Use(middleware func(http.RoundTripper) http.RoundTripper) *Client

Oct 5, 2025

Changes in this version

type Client

+ func (c *Client) WithLogger(logger Logger) *Client

+ type Logger = httpclient.Logger

Oct 4, 2025

Changes in this version

+ type CircuitBreakerConfig = httpclient.CircuitBreakerConfig

type Client

+ func (c *Client) WithCircuitBreaker() *Client

+ func (c *Client) WithCircuitBreakerConfig(config CircuitBreakerConfig) *Client

+ func (c *Client) WithLogging() *Client

+ func (c *Client) WithRateLimit(capacity int, refillRate time.Duration) *Client

+ func (c *Client) WithRetry() *Client

+ func (c *Client) WithRetryConfig(config RetryConfig) *Client

+ type RetryConfig = httpclient.RetryConfig

Oct 4, 2025

Changes in this version

type Client

+ func (c *Client) GetHealth(ctx context.Context) (*HealthResponse, error)

+ func (c *Client) GetMetrics(ctx context.Context) (string, error)

+ func (c *Client) GetVersion(ctx context.Context) (string, error)

+ type HealthResponse struct

+ Details map[string]any

+ Status string

Oct 4, 2025

Changes in this version

+ type DownloadItem = gotenberg.DownloadFrom

Oct 3, 2025

Changes in this version

type Client

+ func (c *Client) LibreOffice() *libreoffice.LibreOffice

+ func (c *Client) PDFEngines() *pdfengines.PDFEngines

Oct 3, 2025

Changes in this version

type Client

+ func (c *Client) Chromium() *chromium.Chromium

Sep 30, 2025

Changes in this version

type Request

+ func (r *Request) PaperSizeA6() *Request

Sep 30, 2025

Changes in this version

type Request

+ func (r *Request) WebhookHeader(key, value string) *Request

Sep 30, 2025

Changes in this version

type Request

+ func (r *Request) Param(key, value string) *Request

Sep 29, 2025

Changes in this version

type Request

+ func (r *Request) WebhookErrorURL(url, method string) *Request

+ func (r *Request) WebhookHeaders(headers map[string]string) *Request

+ func (r *Request) WebhookURL(url, method string) *Request

Sep 28, 2025

Changes in this version

type Response

+ GotenbergTrace string

Sep 28, 2025

Changes in this version

+ const HeaderGotenbergTrace

+ const HeaderOutputFilename

type Request

+ func (r *Request) OutputFilename(filename string) *Request

+ type Response struct

Sep 28, 2025

Changes in this version

type Client

+ func (c *Client) MethodDelete(ctx context.Context, path string) *Request

+ func (c *Client) MethodGet(ctx context.Context, path string) *Request

+ func (c *Client) MethodPatch(ctx context.Context, path string) *Request

+ func (c *Client) MethodPost(ctx context.Context, path string) *Request

+ func (c *Client) MethodPut(ctx context.Context, path string) *Request

type Request

+ func (r *Request) Body(body io.ReadCloser) *Request

+ func (r *Request) BytesBody(body []byte) *Request

+ func (r *Request) ContentType(contentType string) *Request

+ func (r *Request) Err() error

+ func (r *Request) Headers(headers map[string]string) *Request

+ func (r *Request) JSONBody(body any) *Request

+ func (r *Request) JSONContentType() *Request

+ func (r *Request) Multipart() *Request

+ func (r *Request) QueryParam(key, value string) *Request

+ func (r *Request) QueryParams(params map[string]string) *Request

+ func (r *Request) QueryValues(values url.Values) *Request

+ func (r *Request) StringBody(body string) *Request

Sep 28, 2025

Changes in this version

+ type Request struct

+ func (r *Request) Bool(fieldName string, value bool) *Request

+ func (r *Request) File(fieldName, filename string, content io.Reader) *Request

+ func (r *Request) Float(fieldName string, value float64) *Request

+ func (r *Request) FormField(fieldName, value string) *Request

+ func (r *Request) Header(key, value string) *Request

+ func (r *Request) Margins(top, right, bottom, left float64) *Request

+ func (r *Request) PaperSize(width, height float64) *Request

+ func (r *Request) PaperSizeA4() *Request

+ func (r *Request) PaperSizeLetter() *Request

+ func (r *Request) Send() (*http.Response, error)

+ func (r *Request) WebhookErrorURLMethodPost(url string) *Request

+ func (r *Request) WebhookExtraHeaders(headers map[string]string) *Request

+ func (r *Request) WebhookURLMethodPost(url string) *Request

Sep 28, 2025

Changes in this version

+ const ApplicationJSON

+ const ContentLength

+ const ContentType

type Client

+ func (c *Client) AsyncConvertHTML(ctx context.Context, ...) (*http.Response, error)

+ type RequestOptions func(r *http.Request) error

+ func WebhookExtraHTTPHeaders(headers map[string]string) RequestOptions

+ func WithBytesBody(body []byte) RequestOptions

+ func WithHost() RequestOptions

+ func WithJSONBody(body interface{}) RequestOptions

+ func WithQueryParams(values url.Values) RequestOptions

+ func WithReaderBody(body io.ReadCloser) RequestOptions

Sep 28, 2025

Changes in this version

+ const ConvertHTML

+ const ConvertURL

+ const FieldFiles

+ const FieldURL

+ const FileFooterHTML

+ const FileHeaderHTML

+ const FileIndexHTML

+ const FileStylesCSS

type Client

+ func (c *Client) Bool(field string, value bool) *Client

+ func (c *Client) ConvertHTML(ctx context.Context) (*http.Response, error)

+ func (c *Client) ConvertURL(ctx context.Context) (*http.Response, error)

+ func (c *Client) Err() error

+ func (c *Client) File(filename string, content io.Reader) *Client

+ func (c *Client) Float(field string, value float64) *Client

+ func (c *Client) FooterHTML(html io.Reader) *Client

+ func (c *Client) Header(name, value string) *Client

+ func (c *Client) HeaderHTML(html io.Reader) *Client

+ func (c *Client) IndexHTML(html io.Reader) *Client

+ func (c *Client) Margins(top, right, bottom, left float64) *Client

+ func (c *Client) PaperSize(width, height float64) *Client

+ func (c *Client) PaperSizeA4() *Client

+ func (c *Client) PaperSizeLetter() *Client

+ func (c *Client) ResetClient() *Client

+ func (c *Client) String(field string, value string) *Client

+ func (c *Client) StylesCSS(css io.Reader) *Client

+ func (c *Client) URL(url string) *Client

+ func (c *Client) WebhookErrorURL(url, method string) *Client

+ func (c *Client) WebhookExtraHTTPHeaders(headers map[string]string) *Client

+ func (c *Client) WebhookURL(url, method string) *Client

+ type Header struct

+ Name string

+ Value string

Sep 27, 2025

Changes in this version

type Client

+ func (c *Client) BufferSize() int

+ func (c *Client) ContentType() string

+ func (c *Client) Execute(ctx context.Context) (*http.Response, error)

+ func (c *Client) ExecuteHTML(ctx context.Context) (*http.Response, error)

+ func (c *Client) ExecuteURL(ctx context.Context) (*http.Response, error)

+ func (c *Client) Reset()

+ func (c *Client) SetWebhookError(url, method string) error

+ func (c *Client) SetWebhookHeaders(headers map[string]string) error

+ func (c *Client) SetWebhookSuccess(url, method string) error

+ func (c *Client) WriteBoolProperty(field string, value bool) error

+ func (c *Client) WriteFile(filename string, content io.Reader) error

+ func (c *Client) WriteHTML(html io.Reader) error

+ func (c *Client) WriteMargins(top, right, bottom, left float64) error

+ func (c *Client) WritePaperSize(width, height float64) error

+ func (c *Client) WriteStringProperty(field, value string) error

+ func (c *Client) WriteURL(url string) error

Sep 27, 2025

Changes in this version

+ type ClientBuilder struct

+ func NewClientBuilder(client *http.Client, baseURL string) *ClientBuilder

+ func (cb *ClientBuilder) Build() *Client

+ func (cb *ClientBuilder) ConvertHTML() *HTMLConversionBuilder

+ func (cb *ClientBuilder) ConvertURL() *URLConversionBuilder

+ type HTMLConversionBuilder struct

+ func (hcb *HTMLConversionBuilder) Execute(ctx context.Context, html io.Reader) (*http.Response, error)

+ func (hcb *HTMLConversionBuilder) GenerateDocumentOutline(enabled bool) *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) GenerateTaggedPDF(enabled bool) *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) Landscape(enabled bool) *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) Margins(top, right, bottom, left float64) *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) OmitBackground(enabled bool) *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) OutputFilename(filename string) *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) PageRanges(ranges string) *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) PaperSize(width, height float64) *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) PaperSizeA3() *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) PaperSizeA4() *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) PaperSizeA5() *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) PaperSizeLegal() *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) PaperSizeLetter() *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) PaperSizeTabloid() *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) PreferCSSPageSize(enabled bool) *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) PrintBackground(enabled bool) *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) Scale(scale float64) *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) SinglePage(enabled bool) *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) WebhookError(errorURL, errorMethod string) *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) WebhookExtraHeader(name, value string) *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) WebhookSuccess(url, method string) *HTMLConversionBuilder

+ func (hcb *HTMLConversionBuilder) WithFile(filename string, reader io.Reader) *HTMLConversionBuilder

+ type URLConversionBuilder struct

+ func (ucb *URLConversionBuilder) Execute(ctx context.Context, url string) (*http.Response, error)

+ func (ucb *URLConversionBuilder) GenerateDocumentOutline(enabled bool) *URLConversionBuilder

+ func (ucb *URLConversionBuilder) GenerateTaggedPDF(enabled bool) *URLConversionBuilder

+ func (ucb *URLConversionBuilder) Landscape(enabled bool) *URLConversionBuilder

+ func (ucb *URLConversionBuilder) Margins(top, right, bottom, left float64) *URLConversionBuilder

+ func (ucb *URLConversionBuilder) OmitBackground(enabled bool) *URLConversionBuilder

+ func (ucb *URLConversionBuilder) OutputFilename(filename string) *URLConversionBuilder

+ func (ucb *URLConversionBuilder) PageRanges(ranges string) *URLConversionBuilder

+ func (ucb *URLConversionBuilder) PaperSize(width, height float64) *URLConversionBuilder

+ func (ucb *URLConversionBuilder) PaperSizeA3() *URLConversionBuilder

+ func (ucb *URLConversionBuilder) PaperSizeA4() *URLConversionBuilder

+ func (ucb *URLConversionBuilder) PaperSizeA5() *URLConversionBuilder

+ func (ucb *URLConversionBuilder) PaperSizeLegal() *URLConversionBuilder

+ func (ucb *URLConversionBuilder) PaperSizeLetter() *URLConversionBuilder

+ func (ucb *URLConversionBuilder) PaperSizeTabloid() *URLConversionBuilder

+ func (ucb *URLConversionBuilder) PreferCSSPageSize(enabled bool) *URLConversionBuilder

+ func (ucb *URLConversionBuilder) PrintBackground(enabled bool) *URLConversionBuilder

+ func (ucb *URLConversionBuilder) Scale(scale float64) *URLConversionBuilder

+ func (ucb *URLConversionBuilder) SinglePage(enabled bool) *URLConversionBuilder

+ func (ucb *URLConversionBuilder) WebhookError(errorURL, errorMethod string) *URLConversionBuilder

+ func (ucb *URLConversionBuilder) WebhookExtraHeader(name, value string) *URLConversionBuilder

+ func (ucb *URLConversionBuilder) WebhookSuccess(url, method string) *URLConversionBuilder

Sep 26, 2025

Changes in this version

+ type OptionsBuilder struct

+ func NewOptionsBuilder() *OptionsBuilder

+ func (b *OptionsBuilder) Build() ClientOptions

+ func (b *OptionsBuilder) File(name string, r io.Reader) *OptionsBuilder

+ func (b *OptionsBuilder) Landscape(enabled bool) *OptionsBuilder

+ func (b *OptionsBuilder) Margins(top, right, bottom, left float64) *OptionsBuilder

+ func (b *OptionsBuilder) OutputFilename(filename string) *OptionsBuilder

+ func (b *OptionsBuilder) PaperSize(width, height float64) *OptionsBuilder

+ func (b *OptionsBuilder) PaperSizeA4() *OptionsBuilder

+ func (b *OptionsBuilder) PaperSizeLetter() *OptionsBuilder

+ func (b *OptionsBuilder) PrintBackground(enabled bool) *OptionsBuilder

+ func (b *OptionsBuilder) Scale(scale float64) *OptionsBuilder

+ func (b *OptionsBuilder) SinglePage(enabled bool) *OptionsBuilder

+ func (b *OptionsBuilder) WebhookError(errorURL, errorMethod string) *OptionsBuilder

+ func (b *OptionsBuilder) WebhookExtraHeader(name, value string) *OptionsBuilder

+ func (b *OptionsBuilder) WebhookSuccess(url, method string) *OptionsBuilder

Sep 26, 2025

Changes in this version

+ const FieldGenerateDocumentOutline

+ const FieldGenerateTaggedPDF

+ const FieldLandscape

+ const FieldMarginBottom

+ const FieldMarginLeft

+ const FieldMarginRight

+ const FieldMarginTop

+ const FieldNativePageRanges

+ const FieldOmitBackground

+ const FieldPaperHeight

+ const FieldPaperWidth

+ const FieldPreferCSSPageSize

+ const FieldPrintBackground

+ const FieldScale

+ const FieldSinglePage

+ const HeaderWebhookErrorMethod

+ const HeaderWebhookErrorURL

+ const HeaderWebhookExtraHTTPHeaders

+ const HeaderWebhookMethod

+ const HeaderWebhookURL

+ type ClientOptions func(*clientOptions)

Sep 26, 2025

Changes in this version

type ConvOption

+ func WithFile(name string, r io.Reader) ConvOption

+ func WithWebhookError(errorURL, errorMethod string) ConvOption

+ func WithWebhookExtraHeader(name, value string) ConvOption

+ func WithWebhookSuccess(url, method string) ConvOption

Sep 25, 2025

Changes in this version

+ type ConvOption func(*convConfig)

+ func WithHTMLAdditionalFiles(files map[string][]byte) ConvOption

+ func WithHTMLFooter(footerHTML []byte) ConvOption

+ func WithHTMLHeader(headerHTML []byte) ConvOption

+ func WithPaperSizeA4() ConvOption

+ func WithPaperSizeLetter() ConvOption

Sep 24, 2025

Changes in this version

+ var PaperSizeA0 = [2]float64

+ var PaperSizeA1 = [2]float64

+ var PaperSizeA2 = [2]float64

+ var PaperSizeA3 = [2]float64

+ var PaperSizeA4 = [2]float64

+ var PaperSizeA5 = [2]float64

+ var PaperSizeA6 = [2]float64

+ var PaperSizeLedger = [2]float64

+ var PaperSizeLegal = [2]float64

+ var PaperSizeLetter = [2]float64

+ var PaperSizeTabloid = [2]float64

+ func Bool(v bool) *bool

+ func Float64(v float64) *float64

+ func Int(v int) *int

+ func String(v string) *string

+ type Client struct

+ func NewClient(httpClient *http.Client, baseURL string) *Client

+ func (c *Client) ConvertHTMLToPDF(indexHTML []byte, opts ...HTMLToPDFOption) (*PDFResponse, error)

+ func (c *Client) ConvertMarkdownToPDF(indexHTML []byte, markdownFiles map[string][]byte, opts ...MarkdownToPDFOption) (*PDFResponse, error)

+ func (c *Client) ConvertURLToPDF(url string, opts ...URLToPDFOption) (*PDFResponse, error)

+ type GotenbergError struct

+ Message string

+ StatusCode int

+ Trace string

+ func (e *GotenbergError) Error() string

+ type HTMLToPDFOption func(*htmlToPDFConfig)

+ func A4HTML() HTMLToPDFOption

+ func LetterHTML() HTMLToPDFOption

+ func WithAdditionalFiles(files map[string][]byte) HTMLToPDFOption

+ func WithFooter(footerHTML []byte) HTMLToPDFOption

+ func WithHTMLLandscape(enabled bool) HTMLToPDFOption

+ func WithHTMLMargins(top, right, bottom, left float64) HTMLToPDFOption

+ func WithHTMLOutputFilename(filename string) HTMLToPDFOption

+ func WithHTMLPaperSize(width, height float64) HTMLToPDFOption

+ func WithHTMLPrintBackground(enabled bool) HTMLToPDFOption

+ func WithHTMLScale(scale float64) HTMLToPDFOption

+ func WithHTMLSinglePage(enabled bool) HTMLToPDFOption

+ func WithHTMLWebhook(url, errorURL string) HTMLToPDFOption

+ func WithHTMLWebhookExtraHeaders(headers map[string]string) HTMLToPDFOption

+ func WithHTMLWebhookMethods(method, errorMethod string) HTMLToPDFOption

+ func WithHeader(headerHTML []byte) HTMLToPDFOption

+ type MarkdownToPDFOption func(*markdownToPDFConfig)

+ func A4Markdown() MarkdownToPDFOption

+ func LetterMarkdown() MarkdownToPDFOption

+ func WithMarkdownAdditionalFiles(files map[string][]byte) MarkdownToPDFOption

+ func WithMarkdownFooter(footerHTML []byte) MarkdownToPDFOption

+ func WithMarkdownHeader(headerHTML []byte) MarkdownToPDFOption

+ func WithMarkdownLandscape(enabled bool) MarkdownToPDFOption

+ func WithMarkdownMargins(top, right, bottom, left float64) MarkdownToPDFOption

+ func WithMarkdownOutputFilename(filename string) MarkdownToPDFOption

+ func WithMarkdownPaperSize(width, height float64) MarkdownToPDFOption

+ func WithMarkdownPrintBackground(enabled bool) MarkdownToPDFOption

+ func WithMarkdownScale(scale float64) MarkdownToPDFOption

+ func WithMarkdownSinglePage(enabled bool) MarkdownToPDFOption

+ func WithMarkdownWebhook(url, errorURL string) MarkdownToPDFOption

+ func WithMarkdownWebhookExtraHeaders(headers map[string]string) MarkdownToPDFOption

+ func WithMarkdownWebhookMethods(method, errorMethod string) MarkdownToPDFOption

+ type PDFResponse struct

+ ContentDisposition string

+ ContentLength int64

+ ContentType string

+ PDF []byte

+ Trace string

+ type URLToPDFOption func(*urlToPDFConfig)

+ func A4() URLToPDFOption

+ func Letter() URLToPDFOption

+ func WithLandscape(enabled bool) URLToPDFOption

+ func WithMargins(top, right, bottom, left float64) URLToPDFOption

+ func WithOutputFilename(filename string) URLToPDFOption

+ func WithPaperSize(width, height float64) URLToPDFOption

+ func WithPrintBackground(enabled bool) URLToPDFOption

+ func WithScale(scale float64) URLToPDFOption

+ func WithSinglePage(enabled bool) URLToPDFOption

+ func WithWebhook(url, errorURL string) URLToPDFOption

+ func WithWebhookExtraHeaders(headers map[string]string) URLToPDFOption

+ func WithWebhookMethods(method, errorMethod string) URLToPDFOption