Constructor Detail

Method Detail

• body

   final EntityOnboardingSessionCreateParams.Builder body(EntityOnboardingSessionCreateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • programId

  • redirectUrl

  • entityId

• programId

   final EntityOnboardingSessionCreateParams.Builder programId(String programId)

  The identifier of the Program the Entity will be onboarded to.

• programId

   final EntityOnboardingSessionCreateParams.Builder programId(JsonField<String> programId)

  Sets Builder.programId to an arbitrary JSON value.

  You should usually call Builder.programId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• redirectUrl

   final EntityOnboardingSessionCreateParams.Builder redirectUrl(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.

• redirectUrl

   final EntityOnboardingSessionCreateParams.Builder redirectUrl(JsonField<String> redirectUrl)

  Sets Builder.redirectUrl to an arbitrary JSON value.

  You should usually call Builder.redirectUrl with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• entityId

   final EntityOnboardingSessionCreateParams.Builder entityId(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.

• entityId

   final EntityOnboardingSessionCreateParams.Builder entityId(JsonField<String> entityId)

  Sets Builder.entityId to an arbitrary JSON value.

  You should usually call Builder.entityId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final EntityOnboardingSessionCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final EntityOnboardingSessionCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final EntityOnboardingSessionCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final EntityOnboardingSessionCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final EntityOnboardingSessionCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final EntityOnboardingSessionCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final EntityOnboardingSessionCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final EntityOnboardingSessionCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final EntityOnboardingSessionCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final EntityOnboardingSessionCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final EntityOnboardingSessionCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final EntityOnboardingSessionCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final EntityOnboardingSessionCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final EntityOnboardingSessionCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final EntityOnboardingSessionCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final EntityOnboardingSessionCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final EntityOnboardingSessionCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final EntityOnboardingSessionCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final EntityOnboardingSessionCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final EntityOnboardingSessionCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final EntityOnboardingSessionCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final EntityOnboardingSessionCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final EntityOnboardingSessionCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final EntityOnboardingSessionCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final EntityOnboardingSessionCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final EntityOnboardingSessionCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final EntityOnboardingSessionCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final EntityOnboardingSessionCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final EntityOnboardingSessionCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final EntityOnboardingSessionCreateParams build()

  Returns an immutable instance of EntityOnboardingSessionCreateParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .programId()
  .redirectUrl()