react-native-radar 3.30.0-beta.2 → 3.30.0-beta.3

package/ios/RadarSDK.xcframework/ios-arm64_x86_64-simulator/RadarSDK.framework/Headers/RadarAddress.h

@@ -0,0 +1,172 @@
+//
+//  RadarAddress.h
+//  RadarSDK
+//
+//  Copyright © 2019 Radar Labs, Inc. All rights reserved.
+//
+
+#import "RadarCoordinate.h"
+#import "RadarTimeZone.h"
+#import <Foundation/Foundation.h>
+
+/**
+  The confidence levels for geocoding results.
+ */
+typedef NS_ENUM(NSInteger, RadarAddressConfidence) {
+    /// Unknown
+    RadarAddressConfidenceNone NS_SWIFT_NAME(none) = 0,
+    /// Exact
+    RadarAddressConfidenceExact NS_SWIFT_NAME(exact) = 1,
+    /// Interpolated
+    RadarAddressConfidenceInterpolated NS_SWIFT_NAME(interpolated) = 2,
+    /// Fallback
+    RadarAddressConfidenceFallback NS_SWIFT_NAME(fallback) = 3
+};
+
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ Represents an address.
+
+ @see https://radar.com/documentation/api#geocoding
+ */
+@interface RadarAddress : NSObject
+
+/**
+ The location coordinate of the address.
+ */
+@property (assign, nonatomic, readonly) CLLocationCoordinate2D coordinate;
+
+/**
+ The formatted string representation of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *formattedAddress;
+
+/**
+ The name of the country of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *country;
+
+/**
+ The unique code of the country of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *countryCode;
+
+/**
+ The flag of the country of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *countryFlag;
+
+/**
+ The name of the DMA of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *dma;
+
+/**
+ The unique code of the DMA of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *dmaCode;
+
+/**
+ The name of the state of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *state;
+
+/**
+ The unique code of the state of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *stateCode;
+
+/**
+ The postal code of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *postalCode;
+
+/**
+ The city of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *city;
+
+/**
+ The borough of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *borough;
+
+/**
+ The county of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *county;
+
+/**
+ The neighborhood of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *neighborhood;
+
+/**
+ The street number of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *number;
+
+/**
+ The street name of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *street;
+
+/**
+ The label of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *addressLabel;
+
+/**
+ The label of the place.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *placeLabel;
+
+/**
+The unit of the address.
+*/
+@property (nullable, copy, nonatomic, readonly) NSString *unit;
+
+/**
+The plus4 value for the zip of the address.
+*/
+@property (nullable, copy, nonatomic, readonly) NSString *plus4;
+
+/**
+The distance to the search anchor in meters.
+*/
+@property (nullable, copy, nonatomic, readonly) NSNumber *distance; 
+
+/**
+The layer of the address, e.g. 'place', 'address', 'intersection', 'street', 'state', etc.
+*/
+@property (nullable, copy, nonatomic, readonly) NSString *layer;
+
+/**
+The metadata of the address.
+*/
+@property (nullable, copy, nonatomic, readonly) NSDictionary *metadata;
+
+/**
+  The confidence level of the geocoding result.
+ */
+@property (nonatomic, assign) enum RadarAddressConfidence confidence;
+
+/**
+The time zone information of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) RadarTimeZone *timeZone;
+
+/**
+The categories of the address.
+ */
+@property (nullable, copy, nonatomic, readonly) NSArray<NSString *> *categories;
+
++ (RadarAddress *_Nullable)addressFromObject:(id _Nonnull)object;
++ (NSArray<NSDictionary *> *_Nullable)arrayForAddresses:(NSArray<RadarAddress *> *_Nullable)addresses;
+- (NSDictionary *_Nonnull)dictionaryValue;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/RadarSDK.xcframework/ios-arm64_x86_64-simulator/RadarSDK.framework/Headers/RadarBeacon.h

@@ -0,0 +1,75 @@
+//
+//  RadarBeacon.h
+//  RadarSDK
+//
+//  Copyright © 2020 Radar Labs, Inc. All rights reserved.
+//
+
+#import "RadarCoordinate.h"
+#import <CoreLocation/CoreLocation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ Represents a Bluetooth beacon.
+
+ @see https://radar.com/documentation/beacons
+ */
+@interface RadarBeacon : NSObject
+
+/**
+ The Radar ID of the beacon.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *_id;
+
+/**
+ The description of the beacon. Not to be confused with the `NSObject` `description` property.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *__description;
+
+/**
+ The tag of the beacon.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *tag;
+
+/**
+ The external ID of the beacon.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *externalId;
+
+/**
+ The UUID of the beacon.
+ */
+@property (nonnull, copy, nonatomic, readonly) NSString *uuid;
+
+/**
+ The major ID of the beacon.
+ */
+@property (nonnull, copy, nonatomic, readonly) NSString *major;
+
+/**
+ The minor ID of the beacon.
+ */
+@property (nonnull, copy, nonatomic, readonly) NSString *minor;
+
+/**
+ The optional set of custom key-value pairs for the beacon.
+ */
+@property (nullable, copy, nonatomic, readonly) NSDictionary *metadata;
+
+/**
+ The location of the beacon.
+ */
+@property (nullable, strong, nonatomic, readonly) RadarCoordinate *geometry;
+
+/**
+ The RSSI of the beacon, or 0 if not available.
+ */
+@property (nonatomic, readonly) NSInteger rssi;
+
++ (NSArray<NSDictionary *> *_Nullable)arrayForBeacons:(NSArray<RadarBeacon *> *_Nullable)beacons;
+- (NSDictionary *_Nonnull)dictionaryValue;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/RadarSDK.xcframework/ios-arm64_x86_64-simulator/RadarSDK.framework/Headers/RadarChain.h

@@ -0,0 +1,44 @@
+//
+//  RadarChain.h
+//  RadarSDK
+//
+//  Copyright © 2019 Radar Labs, Inc. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+/**
+ Represents the chain of a place.
+
+ @see https://radar.com/documentation/places
+ */
+@interface RadarChain : NSObject
+
+/**
+ The unique ID of the chain. For a full list of chains, see https://radar.com/documentation/places/chains.
+
+ @see https://radar.com/documentation/places/chains
+ */
+@property (nonnull, copy, nonatomic, readonly) NSString *slug;
+
+/**
+ The name of the chain. For a full list of chains, see https://radar.com/documentation/places/chains.
+
+ @see https://radar.com/documentation/places/chains
+ */
+@property (nonnull, copy, nonatomic, readonly) NSString *name;
+
+/**
+ The external ID of the chain.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *externalId;
+
+/**
+ The optional set of custom key-value pairs for the chain.
+ */
+@property (nullable, copy, nonatomic, readonly) NSDictionary *metadata;
+
++ (NSArray<NSDictionary *> *_Nullable)arrayForChains:(NSArray<RadarChain *> *_Nullable)chains;
+- (NSDictionary *_Nonnull)dictionaryValue;
+
+@end

package/ios/RadarSDK.xcframework/ios-arm64_x86_64-simulator/RadarSDK.framework/Headers/RadarCircleGeometry.h

@@ -0,0 +1,27 @@
+//
+//  RadarCircleGeometry.h
+//  RadarSDK
+//
+//  Copyright © 2019 Radar Labs, Inc. All rights reserved.
+//
+
+#import "RadarCoordinate.h"
+#import "RadarGeofenceGeometry.h"
+#import <UIKit/UIKit.h>
+
+/**
+ Represents the geometry of a circle geofence.
+ */
+@interface RadarCircleGeometry : RadarGeofenceGeometry
+
+/**
+ The center of the circle geofence.
+ */
+@property (nonnull, strong, nonatomic, readonly) RadarCoordinate *center;
+
+/**
+ The radius of the circle geofence in meters.
+ */
+@property (assign, nonatomic, readonly) double radius;
+
+@end

package/ios/RadarSDK.xcframework/ios-arm64_x86_64-simulator/RadarSDK.framework/Headers/RadarContext.h

@@ -0,0 +1,65 @@
+//
+//  RadarContext.h
+//  RadarSDK
+//
+//  Copyright © 2020 Radar Labs, Inc. All rights reserved.
+//
+
+#import "RadarGeofence.h"
+#import "RadarPlace.h"
+#import "RadarRegion.h"
+#import <CoreLocation/CoreLocation.h>
+#import <Foundation/Foundation.h>
+
+/**
+ Represents the context for a location.
+
+ @see https://radar.com/documentation/api#context
+ */
+@interface RadarContext : NSObject
+
+/**
+ An array of the geofences for the location. May be empty if the location is not in any geofences.
+
+ @see https://radar.com/documentation/geofences
+ */
+@property (nonnull, copy, nonatomic, readonly) NSArray<RadarGeofence *> *geofences;
+
+/**
+ The place for the location. May be `nil` if the location is not at a place or if Places is not enabled.
+
+ @see https://radar.com/documentation/places
+ */
+@property (nullable, copy, nonatomic, readonly) RadarPlace *place;
+
+/**
+ The country of the location. May be `nil` if country is not available or if Regions is not enabled.
+
+ @see https://radar.com/documentation/regions
+ */
+@property (nullable, strong, nonatomic, readonly) RadarRegion *country;
+
+/**
+ The state of the location. May be `nil` if state is not available or if Regions is not enabled.
+
+ @see https://radar.com/documentation/regions
+ */
+@property (nullable, strong, nonatomic, readonly) RadarRegion *state;
+
+/**
+ The designated market area (DMA) of the location. May be `nil` if DMA is not available or if Regions is not enabled.
+
+ @see https://radar.com/documentation/regions
+ */
+@property (nullable, strong, nonatomic, readonly) RadarRegion *dma;
+
+/**
+ The postal code of the location. May be `nil` if postal code is not available or if Regions is not enabled.
+
+ @see https://radar.com/documentation/regions
+ */
+@property (nullable, strong, nonatomic, readonly) RadarRegion *postalCode;
+
+- (NSDictionary *_Nonnull)dictionaryValue;
+
+@end

package/ios/RadarSDK.xcframework/ios-arm64_x86_64-simulator/RadarSDK.framework/Headers/RadarCoordinate.h

@@ -0,0 +1,23 @@
+//
+//  RadarCoordinate.h
+//  RadarSDK
+//
+//  Copyright © 2019 Radar Labs, Inc. All rights reserved.
+//
+
+#import <CoreLocation/CoreLocation.h>
+#import <Foundation/Foundation.h>
+
+/**
+ Represents a location coordinate.
+ */
+@interface RadarCoordinate : NSObject
+
+/**
+ The coordinate.
+ */
+@property (assign, nonatomic, readonly) CLLocationCoordinate2D coordinate;
+
+- (NSDictionary* _Nonnull)dictionaryValue;
+
+@end

package/ios/RadarSDK.xcframework/ios-arm64_x86_64-simulator/RadarSDK.framework/Headers/RadarDelegate.h

@@ -0,0 +1,67 @@
+//
+//  RadarDelegate.h
+//  RadarSDK
+//
+//  Copyright © 2019 Radar Labs, Inc. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+#import "Radar.h"
+#import "RadarEvent.h"
+#import "RadarUser.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ A delegate for client-side delivery of events, location updates, and debug logs. For more information, see https://radar.com/documentation/sdk/ios
+
+ @see https://radar.com/documentation/sdk/ios
+ */
+@protocol RadarDelegate<NSObject>
+@optional
+
+/**
+ Tells the delegate that events were received.
+
+ @param events The events received.
+ @param user The user, if any.
+ */
+- (void)didReceiveEvents:(NSArray<RadarEvent *> *_Nonnull)events user:(RadarUser *_Nullable)user NS_SWIFT_NAME(didReceiveEvents(_:user:));
+
+/**
+ Tells the delegate that the current user's location was updated and synced to the server.
+
+ @param location The location.
+ @param user The current user.
+ */
+- (void)didUpdateLocation:(CLLocation *_Nonnull)location user:(RadarUser *_Nonnull)user NS_SWIFT_NAME(didUpdateLocation(_:user:));
+
+/**
+ Tells the delegate that the client's location was updated but not necessarily synced to the server. To receive only server-synced location updates and user
+ state, use `didUpdateLocation:user:` instead.
+
+ @param location The location.
+ @param stopped A boolean indicating whether the client is stopped.
+ @param source The source of the location.
+ */
+- (void)didUpdateClientLocation:(CLLocation *_Nonnull)location stopped:(BOOL)stopped source:(RadarLocationSource)source NS_SWIFT_NAME(didUpdateClientLocation(_:stopped:source:));
+
+/**
+ Tells the delegate that a request failed.
+
+ @param status The status.
+ */
+- (void)didFailWithStatus:(RadarStatus)status NS_SWIFT_NAME(didFail(status:));
+
+/**
+ Tells the delegate that a debug log message was received.
+
+ @param message The message.
+ */
+- (void)didLogMessage:(NSString *_Nonnull)message NS_SWIFT_NAME(didLog(message:));
+
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/RadarSDK.xcframework/ios-arm64_x86_64-simulator/RadarSDK.framework/Headers/RadarEvent.h

@@ -0,0 +1,209 @@
+//
+//  RadarEvent.h
+//  RadarSDK
+//
+//  Copyright © 2019 Radar Labs, Inc. All rights reserved.
+//
+
+#import "RadarGeofence.h"
+#import "RadarPlace.h"
+#import "RadarRegion.h"
+#import "RadarUser.h"
+#import "RadarFraud.h"
+#import <CoreLocation/CoreLocation.h>
+#import <Foundation/Foundation.h>
+
+/**
+ Represents a change in user state.
+ */
+@interface RadarEvent : NSObject
+
+/**
+ The types for events.
+ */
+typedef NS_ENUM(NSInteger, RadarEventType) {
+    /// Unknown
+    RadarEventTypeUnknown NS_SWIFT_NAME(unknown),
+    // A conversion type, created by calling `Radar.sendEvent()`. The type value
+    // will be assigned to the `conversionName` property.
+    RadarEventTypeConversion NS_SWIFT_NAME(conversion),
+    /// `user.entered_geofence`
+    RadarEventTypeUserEnteredGeofence NS_SWIFT_NAME(userEnteredGeofence),
+    /// `user.exited_geofence`
+    RadarEventTypeUserExitedGeofence NS_SWIFT_NAME(userExitedGeofence),
+    RadarEventTypeUserEnteredPlace NS_SWIFT_NAME(userEnteredPlace),
+    /// `user.exited_place`
+    RadarEventTypeUserExitedPlace NS_SWIFT_NAME(userExitedPlace),
+    /// `user.nearby_place_chain`
+    RadarEventTypeUserNearbyPlaceChain NS_SWIFT_NAME(userNearbyPlaceChain),
+    /// `user.entered_region_country`
+    RadarEventTypeUserEnteredRegionCountry NS_SWIFT_NAME(userEnteredRegionCountry),
+    /// `user.exited_region_country`
+    RadarEventTypeUserExitedRegionCountry NS_SWIFT_NAME(userExitedRegionCountry),
+    /// `user.entered_region_state`
+    RadarEventTypeUserEnteredRegionState NS_SWIFT_NAME(userEnteredRegionState),
+    /// `user.exited_region_state`
+    RadarEventTypeUserExitedRegionState NS_SWIFT_NAME(userExitedRegionState),
+    /// `user.entered_region_dma`
+    RadarEventTypeUserEnteredRegionDMA NS_SWIFT_NAME(userEnteredRegionDMA),
+    /// `user.exited_region_dma`
+    RadarEventTypeUserExitedRegionDMA NS_SWIFT_NAME(userExitedRegionDMA),
+    /// `user.started_trip`
+    RadarEventTypeUserStartedTrip NS_SWIFT_NAME(userStartedTrip),
+    /// `user.updated_trip`
+    RadarEventTypeUserUpdatedTrip NS_SWIFT_NAME(userUpdatedTrip),
+    /// `user.approaching_trip_destination`
+    RadarEventTypeUserApproachingTripDestination NS_SWIFT_NAME(userApproachingTripDestination),
+    /// `user.arrived_at_trip_destination`
+    RadarEventTypeUserArrivedAtTripDestination NS_SWIFT_NAME(userArrivedAtTripDestination),
+    /// `user.stopped_trip`
+    RadarEventTypeUserStoppedTrip NS_SWIFT_NAME(userStoppedTrip),
+    /// `user.entered_beacon`
+    RadarEventTypeUserEnteredBeacon NS_SWIFT_NAME(userEnteredBeacon),
+    /// `user.exited_beacon`
+    RadarEventTypeUserExitedBeacon NS_SWIFT_NAME(userExitedBeacon),
+    /// `user.entered_region_postal_code`
+    RadarEventTypeUserEnteredRegionPostalCode NS_SWIFT_NAME(userEnteredRegionPostalCode),
+    /// `user.exited_region_postal_code`
+    RadarEventTypeUserExitedRegionPostalCode NS_SWIFT_NAME(userExitedRegionPostalCode),
+    /// `user.dwelled_in_geofence`
+    RadarEventTypeUserDwelledInGeofence NS_SWIFT_NAME(userDwelledInGeofence),
+    /// 'user.arrived_at_wrong_trip_destination`
+    RadarEventTypeUserArrivedAtWrongTripDestination NS_SWIFT_NAME(userArrivedAtWrongTripDestination),
+    /// `user.failed_fraud`
+    RadarEventTypeUserFailedFraud NS_SWIFT_NAME(userFailedFraud),
+    /// `user.fired_trip_orders`
+    RadarEventTypeUserFiredTripOrders NS_SWIFT_NAME(userFiredTripOrders)
+};
+
+/**
+ The confidence levels for events.
+ */
+typedef NS_ENUM(NSInteger, RadarEventConfidence) {
+    /// Unknown confidence
+    RadarEventConfidenceNone NS_SWIFT_NAME(none) = 0,
+    /// Low confidence
+    RadarEventConfidenceLow NS_SWIFT_NAME(low) = 1,
+    /// Medium confidence
+    RadarEventConfidenceMedium NS_SWIFT_NAME(medium) = 2,
+    /// High confidence
+    RadarEventConfidenceHigh NS_SWIFT_NAME(high) = 3
+};
+
+/**
+ The verification types for events.
+ */
+typedef NS_ENUM(NSInteger, RadarEventVerification) {
+    /// Accept event
+    RadarEventVerificationAccept NS_SWIFT_NAME(accept) = 1,
+    /// Unverify event
+    RadarEventVerificationUnverify NS_SWIFT_NAME(unverify) = 0,
+    /// Reject event
+    RadarEventVerificationReject NS_SWIFT_NAME(reject) = -1
+};
+
+/**
+ The Radar ID of the event.
+ */
+@property (nonnull, copy, nonatomic, readonly) NSString *_id;
+
+/**
+ The datetime when the event occurred on the device.
+ */
+@property (nonnull, copy, nonatomic, readonly) NSDate *createdAt;
+
+/**
+ The datetime when the event was created on the server.
+ */
+@property (nonnull, copy, nonatomic, readonly) NSDate *actualCreatedAt;
+
+/**
+ A boolean indicating whether the event was generated with your live API key.
+ */
+@property (assign, nonatomic, readonly) BOOL live;
+
+/**
+ The type of the event.
+ */
+@property (assign, nonatomic, readonly) RadarEventType type;
+
+/**
+ The name of the conversion event. This will only be set if the `type` is `RadarEventTypeConversion`.
+ */
+@property (nullable, copy, nonatomic, readonly) NSString *conversionName;
+
+/**
+ The geofence for which the event was generated. May be `nil` for non-geofence events.
+ */
+@property (nullable, strong, nonatomic, readonly) RadarGeofence *geofence;
+
+/**
+ The place for which the event was generated. May be `nil` for non-place events.
+ */
+@property (nullable, strong, nonatomic, readonly) RadarPlace *place;
+
+/**
+ The region for which the event was generated. May be `null` for non-region events.
+ */
+@property (nullable, strong, nonatomic, readonly) RadarRegion *region;
+
+/**
+ The beacon for which the event was generated. May be `nil` for non-beacon events.
+ */
+@property (nullable, strong, nonatomic, readonly) RadarBeacon *beacon;
+
+/**
+ The trip for which the event was generated. May be `nil` for non-trip events.
+ */
+@property (nullable, strong, nonatomic, readonly) RadarTrip *trip;
+
+/**
+ The fraud checks for which the event was generated. May be `nil` for non-fraud events.
+ */
+@property (nullable, strong, nonatomic, readonly) RadarFraud *fraud;
+
+/**
+ For place entry events, alternate place candidates. May be `nil` for non-place events.
+ */
+@property (nullable, strong, nonatomic, readonly) NSArray<RadarPlace *> *alternatePlaces;
+
+/**
+ For accepted place entry events, the verified place. May be `nil` for non-place events or unverified events.
+ */
+@property (nullable, strong, nonatomic, readonly) RadarPlace *verifiedPlace;
+
+/**
+ The verification of the event.
+ */
+@property (assign, nonatomic, readonly) RadarEventVerification verification;
+
+/**
+ The confidence level of the event.
+ */
+@property (assign, nonatomic, readonly) RadarEventConfidence confidence;
+
+/**
+ The duration between entry and exit events, in minutes, for exit events. 0 for entry events.
+ */
+@property (assign, nonatomic, readonly) float duration;
+
+/**
+ The location of the event.
+ */
+@property (nonnull, strong, nonatomic, readonly) CLLocation *location;
+
+/**
+ A boolean indicating whether the event came from a replayed location.
+ */
+@property (assign, nonatomic, readonly) BOOL replayed;
+
+/**
+ The metadata of the event. Present on conversion events only.
+ */
+@property (nonnull, copy, nonatomic, readonly) NSDictionary *metadata;
+
++ (NSString *_Nullable)stringForType:(RadarEventType)type;
++ (NSArray<NSDictionary *> *_Nullable)arrayForEvents:(NSArray<RadarEvent *> *_Nullable)events;
+- (NSDictionary *_Nonnull)dictionaryValue;
+
+@end