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

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

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

Defines the request schema for `/sandbox/transfer/refund/simulate`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_CLIENT_ID`
`static String`	`SERIALIZED_NAME_EVENT_TYPE`
`static String`	`SERIALIZED_NAME_FAILURE_REASON`
`static String`	`SERIALIZED_NAME_REFUND_ID`
`static String`	`SERIALIZED_NAME_SECRET`
`static String`	`SERIALIZED_NAME_TEST_CLOCK_ID`

Constructor Summary

Constructors
Constructor and Description

SandboxTransferRefundSimulateRequest()

Constructors
Constructor and Description
`SandboxTransferRefundSimulateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SandboxTransferRefundSimulateRequest`	`clientId(String clientId)`
`boolean`	`equals(Object o)`
`SandboxTransferRefundSimulateRequest`	`eventType(String eventType)`
`SandboxTransferRefundSimulateRequest`	`failureReason(TransferFailure failureReason)`
`String`	`getClientId()` Your Plaid API `client_id`.
`String`	`getEventType()` The asynchronous event to be simulated.
`TransferFailure`	`getFailureReason()` Get failureReason
`String`	`getRefundId()` Plaid’s unique identifier for a refund.
`String`	`getSecret()` Your Plaid API `secret`.
`String`	`getTestClockId()` Plaid’s unique identifier for a test clock.
`int`	`hashCode()`
`SandboxTransferRefundSimulateRequest`	`refundId(String refundId)`
`SandboxTransferRefundSimulateRequest`	`secret(String secret)`
`void`	`setClientId(String clientId)`
`void`	`setEventType(String eventType)`
`void`	`setFailureReason(TransferFailure failureReason)`
`void`	`setRefundId(String refundId)`
`void`	`setSecret(String secret)`
`void`	`setTestClockId(String testClockId)`
`SandboxTransferRefundSimulateRequest`	`testClockId(String testClockId)`
`String`	`toString()`

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_REFUND_ID
```
public static final String SERIALIZED_NAME_REFUND_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TEST_CLOCK_ID
```
public static final String SERIALIZED_NAME_TEST_CLOCK_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EVENT_TYPE
```
public static final String SERIALIZED_NAME_EVENT_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FAILURE_REASON
```
public static final String SERIALIZED_NAME_FAILURE_REASON
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SandboxTransferRefundSimulateRequest
```
public SandboxTransferRefundSimulateRequest()
```
- Method Detail
  - clientId
```
public SandboxTransferRefundSimulateRequest 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 SandboxTransferRefundSimulateRequest 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)
```
  - refundId
```
public SandboxTransferRefundSimulateRequest refundId(String refundId)
```
  - getRefundId
```
public String getRefundId()
```
    Plaid’s unique identifier for a refund.
    
    Returns:
    
    refundId
  - setRefundId
```
public void setRefundId(String refundId)
```
  - testClockId
```
public SandboxTransferRefundSimulateRequest testClockId(String testClockId)
```
  - getTestClockId
```
@Nullable
public String getTestClockId()
```
    Plaid’s unique identifier for a test clock. If provided, the event to be simulated is created at the `virtual_time` on the provided `test_clock`.
    
    Returns:
    
    testClockId
  - setTestClockId
```
public void setTestClockId(String testClockId)
```
  - eventType
```
public SandboxTransferRefundSimulateRequest eventType(String eventType)
```
  - getEventType
```
public String getEventType()
```
    The asynchronous event to be simulated. May be: `refund.posted`, `refund.settled`, `refund.failed`, or `refund.returned`. An error will be returned if the event type is incompatible with the current refund status. Compatible status --> event type transitions include: `refund.pending` --> `refund.failed` `refund.pending` --> `refund.posted` `refund.posted` --> `refund.returned` `refund.posted` --> `refund.settled`
    
    Returns:
    
    eventType
  - setEventType
```
public void setEventType(String eventType)
```
  - failureReason
```
public SandboxTransferRefundSimulateRequest failureReason(TransferFailure failureReason)
```
  - getFailureReason
```
@Nullable
public TransferFailure getFailureReason()
```
    Get failureReason
    
    Returns:
    
    failureReason
  - setFailureReason
```
public void setFailureReason(TransferFailure failureReason)
```
  - 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 SandboxTransferRefundSimulateRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CLIENT_ID

SERIALIZED_NAME_SECRET

SERIALIZED_NAME_REFUND_ID

SERIALIZED_NAME_TEST_CLOCK_ID

SERIALIZED_NAME_EVENT_TYPE

SERIALIZED_NAME_FAILURE_REASON

Constructor Detail

SandboxTransferRefundSimulateRequest

Method Detail

clientId

getClientId

setClientId

secret

getSecret

setSecret

refundId

getRefundId

setRefundId

testClockId

getTestClockId

setTestClockId

eventType

getEventType

setEventType

failureReason

getFailureReason

setFailureReason

equals

hashCode

toString