/*
 Copyright 2009-2014 Urban Airship Inc. All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

 1. Redistributions of source code must retain the above copyright notice, this
 list of conditions and the following disclaimer.

 2. Redistributions in binaryform must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided withthe distribution.

 THIS SOFTWARE IS PROVIDED BY THE URBAN AIRSHIP INC``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 EVENT SHALL URBAN AIRSHIP INC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#import <Foundation/Foundation.h>

@class UAChannelRegistrationPayload;

#define kUAPushMultipleTagsJSONKey @"tags"
#define kUAPushSingleTagJSONKey @"tag"
#define kUAPushAliasJSONKey @"alias"
#define kUAPushQuietTimeJSONKey @"quiettime"
#define kUAPushTimeZoneJSONKey @"tz"
#define kUAPushBadgeJSONKey @"badge"

/**
 * The device registration payload.
 */
@interface UADeviceRegistrationPayload : NSObject

+ (instancetype)payloadWithAlias:(NSString *)alias
              withTags:(NSArray *)tags
          withTimeZone:(NSString *)timeZone
         withQuietTime:(NSDictionary *)quietTime
             withBadge:(NSNumber *)badge;

/**
 * Factory method to create a device registration payload from a 
 * channel registration payload.
 *
 * @param payload An instance of a UAChannelRegistrationPayload
 * @return A UADeviceRegistrationPayload created from the
 * UAChannelRegistrationPayload.
 */
+ (instancetype)payloadFromChannelRegistrationPayload:(UAChannelRegistrationPayload *)payload;

/**
 * Gets the payload as an NSDictionary
 *
 * @return The payload represented as an NSDictionary.
 */
- (NSDictionary *)asDictionary;

/**
 * Gets the payload as a JSON NSString
 *
 * @return The payload represented as a JSON NSString.
 */
- (NSString *)asJSONString;

/**
 * Gets the payload as a JSON NSData.
 *
 * @return The payload as JSON NSData.
 */
- (NSData *)asJSONData;

@end