Class ListAccountsRequest.Builder

  • Enclosing class:
    ListAccountsRequest

    public static final class ListAccountsRequest.Builder
    extends java.lang.Object
    • Method Detail

      • name

        public ListAccountsRequest.Builder name​(java.lang.String name)
        Filter connected accounts by name.

        If provided, this query will attempt to find matches against the following Account and Profile fields: <ul> <li>Account `displayName`</li> <li>Individual Profile `firstName`, `middleName`, and `lastName`</li> <li>Business Profile `legalBusinessName`</li> </ul>

      • name

        public ListAccountsRequest.Builder name​(java.util.Optional<java.lang.String> name)
        Filter connected accounts by name.

        If provided, this query will attempt to find matches against the following Account and Profile fields: <ul> <li>Account `displayName`</li> <li>Individual Profile `firstName`, `middleName`, and `lastName`</li> <li>Business Profile `legalBusinessName`</li> </ul>

      • email

        public ListAccountsRequest.Builder email​(java.lang.String email)
        Filter connected accounts by email address.

        Provide the full email address to filter by email.

      • email

        public ListAccountsRequest.Builder email​(java.util.Optional<java.lang.String> email)
        Filter connected accounts by email address.

        Provide the full email address to filter by email.

      • type

        public ListAccountsRequest.Builder type​(CreateAccountType type)
        Filter connected accounts by AccountType.

        If the `type` parameter is used in combination with `name`, only the corresponding type's name fields will be searched. For example, if `type=business` and `name=moov`, the search will attempt to find matches against the display name and Business Profile name fields (`legalBusinessName`, and `doingBusinessAs`).

        Filtering by `type=guest` is not currently supported.

      • type

        public ListAccountsRequest.Builder type​(java.util.Optional<? extends CreateAccountType> type)
        Filter connected accounts by AccountType.

        If the `type` parameter is used in combination with `name`, only the corresponding type's name fields will be searched. For example, if `type=business` and `name=moov`, the search will attempt to find matches against the display name and Business Profile name fields (`legalBusinessName`, and `doingBusinessAs`).

        Filtering by `type=guest` is not currently supported.

      • foreignID

        public ListAccountsRequest.Builder foreignID​(java.lang.String foreignID)
        Serves as an optional alias from a foreign/external system which can be used to reference this resource.
      • foreignID

        public ListAccountsRequest.Builder foreignID​(java.util.Optional<java.lang.String> foreignID)
        Serves as an optional alias from a foreign/external system which can be used to reference this resource.
      • includeDisconnected

        public ListAccountsRequest.Builder includeDisconnected​(boolean includeDisconnected)
        Filter disconnected accounts.

        If true, the response will include disconnected accounts.

      • includeDisconnected

        public ListAccountsRequest.Builder includeDisconnected​(java.util.Optional<java.lang.Boolean> includeDisconnected)
        Filter disconnected accounts.

        If true, the response will include disconnected accounts.