com.plaid.client.model

Class AssetReportGetRequest

java.lang.Object

com.plaid.client.model.AssetReportGetRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class AssetReportGetRequest
extends Object

AssetReportGetRequest defines the request schema for `/asset_report/get`

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ASSET_REPORT_TOKEN
static String	SERIALIZED_NAME_CLIENT_ID
static String	SERIALIZED_NAME_FAST_REPORT
static String	SERIALIZED_NAME_INCLUDE_INSIGHTS
static String	SERIALIZED_NAME_OPTIONS
static String	SERIALIZED_NAME_SECRET
static String	SERIALIZED_NAME_USER_TOKEN

Constructor Summary

Constructors

Constructor and Description
AssetReportGetRequest()

Method Summary

Modifier and Type	Method and Description
AssetReportGetRequest	assetReportToken(String assetReportToken)
AssetReportGetRequest	clientId(String clientId)
boolean	equals(Object o)
AssetReportGetRequest	fastReport(Boolean fastReport)
String	getAssetReportToken() A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report.
String	getClientId() Your Plaid API `client_id`.
Boolean	getFastReport() `true` to fetch \"fast\" version of asset report.
Boolean	getIncludeInsights() `true` if you would like to retrieve the Asset Report with Insights, `false` otherwise.
AssetReportGetRequestOptions	getOptions() Get options
String	getSecret() Your Plaid API `secret`.
String	getUserToken() The user token associated with the User for which to create an asset report for.
int	hashCode()
AssetReportGetRequest	includeInsights(Boolean includeInsights)
AssetReportGetRequest	options(AssetReportGetRequestOptions options)
AssetReportGetRequest	secret(String secret)
void	setAssetReportToken(String assetReportToken)
void	setClientId(String clientId)
void	setFastReport(Boolean fastReport)
void	setIncludeInsights(Boolean includeInsights)
void	setOptions(AssetReportGetRequestOptions options)
void	setSecret(String secret)
void	setUserToken(String userToken)
String	toString()
AssetReportGetRequest	userToken(String userToken)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_CLIENT_ID

public static final String SERIALIZED_NAME_CLIENT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_SECRET

public static final String SERIALIZED_NAME_SECRET

See Also:

Constant Field Values

SERIALIZED_NAME_ASSET_REPORT_TOKEN

public static final String SERIALIZED_NAME_ASSET_REPORT_TOKEN

See Also:

Constant Field Values

SERIALIZED_NAME_USER_TOKEN

public static final String SERIALIZED_NAME_USER_TOKEN

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_INSIGHTS

public static final String SERIALIZED_NAME_INCLUDE_INSIGHTS

See Also:

Constant Field Values

SERIALIZED_NAME_FAST_REPORT

public static final String SERIALIZED_NAME_FAST_REPORT

See Also:

Constant Field Values

SERIALIZED_NAME_OPTIONS

public static final String SERIALIZED_NAME_OPTIONS

See Also:

Constant Field Values

Constructor Detail

AssetReportGetRequest

public AssetReportGetRequest()

Method Detail

clientId

public AssetReportGetRequest clientId(String clientId)

getClientId

@Nullable
public String getClientId()

Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.

Returns:

clientId

setClientId

public void setClientId(String clientId)

secret

public AssetReportGetRequest secret(String secret)

getSecret

@Nullable
public String getSecret()

Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

Returns:

secret

setSecret

public void setSecret(String secret)

assetReportToken

public AssetReportGetRequest assetReportToken(String assetReportToken)

getAssetReportToken

@Nullable
public String getAssetReportToken()

A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report.

Returns:

assetReportToken

setAssetReportToken

public void setAssetReportToken(String assetReportToken)

userToken

public AssetReportGetRequest userToken(String userToken)

getUserToken

@Nullable
public String getUserToken()

The user token associated with the User for which to create an asset report for. The latest asset report associated with the User will be returned

Returns:

userToken

setUserToken

public void setUserToken(String userToken)

includeInsights

public AssetReportGetRequest includeInsights(Boolean includeInsights)

getIncludeInsights

@Nullable
public Boolean getIncludeInsights()

`true` if you would like to retrieve the Asset Report with Insights, `false` otherwise. This field defaults to `false` if omitted.

Returns:

includeInsights

setIncludeInsights

public void setIncludeInsights(Boolean includeInsights)

fastReport

public AssetReportGetRequest fastReport(Boolean fastReport)

getFastReport

@Nullable
public Boolean getFastReport()

`true` to fetch \"fast\" version of asset report. Defaults to false if omitted. Can only be used if `/asset_report/create` was called with `options.add_ons` set to `[\"fast_assets\"]`.

Returns:

fastReport

setFastReport

public void setFastReport(Boolean fastReport)

options

public AssetReportGetRequest options(AssetReportGetRequestOptions options)

getOptions

@Nullable
public AssetReportGetRequestOptions getOptions()

Get options

Returns:

options

setOptions

public void setOptions(AssetReportGetRequestOptions options)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object