Package io.moov.sdk.models.operations

Class ListAccountsRequest

  • public class ListAccountsRequest
extends java.lang.Object

    • Constructor Detail

      • ListAccountsRequest

        public ListAccountsRequest​(java.util.Optional<java.lang.String> xMoovVersion,
                           java.util.Optional<java.lang.String> name,
                           java.util.Optional<java.lang.String> email,
                           java.util.Optional<? extends AccountType> type,
                           java.util.Optional<java.lang.Boolean> includeGuest,
                           java.util.Optional<java.lang.String> foreignID,
                           java.util.Optional<java.lang.Boolean> includeDisconnected,
                           java.util.Optional<? extends CapabilityID> capability,
                           java.util.Optional<? extends CapabilityStatus> capabilityStatus,
                           java.util.Optional<java.lang.Long> skip,
                           java.util.Optional<java.lang.Long> count)

      • ListAccountsRequest

        public ListAccountsRequest()

    • Method Detail

      • xMoovVersion

        public java.util.Optional<java.lang.String> xMoovVersion()
        Specify an API version.

        API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024.

        The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

      • name

        public 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 java.util.Optional<java.lang.String> email()
        Filter connected accounts by email address.

        Provide the full email address to filter by email.

      • type

        public java.util.Optional<AccountType> 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`).

      • includeGuest

        public java.util.Optional<java.lang.Boolean> includeGuest()
        Filter accounts with AccountType guest.

        If true, the response will include guest accounts.

      • foreignID

        public 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 java.util.Optional<java.lang.Boolean> includeDisconnected()
        Filter disconnected accounts.

        If true, the response will include disconnected accounts.

      • capability

        public java.util.Optional<CapabilityID> capability()
        Filter connected accounts by the capability.

      • capabilityStatus

        public java.util.Optional<CapabilityStatus> capabilityStatus()
        Filter connected accounts by the capability.

      • skip

        public java.util.Optional<java.lang.Long> skip()

      • count

        public java.util.Optional<java.lang.Long> count()

      • withXMoovVersion

        public ListAccountsRequest withXMoovVersion​(java.lang.String xMoovVersion)
        Specify an API version.

        API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024.

        The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

      • withXMoovVersion

        public ListAccountsRequest withXMoovVersion​(java.util.Optional<java.lang.String> xMoovVersion)
        Specify an API version.

        API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024.

        The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

      • withName

        public ListAccountsRequest withName​(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>

      • withName

        public ListAccountsRequest withName​(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>

      • withEmail

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

        Provide the full email address to filter by email.

      • withEmail

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

        Provide the full email address to filter by email.

      • withType

        public ListAccountsRequest withType​(AccountType 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`).

      • withType

        public ListAccountsRequest withType​(java.util.Optional<? extends AccountType> 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`).

      • withIncludeGuest

        public ListAccountsRequest withIncludeGuest​(boolean includeGuest)
        Filter accounts with AccountType guest.

        If true, the response will include guest accounts.

      • withIncludeGuest

        public ListAccountsRequest withIncludeGuest​(java.util.Optional<java.lang.Boolean> includeGuest)
        Filter accounts with AccountType guest.

        If true, the response will include guest accounts.

      • withForeignID

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

      • withForeignID

        public ListAccountsRequest withForeignID​(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.

      • withIncludeDisconnected

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

        If true, the response will include disconnected accounts.

      • withIncludeDisconnected

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

        If true, the response will include disconnected accounts.

      • withCapability

        public ListAccountsRequest withCapability​(java.util.Optional<? extends CapabilityID> capability)
        Filter connected accounts by the capability.

      • withCapabilityStatus

        public ListAccountsRequest withCapabilityStatus​(java.util.Optional<? extends CapabilityStatus> capabilityStatus)
        Filter connected accounts by the capability.

      • withCount

        public ListAccountsRequest withCount​(java.util.Optional<java.lang.Long> count)

      • equals

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

      • hashCode

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

      • toString

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