Class MemberAddArg.Builder

    • Constructor Detail

      • Builder

        protected Builder​(java.lang.String memberEmail)
    • Method Detail

      • withRole

        public MemberAddArg.Builder withRole​(AdminTier role)
        Set value for optional field.

        If left unset or set to null, defaults to AdminTier.MEMBER_ONLY.

        Parameters:
        role - Must not be null. Defaults to AdminTier.MEMBER_ONLY when set to null.
        Returns:
        this builder
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
      • withMemberGivenName

        public MemberAddArg.Builder withMemberGivenName​(java.lang.String memberGivenName)
        Set value for optional field.
        Overrides:
        withMemberGivenName in class MemberAddArgBase.Builder
        Parameters:
        memberGivenName - Member's first name. Must have length of at most 100 and match pattern "[^/:?*<>\"|]*".
        Returns:
        this builder
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
      • withMemberSurname

        public MemberAddArg.Builder withMemberSurname​(java.lang.String memberSurname)
        Set value for optional field.
        Overrides:
        withMemberSurname in class MemberAddArgBase.Builder
        Parameters:
        memberSurname - Member's last name. Must have length of at most 100 and match pattern "[^/:?*<>\"|]*".
        Returns:
        this builder
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
      • withMemberExternalId

        public MemberAddArg.Builder withMemberExternalId​(java.lang.String memberExternalId)
        Set value for optional field.
        Overrides:
        withMemberExternalId in class MemberAddArgBase.Builder
        Parameters:
        memberExternalId - External ID for member. Must have length of at most 64.
        Returns:
        this builder
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
      • withMemberPersistentId

        public MemberAddArg.Builder withMemberPersistentId​(java.lang.String memberPersistentId)
        Set value for optional field.
        Overrides:
        withMemberPersistentId in class MemberAddArgBase.Builder
        Parameters:
        memberPersistentId - Persistent ID for member. This field is only available to teams using persistent ID SAML configuration.
        Returns:
        this builder
      • withSendWelcomeEmail

        public MemberAddArg.Builder withSendWelcomeEmail​(java.lang.Boolean sendWelcomeEmail)
        Set value for optional field.

        If left unset or set to null, defaults to true.

        Overrides:
        withSendWelcomeEmail in class MemberAddArgBase.Builder
        Parameters:
        sendWelcomeEmail - Whether to send a welcome email to the member. If send_welcome_email is false, no email invitation will be sent to the user. This may be useful for apps using single sign-on (SSO) flows for onboarding that want to handle announcements themselves. Defaults to true when set to null.
        Returns:
        this builder