Package-level declarations

Types

Link copied to clipboard
data class AnalyticsEvent(val guid: String, val eventName: String, val occurredAt: String, val projectId: Int?, val orderId: Int?, val promotionId: Int?, val shortLinkId: Int?, val siteId: Int?, val data: Map<String, String>)
Link copied to clipboard
data class AnalyticsEventsData(val appInstanceId: String, val events: List<AnalyticsEvent>)
Link copied to clipboard
data class AndroidPickupLocationFilter(val proximityToSite: Int = -1, val intervalSeconds: Float? = null, val priority: String? = null, val smallestDisplacement: Float? = null)
Link copied to clipboard
data class AppData(val upgrade: AppUpgrade? = null, val nearbySitesFeatureUrl: String? = null, val pickupLocationFilters: PickupLocationFilters? = null, val pickupStates: PickupStates? = null, val notifyMaxSites: Int? = null, val notifyConfig: NotifyConfig? = null, val wrongSiteArrivalConfig: WrongSiteArrivalConfig? = null, val etaSettings: ETASettings? = null, val placesConfig: PlacesConfig? = null, val pushServiceType: String? = null, val pushTopics: ArrayList<PushTopic>? = null, val nearbySitesDefaultSearchRadius: Float? = null, val onSiteDetectionConfig: OnSiteDetectionConfig? = null)
Link copied to clipboard
data class AppInstanceResponse(val minSyncIntervalSeconds: Long = 0, val data: AppData)
Link copied to clipboard
data class AppUpgrade(val required: Boolean? = null, val url: String? = null, val version: String? = null, val message: String? = null)
Link copied to clipboard
data class Area(val id: Int, val siteId: Int, val name: String, val coordinates: List<List<Double>>?, val pickupTypes: List<String>?)
Link copied to clipboard
data class AvailableCustomerRatingCategory(val customerRatingCategory: String, val customerRatingLocalizedString: String)
Link copied to clipboard
data class AvailableHandoffVehicleLocation(val vehicleLocation: String, val vehicleLocationLocalizedString: String)
Link copied to clipboard
data class AvailableTransportMode(val transportMode: String, val transportModeLocalizedString: String)
Link copied to clipboard
class Beacon(val uuid: UUID, val major: UInt, val minor: UInt, val rssi: Float, val distance: Float)
Link copied to clipboard
data class BeaconRegion(val uuid: UUID, val major: Int?, val minor: Int?)
Link copied to clipboard
data class ClaimOrderRequestData(val customerName: String, val customerCarType: String?, val customerCarColor: String?, val customerLicensePlate: String?, val customerPhone: String?, val customerPushToken: String?, val pickupType: String?, val deferredLocationTrackingEnabled: Boolean?, val spotIdentifier: String?, val handoffVehicleLocation: String?, val loyaltyProvider: String?, val loyaltyIdentifier: String?, val transportMode: String?)
Link copied to clipboard
data class CreateOrderRequestData(val siteId: Int, val customerName: String, val customerToken: String?, val customerCarType: String?, val customerCarColor: String?, val customerLicensePlate: String?, val customerPhone: String?, val partnerId: String?, val customerPushToken: String?, val pickupWindow: String?, val state: String?, val pickupType: String?, val deferredLocationTrackingEnabled: Boolean?, val spotIdentifier: String?, val handoffVehicleLocation: String?, val partnerIdentifierForCustomer: String?, val partnerIdentifierForCrew: String?, val disableOrderFire: Boolean?, val disableDisablePromiseTimeScheduling: Boolean?, val orderFireMakeIntervalSeconds: Int?, val loyaltyProvider: String?, val loyaltyIdentifier: String?, val transportMode: String?)
Link copied to clipboard
data class Customer(val id: Int, val apiToken: String, val createdAt: String, val updatedAt: String, val deletedAt: String, val email: String? = null, val name: String, val phone: String? = null, val carType: String? = null, val carColor: String? = null, val licensePlate: String? = null)
Link copied to clipboard
data class CustomerData(val name: String, val phone: String? = null, val carType: String? = null, val carColor: String? = null, val licensePlate: String? = null, val termsOfService: Boolean, val ageVerification: Boolean)
Link copied to clipboard
data class CustomerResponse(val data: Customer? = null)
Link copied to clipboard
data class ErrorResponse(val errors: Map<String, List<String>>?, val error: String?)
Link copied to clipboard
data class ETASettings(val minimumETACacheInterval: Int? = null, val cacheFilterETASecondsMultiplier: Double? = null)
Link copied to clipboard
data class Geofence(val latitude: String, val longitude: String, val radiusMeters: Float)
Link copied to clipboard
Link copied to clipboard
data class GetNotifyNotificationsResponse(val minSyncIntervalSeconds: Long = 0, val data: List<NotifyNotification>? = null, val included: GetNotifyNotificationsIncluded?)
Link copied to clipboard
data class GetOrdersResponse(val data: List<Order>? = null, val included: OrdersIncluded? = null)
Link copied to clipboard
data class GetSitesResponse(val data: List<Site>? = null, val pages: Pages, val included: SitesIncluded? = null)
Link copied to clipboard
data class LoginRequestData(val email: String, val password: String)
Link copied to clipboard
data class NotifyAreaOfInterest(val id: Int, val beaconMajor: Int)
Link copied to clipboard
data class NotifyCampaign(val id: Int, val regionType: NotifyCampaignRegionType, val startDay: String, val endDay: String, val repeatIntervalDays: Long?, val geofenceRadiusMeters: Int?, val content: NotifyCampaignContent, val deferOnPickup: Boolean, val beaconUUID: String?, val beaconMajor: Int?)
Link copied to clipboard
data class NotifyCampaignContent(val notification: NotifyCampaignNotification, val deepLinkUrl: String?, val metadata: JsonElement?)
Link copied to clipboard
Link copied to clipboard
data class NotifyConfig(val defaultGeofenceRadiusMeters: Int, val defaultSiteSearchRadiusMeters: Int, val analyticsEventLimit: Int, val sitesFetchLatitudePrecision: Int?, val sitesFetchLongitudePrecision: Int?)
Link copied to clipboard
data class NotifyEvent(val guid: String, val name: String, val occurredAt: String, val campaignId: Int, val params: Map<String, String>)
Link copied to clipboard
data class NotifyEventData(val appInstanceId: String, val events: List<NotifyEvent>)
Link copied to clipboard
data class NotifyNotification(val campaignId: Int, val siteId: Int?, val content: NotifyNotificationContent)
Link copied to clipboard
data class NotifyNotificationContent(val notification: NotifyCampaignNotification, val deepLinkUrl: String?, val metadata: JsonElement?)
Link copied to clipboard
data class NotifySite(val id: Int, val distanceMeters: String, val latitude: String, val longitude: String, val beaconMinor: Int?)
Link copied to clipboard
data class OneSignalTopic(val tagKey: String, val tagValue: String)
Link copied to clipboard
data class OnSiteDetectionConfig(val apiCacheSeconds: Long?, val apiCacheDistanceMeters: Double?, val premisesPercentOverlap: Double?, val areaPercentOverlap: Double?)
Link copied to clipboard
data class Order(val id: Int, val orderState: String, val type: String?, val customerState: String, val arrivedAt: String?, val createdAt: String, val updatedAt: String?, val redeemedAt: String?, val redemptionCode: String?, val etaAt: String?, val partnerIdentifier: String?, val partnerIdentifierForCustomer: String?, val partnerIdentifierForCrew: String?, val displayName: String?, val displayDetail: String?, val siteId: Int, val sitePartnerId: String?, val siteName: String?, val sitePhone: String?, val siteStreetAddress: String?, val siteFullAddress: String?, val siteLocality: String?, val siteRegion: String?, val siteCountry: String?, val sitePostalCode: String?, val siteLongitude: String?, val siteLatitude: String?, val siteInstructions: String?, val siteDescription: String?, val siteCoverPhotoURL: String?, val siteBeaconRegions: List<BeaconRegion>?, val siteWrongSiteArrivalRadius: Double?, val projectAccentColor: String?, val projectAccentTextColor: String?, val projectLogoURL: String?, val pickupWindow: String?, val pickupType: String?, val customerId: String?, var customerName: String?, var customerCarType: String?, var customerCarColor: String?, var customerLicensePlate: String?, val customerRatingValue: Int?, val customerRatingComments: String?, val pushToken: String?, val projectMobileFlowAlwaysShowVehicleInfoFields: Boolean, val projectMobileFlowCustomerNameEditingEnabled: Boolean, val projectMobileFlowPickupTypeSelectionEnabled: Boolean, val projectMobileFlowRequireVehicleInfoIfVisible: Boolean, val curbsideLocalizedString: String?, val pickupLocalizedString: String?, val locationTrackingEnabled: Boolean, val spotIdentifier: String?, val spotIdentifierEntryEnabled: Boolean = true, val spotIdentifierInputType: String?, val wrongSiteDetectionEnabled: Boolean, val distanceFilteringDisabled: Boolean, val wrongSiteSearchRadius: Double?, val siteOperationalStatus: String?, val sitePrearrivalSeconds: Int?, val pickupConfigId: Int?, val wrongSiteId: Int?, val handoffVehicleLocation: String?, val estimatedReadyAt: String?, val orderFiredAt: String?, val loyaltyProvider: String?, val loyaltyIdentifier: String?, val orderStatusLiveActivityEnabled: Boolean, val transportMode: String?, val customerRatingCategories: List<String>?, val estimatedReadyWindow: String?)
Link copied to clipboard
data class OrderEventRequestData @ExperimentalUnsignedTypes constructor(val orderId: Int, val eventType: OrderEventType, val longitude: Double? = null, val latitude: Double? = null, val accuracy: Float? = null, val speed: Float? = null, val etaSeconds: Int? = null, val customerState: String? = null, val beacons: List<Beacon>? = null, val locationPermission: LocationPermissionState? = null, val state: String? = null, val customerRatingValue: Int? = null, val customerRatingComments: String? = null, val spotIdentifier: String? = null, val possibleWrongSiteId: Int? = null, val etaSource: String? = null, val locationAt: String? = null, val pickupType: String? = null, val customerCarColor: String? = null, val customerCarType: String? = null, var customerLicensePlate: String?, val handoffVehicleLocation: String?, val transportMode: String? = null, val customerRatingCategories: List<String>? = null)
Link copied to clipboard
data class OrderProgressState(val state: String, val stateLocalizedString: String)
Link copied to clipboard
data class OrderResponse(val data: Order? = null, val included: OrdersIncluded? = null)
Link copied to clipboard
data class OrdersIncluded(val pickupConfigs: List<PickupConfig>?, val premises: List<Premises>?, val areas: List<Area>?)
Link copied to clipboard
data class OrderStatusStrings(val orderNumber: String?, val readyAt: String?, val ready: String?, val finishingUp: String?)
Link copied to clipboard
data class Pages(val next: String?, val previous: String?, val current: Int, val count: Int, val per: Int)
Link copied to clipboard
data class PatchAppInstanceData(val pushToken: String?, val timeZone: String?, val subscribedPushTopicIds: List<Long>?)
Link copied to clipboard
data class PickupConfig(val type: String, val id: Int, val customerNameEditingEnabled: Boolean, val pickupTypeSelectionEnabled: Boolean, val askToAskImageUrl: String?, val projectAccentColor: String?, val projectAccentTextColor: String?, val termsOfServiceUrl: String?, val privacyPolicyUrl: String?, val availablePickupTypes: List<PickupTypeConfig>?, val availableHandoffVehicleLocations: List<AvailableHandoffVehicleLocation>?, val orderProgressStates: List<OrderProgressState>?, val customerFeedbackEnabled: Boolean, val defaultTransportMode: String?, val availableTransportModes: List<AvailableTransportMode>?, val availableCustomerRatingCategories: List<AvailableCustomerRatingCategory>?, val orderStatusStrings: OrderStatusStrings? = null)

Data model for pickup config options for an order or site.

Link copied to clipboard
data class PickupLocationFilters(val android: List<AndroidPickupLocationFilter>? = null, val androidBiking: List<AndroidPickupLocationFilter>? = null, val androidWalking: List<AndroidPickupLocationFilter>? = null)
Link copied to clipboard
data class PickupStates(val order: List<String>, val customer: List<String>, val orderOpen: List<String>, val customerOpen: List<String>, val orderDeferred: List<String>, val customerDeferred: List<String>)
Link copied to clipboard
data class PickupTypeConfig(val pickupType: String, val pickupTypeLocalizedString: String, val showVehicleInfoFields: Boolean, val requireVehicleInfo: Boolean, val showHandoffVehicleLocations: Boolean)

Data model for pickup type configs for an order or site.

Link copied to clipboard
data class PlacesConfig(val mapboxAccessToken: String, val suggestionRequestDelayMillis: Long)
Link copied to clipboard
data class Premises(val siteId: Int, val premises: List<List<Double>>)
Link copied to clipboard
data class PushServicesTopics(val fcmTopic: String, val airshipTag: String, val oneSignal: OneSignalTopic)
Link copied to clipboard
data class PushTopic(val id: Long, val type: String, val topic: String, val timeZone: String?, val pushServicesTopics: PushServicesTopics)
Link copied to clipboard
Link copied to clipboard
data class SetNewPasswordRequestData(val resetPasswordToken: String, val password: String, val confirmation: String)
Link copied to clipboard
data class SignUpRequestData(val email: String, val password: String, val passwordConfirmation: String)
Link copied to clipboard
data class Site(val type: String?, val id: Int, val partnerIdentifier: String?, val name: String?, val fullAddress: String?, val streetAddress: String?, val locality: String?, val region: String?, val country: String?, val postalCode: String?, val longitude: String?, val latitude: String?, val instructions: String?, val description: String?, val coverPhotoURL: String?, val phone: String?, val displayName: String?, val projectAccentColor: String?, val projectAccentTextColor: String?, val projectLogoURL: String?, val geofence: Geofence?, val wrongSiteArrivalRadius: Double?, val operationalStatus: String?, val prearrivalSeconds: Int?, val pickupConfigId: Int?, val distanceMeters: Int?)
Link copied to clipboard
data class SitesIncluded(val pickupConfigs: List<PickupConfig>?, val premises: List<Premises>?, val areas: List<Area>?)
Link copied to clipboard
data class UpdateCustomerRequestData(val name: String, val phone: String? = null, val carType: String? = null, val carColor: String? = null, val licensePlate: String? = null)
Link copied to clipboard
data class UpdateOrderRequestData(val siteId: Int, val customerName: String? = null, val customerPhone: String? = null, val customerCarColor: String? = null, val customerCarType: String? = null, val partnerIdentifier: String? = null, val pushToken: String? = null)
Link copied to clipboard
data class WrongSiteArrivalConfig(val siteLimit: Int?, val worstAccuracyLimit: Double?, val sitesFetchLatitudePrecision: Int?, val sitesFetchLongitudePrecision: Int?)