All Implemented Interfaces:: com.increase.api.core.Params


public final class EntityOnboardingSessionCreateParams
 implements Params

Create an Entity Onboarding Session

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`EntityOnboardingSessionCreateParams.Builder`	A builder for EntityOnboardingSessionCreateParams.
`public final class`	`EntityOnboardingSessionCreateParams.Body`

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`programId()`	The identifier of the Program the Entity will be onboarded to.
`final String`	`redirectUrl()`	The URL to redirect the customer to after they complete the onboarding form.
`final Optional<String>`	`entityId()`	The identifier of an existing Entity to associate with the onboarding session.
`final JsonField<String>`	`_programId()`	Returns the raw JSON value of programId.
`final JsonField<String>`	`_redirectUrl()`	Returns the raw JSON value of redirectUrl.
`final JsonField<String>`	`_entityId()`	Returns the raw JSON value of entityId.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final EntityOnboardingSessionCreateParams.Builder`	`toBuilder()`
`final EntityOnboardingSessionCreateParams.Body`	`_body()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static EntityOnboardingSessionCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of EntityOnboardingSessionCreateParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - programId
```
 final String programId()
```
    The identifier of the Program the Entity will be onboarded to.
  - redirectUrl
```
 final String redirectUrl()
```
    The URL to redirect the customer to after they complete the onboarding form. The redirect will include entity_onboarding_session_id and entity_id query parameters.
  - entityId
```
 final Optional<String> entityId()
```
    The identifier of an existing Entity to associate with the onboarding session. If provided, the onboarding form will display any outstanding tasks required to complete the Entity's onboarding.
  - _programId
```
 final JsonField<String> _programId()
```
    Returns the raw JSON value of programId.
    Unlike programId, this method doesn't throw if the JSON field has an unexpected type.
  - _redirectUrl
```
 final JsonField<String> _redirectUrl()
```
    Returns the raw JSON value of redirectUrl.
    Unlike redirectUrl, this method doesn't throw if the JSON field has an unexpected type.
  - _entityId
```
 final JsonField<String> _entityId()
```
    Returns the raw JSON value of entityId.
    Unlike entityId, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final EntityOnboardingSessionCreateParams.Builder toBuilder()
```
  - _body
```
 final EntityOnboardingSessionCreateParams.Body _body()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static EntityOnboardingSessionCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of EntityOnboardingSessionCreateParams.
    The following fields are required:
    .programId() .redirectUrl()

Class EntityOnboardingSessionCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

programId

redirectUrl

entityId

_programId

_redirectUrl

_entityId

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder