Class DocumentsAggregateAPI

Documents aggregate API.

Note that only "allUniqueValues" requires pagination, and we therefore configure the BaseResourceAPI to work for only that feature.

Hierarchy

BaseResourceAPI<unknown>
- DocumentsAggregateAPI

Index

Methods

Methods

allUniqueProperties

allUniqueProperties(request: Omit<DocumentsAggregateAllUniquePropertiesRequest, "aggregate">): DocumentsAggregateAllUniquePropertiesResponse

- Defined in packages/stable/src/api/documents/aggregateApi.ts:72
Parameters
- request: Omit<DocumentsAggregateAllUniquePropertiesRequest, "aggregate">
Returns DocumentsAggregateAllUniquePropertiesResponse

allUniqueValues

allUniqueValues(request: Omit<DocumentsAggregateAllUniqueValuesRequest, "aggregate">): DocumentsAggregateAllUniqueValuesResponse

- Defined in packages/stable/src/api/documents/aggregateApi.ts:51
Parameters
- request: Omit<DocumentsAggregateAllUniqueValuesRequest, "aggregate">
Returns DocumentsAggregateAllUniqueValuesResponse

count

count(request: Omit<DocumentsAggregateCountRequest, "aggregate">): Promise<number>

- Defined in packages/stable/src/api/documents/aggregateApi.ts:33
Parameters
- request: Omit<DocumentsAggregateCountRequest, "aggregate">
Returns Promise<number>

uniqueProperties

uniqueProperties(request: Omit<DocumentsAggregateUniquePropertiesRequest, "aggregate">): Promise<DocumentsAggregateUniquePropertiesItem[]>

- Defined in packages/stable/src/api/documents/aggregateApi.ts:63
Parameters
- request: Omit<DocumentsAggregateUniquePropertiesRequest, "aggregate">
Returns Promise<DocumentsAggregateUniquePropertiesItem[]>

uniqueValues

uniqueValues(request: Omit<DocumentsAggregateUniqueValuesRequest, "aggregate">): Promise<DocumentsAggregateUniqueValuesItem[]>

- Defined in packages/stable/src/api/documents/aggregateApi.ts:42
Parameters
- request: Omit<DocumentsAggregateUniqueValuesRequest, "aggregate">
Returns Promise<DocumentsAggregateUniqueValuesItem[]>