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

Class EndUserDetailsRequest

  • public final class EndUserDetailsRequest
extends java.lang.Object

    • Method Detail

      • getEndUserEmailAddress

        public java.lang.String getEndUserEmailAddress()
        Returns:
        Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.

      • getEndUserOrganizationName

        public java.lang.String getEndUserOrganizationName()
        Returns:
        Your end user's organization.

      • getEndUserOriginId

        public java.lang.String getEndUserOriginId()
        Returns:
        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.

      • getCategories

        public java.util.List<CategoriesEnum> getCategories()
        Returns:
        The integration categories to show in Merge Link.

      • getIntegration

        public java.util.Optional<java.lang.String> getIntegration()
        Returns:
        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/.

      • getLinkExpiryMins

        public java.util.Optional<java.lang.Integer> getLinkExpiryMins()
        Returns:
        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.

      • getShouldCreateMagicLinkUrl

        public java.util.Optional<java.lang.Boolean> getShouldCreateMagicLinkUrl()
        Returns:
        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.

      • getHideAdminMagicLink

        public java.util.Optional<java.lang.Boolean> getHideAdminMagicLink()
        Returns:
        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.

      • getCommonModels

        public java.util.Optional<java.util.List<CommonModelScopesBodyRequest>> getCommonModels()
        Returns:
        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.

      • getCategoryCommonModelScopes

        public java.util.Optional<java.util.Map<java.lang.String,​java.util.Optional<java.util.List<IndividualCommonModelScopeDeserializerRequest>>>> getCategoryCommonModelScopes()
        Returns:
        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.

      • getLanguage

        public java.util.Optional<LanguageEnum> getLanguage()
        Returns:
        The following subset of IETF language tags can be used to configure localization.
        • en - en
        • de - de

      • getIntegrationSpecificConfig

        public java.util.Optional<java.util.Map<java.lang.String,​com.fasterxml.jackson.databind.JsonNode>> getIntegrationSpecificConfig()
        Returns:
        A JSON object containing integration-specific configuration options.

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object