au.org.consumerdatastandards.api.common.models.CommonEmailAddress Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-model Show documentation

This artefact describes the Consumer Data Standards using Java classes and annotations in a way suitable for automatic generation of Open API Specification, documentation, Server Stub, Client Libraries and Reference Test.

There is a newer version: 1.1.1

Show newest version

package au.org.consumerdatastandards.api.common.models;

import au.org.consumerdatastandards.support.data.*;

@DataDefinition
public class CommonEmailAddress {

    public enum Purpose {
        WORK,
        HOME,
        OTHER,
        UNSPECIFIED
    }

    @Property(
        description = "Required for one and only one email record in the collection. Denotes the default email address"
    )
    @CDSDataType(CustomDataType.Boolean)
    Boolean isPreferred;

    @Property(
        description = "The purpose for the email, as specified by the customer (Enumeration)",
        required = true
    )
    Purpose purpose;

    @Property(
        description = "A correctly formatted email address, as defined by the addr_spec format in [RFC 5322](https://www.ietf.org/rfc/rfc5322.txt)",
        required = true
    )
    @CDSDataType(CustomDataType.ExternalRef)
    String address;
}