nylas/com.nylas.models/ListGrantsQueryParams

ListGrantsQueryParams

public final class ListGrantsQueryParams implements IQueryParams

Class representation of the query parameters for listing grants.

Constructors

ListGrantsQueryParams

public ListGrantsQueryParams ListGrantsQueryParams(@Json(name = "limit") Integer limit, @Json(name = "offset") Integer offset, @Json(name = "sort_by") SortBy sortBy, @Json(name = "order_by") OrderBy orderBy, @Json(name = "since") Integer since, @Json(name = "before") Integer before, @Json(name = "email") String email, @Json(name = "grant_status") String grantStatus, @Json(name = "ip") String ip, @Json(name = "provider") AuthProvider provider)

Types

public final class Builder

Builder for ListGrantsQueryParams.

Properties

private final Integer before

Scope grants to a specific point in time by Unix timestamp.

private final String email

Filtering your query based on grant email address (if applicable)

private final String grantStatus

Filtering your query based on grant email status (if applicable)

private final String ip

Filtering your query based on grant IP address

private final Integer limit

The maximum number of objects to return. This field defaults to 10. The maximum allowed value is 200.

private final Integer offset

Offset grant results by this number.

private final OrderBy orderBy

Specify ascending or descending order.

private final AuthProvider provider

Filtering your query based on OAuth provider

private final Integer since

Scope grants from a specific point in time by Unix timestamp.

private final SortBy sortBy

Sort entries by field name

Functions

public Map<String, Object> convertToMap()

Convert the query parameters to a json-formatted map.

public final Integer getBefore()

Scope grants to a specific point in time by Unix timestamp.

public final String getEmail()

Filtering your query based on grant email address (if applicable)

public final String getGrantStatus()

Filtering your query based on grant email status (if applicable)

public final String getIp()

Filtering your query based on grant IP address

public final Integer getLimit()

The maximum number of objects to return. This field defaults to 10. The maximum allowed value is 200.

public final Integer getOffset()

Offset grant results by this number.

public final OrderBy getOrderBy()

Specify ascending or descending order.

public final AuthProvider getProvider()

Filtering your query based on OAuth provider

public final Integer getSince()

Scope grants from a specific point in time by Unix timestamp.

public final SortBy getSortBy()

Sort entries by field name