//
//  RadarTripOptions.h
//  RadarSDK
//
//  Copyright © 2020 Radar Labs, Inc. All rights reserved.
//

#import <Foundation/Foundation.h>

#import "RadarRouteMode.h"
#import "RadarTripLeg.h"


NS_ASSUME_NONNULL_BEGIN

/**
 An options class used to configure trip tracking.

 @see https://radar.com/documentation/sdk/ios
 */
@interface RadarTripOptions : NSObject

- (instancetype)initWithExternalId:(NSString *_Nonnull)externalId
            destinationGeofenceTag:(NSString *_Nullable)destinationGeofenceTag
     destinationGeofenceExternalId:(NSString *_Nullable)destinationGeofenceExternalId;

- (instancetype)initWithExternalId:(NSString *_Nonnull)externalId
            destinationGeofenceTag:(NSString *_Nullable)destinationGeofenceTag
     destinationGeofenceExternalId:(NSString *_Nullable)destinationGeofenceExternalId
                scheduledArrivalAt:(NSDate *_Nullable)scheduledArrivalAt;

- (instancetype)initWithExternalId:(NSString *_Nonnull)externalId
            destinationGeofenceTag:(NSString *_Nullable)destinationGeofenceTag
     destinationGeofenceExternalId:(NSString *_Nullable)destinationGeofenceExternalId
                scheduledArrivalAt:(NSDate *_Nullable)scheduledArrivalAt
                         startTracking:(BOOL)startTracking;
/**
 A stable unique ID for the trip.
 */
@property (nonnull, nonatomic, copy) NSString *externalId;

/**
 An optional set of custom key-value pairs for the trip.
 */
@property (nullable, nonatomic, copy) NSDictionary *metadata;

/**
 For trips with a destination, the tag of the destination geofence.
 */
@property (nullable, nonatomic, copy) NSString *destinationGeofenceTag;

/**
 For trips with a destination, the external ID of the destination geofence.
 */
@property (nullable, nonatomic, copy) NSString *destinationGeofenceExternalId;

/**
 * The scheduled arrival time for the trip.
 */
@property (nullable, nonatomic, copy) NSDate *scheduledArrivalAt;

/**
 For trips with a destination, the travel mode.
 */
@property (nonatomic, assign) RadarRouteMode mode;

@property (nonatomic, assign) UInt16 approachingThreshold;

@property (nonatomic, assign) BOOL startTracking;

/**
 For multi-destination trips, an optional array of trip legs.
 */
@property (nullable, nonatomic, copy) NSArray<RadarTripLeg *> *legs;

+ (RadarTripOptions *_Nullable)tripOptionsFromDictionary:(NSDictionary *)dict;
- (NSDictionary *)dictionaryValue;

@end

NS_ASSUME_NONNULL_END