# `PDFShift.Types`
[🔗](https://github.com/sgerrand/ex_pdf_shift/blob/v0.2.1/lib/pdf_shift/types.ex#L1)

Type definitions for the PDFShift API.

# `auth`

```elixir
@type auth() :: %{username: String.t(), password: String.t()}
```

Authentication settings for password-protected content.

# `convert_options`

```elixir
@type convert_options() :: %{
  optional(:sandbox) => boolean(),
  optional(:encode) => boolean(),
  optional(:filename) => String.t(),
  optional(:webhook) => String.t(),
  optional(:s3_destination) => String.t(),
  optional(:timeout) => integer(),
  optional(:wait_for) => String.t(),
  optional(:landscape) => boolean(),
  optional(:lazy_load_images) => boolean(),
  optional(:css) => String.t(),
  optional(:javascript) => String.t(),
  optional(:disable_javascript) => boolean(),
  optional(:disable_backgrounds) => boolean(),
  optional(:remove_blank) => boolean(),
  optional(:delay) => integer(),
  optional(:raise_for_status) => boolean(),
  optional(:use_print) => boolean(),
  optional(:format) => String.t(),
  optional(:pages) => String.t(),
  optional(:zoom) => number(),
  optional(:is_gdpr) => boolean(),
  optional(:is_hipaa) => boolean(),
  optional(:margin) => margin(),
  optional(:auth) => auth(),
  optional(:cookies) => [cookie()],
  optional(:http_headers) => http_headers(),
  optional(:header) => header(),
  optional(:footer) => footer(),
  optional(:protection) => protection(),
  optional(:watermark) => watermark()
}
```

Request options for converting HTML/URL to PDF.

# `cookie`

```elixir
@type cookie() :: %{
  :name => String.t(),
  :value => String.t(),
  optional(:secure) => boolean(),
  optional(:http_only) => boolean()
}
```

Cookie settings for requests when loading the source.

# `credits_response`

```elixir
@type credits_response() :: %{
  credits: %{
    base: integer(),
    remaining: integer(),
    total: integer(),
    used: integer()
  },
  success: boolean()
}
```

Credits usage response.

# `error_response`

```elixir
@type error_response() :: %{
  success: boolean(),
  error: String.t(),
  errors: map(),
  code: integer()
}
```

Error response.

# `footer`

```elixir
@type footer() :: %{:source => String.t(), optional(:height) => String.t()}
```

Footer settings for the generated PDF.

# `header`

```elixir
@type header() :: %{:source => String.t(), optional(:height) => String.t()}
```

Header settings for the generated PDF.

# `http_headers`

```elixir
@type http_headers() :: %{required(String.t()) => String.t()}
```

HTTP headers for requests when loading the source.

# `margin`

```elixir
@type margin() :: %{
  optional(:top) => String.t(),
  optional(:right) => String.t(),
  optional(:bottom) => String.t(),
  optional(:left) => String.t()
}
```

Margin settings for the generated PDF.

# `pdf_response_headers`

```elixir
@type pdf_response_headers() :: %{
  optional(:"x-pdfshift-processorx") => String.t(),
  optional(:"x-process-time") => integer(),
  optional(:"x-response-duration") => integer(),
  optional(:"x-response-status-code") => String.t(),
  optional(:"x-credits-used") => integer(),
  optional(:"x-credits-remaining") => String.t(),
  optional(:"x-request-id") => String.t()
}
```

Response headers from the PDF conversion.

# `protection`

```elixir
@type protection() :: %{
  :owner_password => String.t(),
  :user_password => String.t(),
  optional(:author) => String.t(),
  optional(:no_copy) => boolean(),
  optional(:no_modify) => boolean(),
  optional(:no_print) => boolean()
}
```

Protection settings for the generated PDF.

# `watermark`

```elixir
@type watermark() :: %{
  optional(:image) => String.t(),
  optional(:text) => String.t(),
  optional(:font_size) => integer(),
  optional(:font_family) => String.t(),
  optional(:font_color) => String.t(),
  optional(:font_opacity) => integer(),
  optional(:font_bold) => boolean(),
  optional(:font_italic) => boolean(),
  optional(:rotate) => integer()
}
```

Watermark settings for the generated PDF.

---

*Consult [api-reference.md](api-reference.md) for complete listing*