Package-level declarations

Types

Link copied to clipboard
data class BeaconRegion @ExperimentalUnsignedTypes constructor(val uuid: UUID, val major: Int?, val minor: Int?, val orderId: Int)

Data model for beacon regions for pickup zones.

Link copied to clipboard
class Customer

Data model for customers

Link copied to clipboard
class Order(appAuthId: String, id: Int, type: String?, createdAt: Instant, arrivedAt: Instant?, updatedAt: Instant, redeemedAt: Instant?, customerState: String, state: String, etaAt: Instant?, displayName: String?, displayDetail: String?, partnerIdentifier: String?, partnerIdentifierForCustomer: String?, partnerIdentifierForCrew: String?, redemptionCode: String?, customerId: String?, pickupWindow: PickupWindow?, pickupType: String?, site: Site, customer: CustomerInfo, customerRatingValue: Int?, customerRatingComments: String?, pushToken: String?, alwaysShowVehicleInfoFields: Boolean, customerNameEditingEnabled: Boolean, pickupTypeSelectionEnabled: Boolean, requireVehicleInfoIfVisible: Boolean, curbsideLocalizedString: String?, pickupLocalizedString: String?, locationTrackingEnabled: Boolean, projectAccentColor: String?, projectAccentTextColor: String?, spotIdentifier: String?, spotIdentifierEntryEnabled: Boolean, spotIdentifierInputType: InputType, wrongSiteDetectionEnabled: Boolean, distanceFilteringDisabled: Boolean, wrongSiteSearchRadius: Double = WRONG_SITE_SEARCH_RADIUS, wrongSiteId: Int?, handoffVehicleLocation: String?, estimatedReadyAt: Instant?, orderFiredAt: Instant?, loyaltyProvider: String?, loyaltyIdentifier: String?, orderStatusLiveActivityEnabled: Boolean, transportMode: String, customerRatingCategories: List<String>?, estimatedReadyWindow: PickupWindow?)

Data model for orders.

Link copied to clipboard
class PickupWindow(val start: Instant, val end: Instant)

Data model for a pickup window for an order.

Link copied to clipboard
class Site(val appAuthId: String, val id: Int, val name: String?, val phone: String?, val streetAddress: String?, val fullAddress: String?, val locality: String?, val region: String?, val country: String?, val postalCode: String?, val latitude: String?, val longitude: String?, val coverPhotoUrl: String?, val iconUrl: String?, val instructions: String?, val description: String?, val partnerIdentifier: String? = null, val geofence: CircularRegion? = null, val wrongSiteArrivalRadius: Double, val operationalStatus: String, val prearrivalSeconds: Int, val pickupConfig: PickupConfig, var distanceMeters: Int?)

Data model for sites.

Properties

Link copied to clipboard

Convenience extension property for getting CustomerInfo from order.

Functions

Link copied to clipboard

Returns if an order is open.

Returns open orders from a list of orders.

Link copied to clipboard

Extension function for provided a formatted string for a PickupWindow in the provided locale.