Constructor Detail

Method Detail

• body

   final ConnectSessionNewParams.Builder body(ConnectSessionNewParams.CreateConnectSessionRequest 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:

  • customerId

  • customerName

  • products

  • customerEmail

  • integration

  • etc.

• customerId

   final ConnectSessionNewParams.Builder customerId(String customerId)

  Unique identifier for the customer

• customerId

   final ConnectSessionNewParams.Builder customerId(JsonField<String> customerId)

  Sets Builder.customerId to an arbitrary JSON value.

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

• customerName

   final ConnectSessionNewParams.Builder customerName(String customerName)

  Name of the customer

• customerName

   final ConnectSessionNewParams.Builder customerName(JsonField<String> customerName)

  Sets Builder.customerName to an arbitrary JSON value.

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

• products

   final ConnectSessionNewParams.Builder products(List<ConnectSessionNewParams.ConnectProducts> products)

  The Finch products to request access to. Use benefits to access deductions endpoints — deduction is a deprecated alias that is still accepted but should not be combined with benefits.

• products

   final ConnectSessionNewParams.Builder products(JsonField<List<ConnectSessionNewParams.ConnectProducts>> products)

  Sets Builder.products to an arbitrary JSON value.

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

• addProduct

   final ConnectSessionNewParams.Builder addProduct(ConnectSessionNewParams.ConnectProducts product)

  Adds a single ConnectProducts to products.

• customerEmail

   final ConnectSessionNewParams.Builder customerEmail(String customerEmail)

  Email address of the customer

• customerEmail

   final ConnectSessionNewParams.Builder customerEmail(Optional<String> customerEmail)

  Alias for calling Builder.customerEmail with customerEmail.orElse(null).

• customerEmail

   final ConnectSessionNewParams.Builder customerEmail(JsonField<String> customerEmail)

  Sets Builder.customerEmail to an arbitrary JSON value.

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

• integration

   final ConnectSessionNewParams.Builder integration(ConnectSessionNewParams.Integration integration)

  Integration configuration for the connect session

• integration

   final ConnectSessionNewParams.Builder integration(Optional<ConnectSessionNewParams.Integration> integration)

  Alias for calling Builder.integration with integration.orElse(null).

• integration

   final ConnectSessionNewParams.Builder integration(JsonField<ConnectSessionNewParams.Integration> integration)

  Sets Builder.integration to an arbitrary JSON value.

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

• manual

   final ConnectSessionNewParams.Builder manual(Boolean manual)

  Enable manual authentication mode

• manual

   final ConnectSessionNewParams.Builder manual(Boolean manual)

  Alias for Builder.manual.

  This unboxed primitive overload exists for backwards compatibility.

• manual

   final ConnectSessionNewParams.Builder manual(Optional<Boolean> manual)

  Alias for calling Builder.manual with manual.orElse(null).

• manual

   final ConnectSessionNewParams.Builder manual(JsonField<Boolean> manual)

  Sets Builder.manual to an arbitrary JSON value.

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

• minutesToExpire

   final ConnectSessionNewParams.Builder minutesToExpire(Double minutesToExpire)

  The number of minutes until the session expires (defaults to 129,600, which is 90 days)

• minutesToExpire

   final ConnectSessionNewParams.Builder minutesToExpire(Double minutesToExpire)

  Alias for Builder.minutesToExpire.

  This unboxed primitive overload exists for backwards compatibility.

• minutesToExpire

   final ConnectSessionNewParams.Builder minutesToExpire(Optional<Double> minutesToExpire)

  Alias for calling Builder.minutesToExpire with minutesToExpire.orElse(null).

• minutesToExpire

   final ConnectSessionNewParams.Builder minutesToExpire(JsonField<Double> minutesToExpire)

  Sets Builder.minutesToExpire to an arbitrary JSON value.

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

• redirectUri

   final ConnectSessionNewParams.Builder redirectUri(String redirectUri)

  The URI to redirect to after the Connect flow is completed

• redirectUri

   final ConnectSessionNewParams.Builder redirectUri(Optional<String> redirectUri)

  Alias for calling Builder.redirectUri with redirectUri.orElse(null).

• redirectUri

   final ConnectSessionNewParams.Builder redirectUri(JsonField<String> redirectUri)

  Sets Builder.redirectUri to an arbitrary JSON value.

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

• sandbox

   final ConnectSessionNewParams.Builder sandbox(ConnectSessionNewParams.Sandbox sandbox)

  Sandbox mode for testing

• sandbox

   final ConnectSessionNewParams.Builder sandbox(Optional<ConnectSessionNewParams.Sandbox> sandbox)

  Alias for calling Builder.sandbox with sandbox.orElse(null).

• sandbox

   final ConnectSessionNewParams.Builder sandbox(JsonField<ConnectSessionNewParams.Sandbox> sandbox)

  Sets Builder.sandbox to an arbitrary JSON value.

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

• additionalBodyProperties

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

• putAdditionalBodyProperty

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

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

   final ConnectSessionNewParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

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

• additionalHeaders

   final ConnectSessionNewParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final ConnectSessionNewParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final ConnectSessionNewParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final ConnectSessionNewParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final ConnectSessionNewParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final ConnectSessionNewParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final ConnectSessionNewParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final ConnectSessionNewParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final ConnectSessionNewParams build()

  Returns an immutable instance of ConnectSessionNewParams.

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

  The following fields are required:

  .customerId()
  .customerName()
  .products()