All Implemented Interfaces:

com.tryfinch.api.core.Params
```
public final class HrisDocumentListParams
 implements Params
                    
```
Beta: This endpoint is in beta and may change. Retrieve a list of company-wide documents.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`HrisDocumentListParams.Builder`	A builder for HrisDocumentListParams.
`public final class`	`HrisDocumentListParams.Type`

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<List<String>>`	`entityIds()`	The entity IDs to specify which entities' data to access.
`final Optional<List<String>>`	`individualIds()`	Comma-delimited list of stable Finch uuids for each individual.
`final Optional<Long>`	`limit()`	Number of documents to return (defaults to all)
`final Optional<Long>`	`offset()`	Index to start from (defaults to 0)
`final Optional<List<HrisDocumentListParams.Type>>`	`types()`	Comma-delimited list of document types to filter on.
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final HrisDocumentListParams.Builder`	`toBuilder()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static HrisDocumentListParams`	`none()`
`final static HrisDocumentListParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of HrisDocumentListParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - entityIds
```
 final Optional<List<String>> entityIds()
```
    The entity IDs to specify which entities' data to access.
  - individualIds
```
 final Optional<List<String>> individualIds()
```
    Comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals
  - limit
```
 final Optional<Long> limit()
```
    Number of documents to return (defaults to all)
  - offset
```
 final Optional<Long> offset()
```
    Index to start from (defaults to 0)
  - types
```
 final Optional<List<HrisDocumentListParams.Type>> types()
```
    Comma-delimited list of document types to filter on. If empty, defaults to all types
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final HrisDocumentListParams.Builder toBuilder()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - none
```
 final static HrisDocumentListParams none()
```
  - builder
```
 final static HrisDocumentListParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of HrisDocumentListParams.

Class HrisDocumentListParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

entityIds

individualIds

limit

offset

types

_additionalHeaders

_additionalQueryParams

toBuilder

_headers

_queryParams

equals

hashCode

toString

none

builder