CreditRelayCreateRequest (com.plaid:plaid-java 18.0.0 API)

java.lang.Object
- com.plaid.client.model.CreditRelayCreateRequest

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

CreditRelayCreateRequest defines the request schema for `/credit/relay/create`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_CLIENT_ID`
`static String`	`SERIALIZED_NAME_REPORT_TOKENS`
`static String`	`SERIALIZED_NAME_SECONDARY_CLIENT_ID`
`static String`	`SERIALIZED_NAME_SECRET`
`static String`	`SERIALIZED_NAME_WEBHOOK`

Constructor Summary

Constructors
Constructor and Description

CreditRelayCreateRequest()

Constructors
Constructor and Description
`CreditRelayCreateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreditRelayCreateRequest`	`addReportTokensItem(String reportTokensItem)`
`CreditRelayCreateRequest`	`clientId(String clientId)`
`boolean`	`equals(Object o)`
`String`	`getClientId()` Your Plaid API `client_id`.
`List<String>`	`getReportTokens()` List of report token strings, with at most one token of each report type.
`String`	`getSecondaryClientId()` The `secondary_client_id` is the client id of the third party with whom you would like to share the relay token.
`String`	`getSecret()` Your Plaid API `secret`.
`String`	`getWebhook()` URL to which Plaid will send webhooks when the Secondary Client successfully retrieves an Asset Report by calling `/credit/relay/get`.
`int`	`hashCode()`
`CreditRelayCreateRequest`	`reportTokens(List<String> reportTokens)`
`CreditRelayCreateRequest`	`secondaryClientId(String secondaryClientId)`
`CreditRelayCreateRequest`	`secret(String secret)`
`void`	`setClientId(String clientId)`
`void`	`setReportTokens(List<String> reportTokens)`
`void`	`setSecondaryClientId(String secondaryClientId)`
`void`	`setSecret(String secret)`
`void`	`setWebhook(String webhook)`
`String`	`toString()`
`CreditRelayCreateRequest`	`webhook(String webhook)`

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_REPORT_TOKENS
```
public static final String SERIALIZED_NAME_REPORT_TOKENS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SECONDARY_CLIENT_ID
```
public static final String SERIALIZED_NAME_SECONDARY_CLIENT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_WEBHOOK
```
public static final String SERIALIZED_NAME_WEBHOOK
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CreditRelayCreateRequest
```
public CreditRelayCreateRequest()
```
- Method Detail
  - clientId
```
public CreditRelayCreateRequest 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 CreditRelayCreateRequest 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)
```
  - reportTokens
```
public CreditRelayCreateRequest reportTokens(List<String> reportTokens)
```
  - addReportTokensItem
```
public CreditRelayCreateRequest addReportTokensItem(String reportTokensItem)
```
  - getReportTokens
```
public List<String> getReportTokens()
```
    List of report token strings, with at most one token of each report type. Currently only Asset Report token is supported.
    
    Returns:
    
    reportTokens
  - setReportTokens
```
public void setReportTokens(List<String> reportTokens)
```
  - secondaryClientId
```
public CreditRelayCreateRequest secondaryClientId(String secondaryClientId)
```
  - getSecondaryClientId
```
public String getSecondaryClientId()
```
    The `secondary_client_id` is the client id of the third party with whom you would like to share the relay token.
    
    Returns:
    
    secondaryClientId
  - setSecondaryClientId
```
public void setSecondaryClientId(String secondaryClientId)
```
  - webhook
```
public CreditRelayCreateRequest webhook(String webhook)
```
  - getWebhook
```
@Nullable
public String getWebhook()
```
    URL to which Plaid will send webhooks when the Secondary Client successfully retrieves an Asset Report by calling `/credit/relay/get`.
    
    Returns:
    
    webhook
  - setWebhook
```
public void setWebhook(String webhook)
```
  - 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

Class CreditRelayCreateRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CLIENT_ID

SERIALIZED_NAME_SECRET

SERIALIZED_NAME_REPORT_TOKENS

SERIALIZED_NAME_SECONDARY_CLIENT_ID

SERIALIZED_NAME_WEBHOOK

Constructor Detail

CreditRelayCreateRequest

Method Detail

clientId

getClientId

setClientId

secret

getSecret

setSecret

reportTokens

addReportTokensItem

getReportTokens

setReportTokens

secondaryClientId

getSecondaryClientId

setSecondaryClientId

webhook

getWebhook

setWebhook

equals

hashCode

toString