enum Ternary { YES, NO, UNSPECIFIED }

enum StatusReportingMode { ALL, ERRORS, NONE, UNSPECIFIED }

enum MessageBodyEncoding { TEXT, UNICODE, BINARY }

enum ProtocolId {
    IMPLICIT,
    SHORT_MESSAGE_TYPE_0,
    REPLACE_MESSAGE_TYPE_1,
    REPLACE_MESSAGE_TYPE_2,
    REPLACE_MESSAGE_TYPE_3,
    REPLACE_MESSAGE_TYPE_4,
    REPLACE_MESSAGE_TYPE_5,
    REPLACE_MESSAGE_TYPE_6,
    REPLACE_MESSAGE_TYPE_7,
    RETURN_CALL,
    ME_DATA_DOWNLOAD,
    ME_DEPERSONALIZE,
    SIM_DATA_DOWNLOAD
}

enum MessageClass { CLASS_0_FLASH, CLASS_1_ME, CLASS_2_SIM, CLASS_3_TE }

interface ContactGroup {
    Integer getId()
    String getName()
    Integer getSize()
}

interface Contact {
    String getForenames()
    String getSurname()
    String getMsisdn()
    Integer[] getGroupIds()
    Integer getTimestamp()
}

enum {
    DONT_NORMALIZE_MSISDNS,
    DONT_REPLACE_EXISTING
}

interface UserProfile {
    Integer getUserId()
    String getUsername()
    Decimal getCredits()
    String getHonorific()
    String getForenames()
    String getSurname()
    String getEmail()
    String getMsisdn()
    String getCountry()
    String getCompany()
    String getTimezone()
    Integer getDailyQuota()
    Integer getDailyQuotaUsed()
    String getJsonApiToken()
    String getMessageRelayUrl()
    String getStatusReportRelayUrl()
    Integer getLowCreditNotificationLevel()
    String getDefaultOriginAddress()
    String[] getOriginAddresses()
    UserProfileFlag[] getFlags()
}

enum UserProfileFlag {
    HAS_FULL_ORIGIN_ADDRESS_CONTROL,
    CAN_TRANSFER_CREDITS,
    LOW_CREDIT_NOTIFY_EMAIL,
    LOW_CREDIT_NOTIFY_SMS
}

interface MessageSubmission {
    String uniqueId
    MessageSubmissionScheduling scheduling
    MessageSubmissionFlag[] flags
}

interface MessageSubmissionScheduling {
    Iso8601 date
    String description
}

interface MessageSubmission {
    String sender
    String[] recipients
    Integer[] groups,
    String body,
    MessageBodyEncoding encoding,
    Ternary repliable,
    Integer routingProfile,
    Integer maxConcatParts,
    String clientId,
    Integer protocolId,
    MessageClass messageClass,
    StatusReportingMode statusReporting,
    MessageSubmissionTemplateDefaults templateDefaults
}

interface OriginAddress {
    constant OriginAddress REPLIABLE = OriginAddress(address = "*", type = OriginAddressType.INTERNATIONAL)
    OriginAddressType type
    String address
}

enum OriginAddressType { INTERNATIONAL, NATIONAL, SHORTCODE, ALPHANUMERIC, UNSPECIFIED }

interface DestinationAddress {
    DestinationAddressType type
    String address
}

enum DestinationAddressType { INTERNATIONAL, UNSPECIFIED }

enum MessageSubmissionFlag {
    ALLOW_DUPLICATE_RECIPIENTS,
    ALLOW_SCHEDULING_IN_PAST,
    ALLOW_INVALID_MSISDNS,
    REPLACE_INVALID_CHARACTERS,
    AUTO_CONCAT,
    AUTO_UNICODE
}

interface MessageSubmissionTemplateDefaults {
    String h,
    String fn,
    String sn
}

interface MessageSubmissionResult {
    MessageSubmissionStatus getStatus(),
    Integer getSubmissionId(),
    String getMessage()
}

enum MessageSubmissionStatus { IN_PROGRESS, SCHEDULED }

interface Message {
    Integer getId()
    String getFrom()
    String getTo()
    Date getCreatedDate()
    String getBody()
    MessageBodyEncoding getEncoding()
    String getReferringClientId()
}

interface MessageState {
    String getStatus(),
    Boolean isFinal(),
    String getMsisdn(),
    String getClientId()
}

interface BulkSMSClient {
    setDefaultSubmissionFlags(MessageSubmissionFlag[] flags),
    MessageSubmissionResult sendMessage(String msisdn, String body),
    MessageSubmissionResult sendMessage(MessageSubmission submission),
    MessageSubmissionResult sendMessage(MessageSubmission[] submissions),
    MessageSubmissionResult sendMessage(MessageSubmission submission, MessageSubmissionOptions options),
    MessageSubmissionResult sendMessage(MessageSubmission[] submissions, MessageSubmissionOptions options),
    
    Decimal estimateMessage(String msisdn, String body),
    Decimal estimateMessage(MessageSubmission submission),
    Decimal estimateMessage(MessageSubmission[] submissions),
    Decimal estimateMessage(MessageSubmission submission, MessageSubmissionOptions options),
    Decimal estimateMessage(MessageSubmission[] submissions, MessageSubmissionOptions options),
    
    MessageState[] getMessageState(Integer submissionId, String msisdn = null, String clientId = null),
    
    Message[] getInbox(Integer lastRetrievedId = 0)
    
    ContactGroup[] getContactGroups(),
    Contact[] updateContacts(Contact[] contacts, ContactUpdateFlag[] flags),
    Contact[] getContacts(String filter = null, Integer offset = 0, Integer limit = 0),
    UserProfile getUserProfile()
}

interface MessageSubmissionBuilder {
    MessageSubmissionBuilder from(String from),
    MessageSubmissionBuilder to(String to),
    MessageSubmissionBuilder toGroup(Integer groupId),
    MessageSubmissionBuilder body(String body),
    MessageSubmissionBuilder body(String body, MessageBodyEncoding encoding),
    MessageSubmissionBuilder routingProfile(Integer routingProfile),
    MessageSubmissionBuilder maxConcatParts(Integer maxConcatParts),
    MessageSubmissionBuilder clientId(String clientId),
    MessageSubmissionBuilder protocolId(ProtocolId protocolId),
    MessageSubmissionBuilder protocolId(Integer protocolId),
    MessageSubmissionBuilder messageClass(MessageClass messageClass),
    MessageSubmissionBuilder statusReportingMode(StatusReportingMode statusReportingMode),
    MessageSubmission build()
}