Package com.merge.api.resources.hris.linktoken.requests

Class EndUserDetailsRequest.Builder

java.lang.Object

com.merge.api.resources.hris.linktoken.requests.EndUserDetailsRequest.Builder

All Implemented Interfaces:

EndUserDetailsRequest._FinalStage, EndUserDetailsRequest.EndUserEmailAddressStage, EndUserDetailsRequest.EndUserOrganizationNameStage, EndUserDetailsRequest.EndUserOriginIdStage

Enclosing class:

EndUserDetailsRequest

public static final class EndUserDetailsRequest.Builder
extends java.lang.Object
implements EndUserDetailsRequest.EndUserEmailAddressStage, EndUserDetailsRequest.EndUserOrganizationNameStage, EndUserDetailsRequest.EndUserOriginIdStage, EndUserDetailsRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
EndUserDetailsRequest._FinalStage	addAllCategories(java.util.List<CategoriesEnum> categories)	The integration categories to show in Merge Link.
EndUserDetailsRequest._FinalStage	addCategories(CategoriesEnum categories)	The integration categories to show in Merge Link.
EndUserDetailsRequest	build()
EndUserDetailsRequest._FinalStage	categories(java.util.List<CategoriesEnum> categories)
EndUserDetailsRequest._FinalStage	categoryCommonModelScopes(java.util.Map<java.lang.String,java.util.Optional<java.util.List<IndividualCommonModelScopeDeserializerRequest>>> categoryCommonModelScopes)	When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked.
EndUserDetailsRequest._FinalStage	categoryCommonModelScopes(java.util.Optional<java.util.Map<java.lang.String,java.util.Optional<java.util.List<IndividualCommonModelScopeDeserializerRequest>>>> categoryCommonModelScopes)
EndUserDetailsRequest._FinalStage	commonModels(java.util.List<CommonModelScopesBodyRequest> commonModels)	An array of objects to specify the models and fields that will be disabled for a given Linked Account.
EndUserDetailsRequest._FinalStage	commonModels(java.util.Optional<java.util.List<CommonModelScopesBodyRequest>> commonModels)
EndUserDetailsRequest.EndUserOrganizationNameStage	endUserEmailAddress(java.lang.String endUserEmailAddress)	Your end user's email address.
EndUserDetailsRequest.EndUserOriginIdStage	endUserOrganizationName(java.lang.String endUserOrganizationName)	Your end user's organization.
EndUserDetailsRequest._FinalStage	endUserOriginId(java.lang.String endUserOriginId)	This unique identifier typically represents the ID for your end user in your product's database.
EndUserDetailsRequest.Builder	from(EndUserDetailsRequest other)
EndUserDetailsRequest._FinalStage	hideAdminMagicLink(java.lang.Boolean hideAdminMagicLink)	Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow.
EndUserDetailsRequest._FinalStage	hideAdminMagicLink(java.util.Optional<java.lang.Boolean> hideAdminMagicLink)
EndUserDetailsRequest._FinalStage	integration(java.lang.String integration)	The slug of a specific pre-selected integration for this linking flow token.
EndUserDetailsRequest._FinalStage	integration(java.util.Optional<java.lang.String> integration)
EndUserDetailsRequest._FinalStage	integrationSpecificConfig(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> integrationSpecificConfig)	A JSON object containing integration-specific configuration options.
EndUserDetailsRequest._FinalStage	integrationSpecificConfig(java.util.Optional<java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode>> integrationSpecificConfig)
EndUserDetailsRequest._FinalStage	language(LanguageEnum language)	The following subset of IETF language tags can be used to configure localization.
EndUserDetailsRequest._FinalStage	language(java.util.Optional<LanguageEnum> language)
EndUserDetailsRequest._FinalStage	linkExpiryMins(java.lang.Integer linkExpiryMins)	An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid.
EndUserDetailsRequest._FinalStage	linkExpiryMins(java.util.Optional<java.lang.Integer> linkExpiryMins)
EndUserDetailsRequest._FinalStage	shouldCreateMagicLinkUrl(java.lang.Boolean shouldCreateMagicLinkUrl)	Whether to generate a Magic Link URL.
EndUserDetailsRequest._FinalStage	shouldCreateMagicLinkUrl(java.util.Optional<java.lang.Boolean> shouldCreateMagicLinkUrl)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public EndUserDetailsRequest.Builder from(EndUserDetailsRequest other)

Specified by:

from in interface EndUserDetailsRequest.EndUserEmailAddressStage

endUserEmailAddress

public EndUserDetailsRequest.EndUserOrganizationNameStage endUserEmailAddress(java.lang.String endUserEmailAddress)

Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.

Specified by:

endUserEmailAddress in interface EndUserDetailsRequest.EndUserEmailAddressStage

Returns:

Reference to this so that method calls can be chained together.

endUserOrganizationName

public EndUserDetailsRequest.EndUserOriginIdStage endUserOrganizationName(java.lang.String endUserOrganizationName)

Your end user's organization.

Specified by:

endUserOrganizationName in interface EndUserDetailsRequest.EndUserOrganizationNameStage

Returns:

Reference to this so that method calls can be chained together.

endUserOriginId

public EndUserDetailsRequest._FinalStage endUserOriginId(java.lang.String endUserOriginId)

This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.

Specified by:

endUserOriginId in interface EndUserDetailsRequest.EndUserOriginIdStage

Returns:

Reference to this so that method calls can be chained together.

integrationSpecificConfig

public EndUserDetailsRequest._FinalStage integrationSpecificConfig(java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode> integrationSpecificConfig)

A JSON object containing integration-specific configuration options.

Specified by:

integrationSpecificConfig in interface EndUserDetailsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

integrationSpecificConfig

public EndUserDetailsRequest._FinalStage integrationSpecificConfig(java.util.Optional<java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode>> integrationSpecificConfig)

Specified by:

integrationSpecificConfig in interface EndUserDetailsRequest._FinalStage

language

public EndUserDetailsRequest._FinalStage language(LanguageEnum language)

The following subset of IETF language tags can be used to configure localization.

• en - en
• de - de

Specified by:

language in interface EndUserDetailsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

language

public EndUserDetailsRequest._FinalStage language(java.util.Optional<LanguageEnum> language)

Specified by:

language in interface EndUserDetailsRequest._FinalStage

categoryCommonModelScopes

public EndUserDetailsRequest._FinalStage categoryCommonModelScopes(java.util.Map<java.lang.String,java.util.Optional<java.util.List<IndividualCommonModelScopeDeserializerRequest>>> categoryCommonModelScopes)

When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.

Specified by:

categoryCommonModelScopes in interface EndUserDetailsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

categoryCommonModelScopes

public EndUserDetailsRequest._FinalStage categoryCommonModelScopes(java.util.Optional<java.util.Map<java.lang.String,java.util.Optional<java.util.List<IndividualCommonModelScopeDeserializerRequest>>>> categoryCommonModelScopes)

Specified by:

categoryCommonModelScopes in interface EndUserDetailsRequest._FinalStage

commonModels

public EndUserDetailsRequest._FinalStage commonModels(java.util.List<CommonModelScopesBodyRequest> commonModels)

An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.

Specified by:

commonModels in interface EndUserDetailsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

commonModels

public EndUserDetailsRequest._FinalStage commonModels(java.util.Optional<java.util.List<CommonModelScopesBodyRequest>> commonModels)

Specified by:

commonModels in interface EndUserDetailsRequest._FinalStage

hideAdminMagicLink

public EndUserDetailsRequest._FinalStage hideAdminMagicLink(java.lang.Boolean hideAdminMagicLink)

Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.

Specified by:

hideAdminMagicLink in interface EndUserDetailsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

hideAdminMagicLink

public EndUserDetailsRequest._FinalStage hideAdminMagicLink(java.util.Optional<java.lang.Boolean> hideAdminMagicLink)

Specified by:

hideAdminMagicLink in interface EndUserDetailsRequest._FinalStage

shouldCreateMagicLinkUrl

public EndUserDetailsRequest._FinalStage shouldCreateMagicLinkUrl(java.lang.Boolean shouldCreateMagicLinkUrl)

Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.

Specified by:

shouldCreateMagicLinkUrl in interface EndUserDetailsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

shouldCreateMagicLinkUrl

public EndUserDetailsRequest._FinalStage shouldCreateMagicLinkUrl(java.util.Optional<java.lang.Boolean> shouldCreateMagicLinkUrl)

Specified by:

shouldCreateMagicLinkUrl in interface EndUserDetailsRequest._FinalStage

linkExpiryMins

public EndUserDetailsRequest._FinalStage linkExpiryMins(java.lang.Integer linkExpiryMins)

An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.

Specified by:

linkExpiryMins in interface EndUserDetailsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

linkExpiryMins

public EndUserDetailsRequest._FinalStage linkExpiryMins(java.util.Optional<java.lang.Integer> linkExpiryMins)

Specified by:

linkExpiryMins in interface EndUserDetailsRequest._FinalStage

integration

public EndUserDetailsRequest._FinalStage integration(java.lang.String integration)

The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.

Specified by:

integration in interface EndUserDetailsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

integration

public EndUserDetailsRequest._FinalStage integration(java.util.Optional<java.lang.String> integration)

Specified by:

integration in interface EndUserDetailsRequest._FinalStage

addAllCategories

public EndUserDetailsRequest._FinalStage addAllCategories(java.util.List<CategoriesEnum> categories)

The integration categories to show in Merge Link.

Specified by:

addAllCategories in interface EndUserDetailsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

addCategories

public EndUserDetailsRequest._FinalStage addCategories(CategoriesEnum categories)

The integration categories to show in Merge Link.

Specified by:

addCategories in interface EndUserDetailsRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

categories

public EndUserDetailsRequest._FinalStage categories(java.util.List<CategoriesEnum> categories)

Specified by:

categories in interface EndUserDetailsRequest._FinalStage

build

public EndUserDetailsRequest build()

Specified by:

build in interface EndUserDetailsRequest._FinalStage