LocationsDataApi class

Constructors

LocationsDataApi.new(Dio _dio, Serializers _serializers)

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

deleteLocations({required BuiltList<String> locations, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<DeleteResponseWrapper>>

Delete Several Locations Delete several locations identified by their uberall unique ids. Locations can be deleted only if they are inactivated (status = INACTIVE) and are no longer billed (endDate < now).

getLocations({String? businessId, BuiltList<String>? businessIds, BuiltList<String>? cities, String? classification, BuiltList<String>? countries, DateTime? endDateMax, DateTime? endDateMin, BuiltList<String>? excludedLocationIds, String? facebookStatus, String? fieldMask, String? googleDirectoryStatus, String? googleStatus, BuiltList<String>? groupIds, BuiltList<String>? groups, String? identifier, BuiltList<String>? labels, BuiltList<String>? locationIds, int? max, BuiltList<String>? missingDirectoryField, bool? needsReview, int? offset, String? order, BuiltList<String>? postcodes, BuiltList<String>? provinces, String? query, BuiltList<String>? queryFields, bool? selectAll, String? sort, String? status, bool? syncNeeded, bool? syncStarted, bool? temporarilyClosed, JsonObject? body, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<LocationSearchResponseWrapper>>

Get Several Locations Get locations managed by the current API user. Some fields are omitted (such as paymentOptions and services). For a full list use the GET/api/locations/$id endpoint.

getLocationsAvailableLodgingFields({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<LodgingFieldResponseWrapper>>

Get the available amenities (Google Lodging) fields for a location Get the list of all available amenities (Google Lodging) fields.

getLocationsCities({BuiltList<String>? locationIds, BuiltList<String>? businessIds, BuiltList<String>? postcodes, BuiltList<String>? countries, BuiltList<String>? provinces, String? query, int? max, int? offset, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<CitiesResponseWrapper>>

Get the city for locations Get the location''s city

getLocationsCountries({required String businessIds, int? max, int? offset, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<CountriesResponseWrapper>>

Get the country for locations Get the country for each location

getLocationsDirectories({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<DirectoriesResponseWrapper>>

Get the directories for locations Get the directories for a location

getLocationsId({required String id, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<LocationResponseWrapper>>

Get a Location Get all information about a specific location, including listing statuses

getLocationsIdDashboard({required String id, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<LocationDashboardResponseWrapper>>

Get a Location''s Dashboard Get all necessary information to build a location''s dashboard

getLocationsIdDatapoints({required String id, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<InboxResponseWrapper>>

DEPRECATED - Get Location''s Data Points Deprecated. Use https://uberall.com/en/developers/apiDocumentation#_api_data-points-GET instead.

getLocationsIdDatapointsStatistics({required String id, BuiltList<String>? dataPointTypes, BuiltList<String>? directoryTypes, BuiltList<String>? ratings, String? minActionDate, String? maxActionDate, String? minThreadActionDate, String? maxThreadActionDate, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<DatapointStatisticsResponseWrapper>>

DEPRECATED - Get Location''s Data Point Statistics Deprecated. Use https://uberall.com/en/developers/apiDocumentation#_api_data-points_statistics-GET instead.

getLocationsIdVisibilityIndexes({required String id, String? days, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<VisibilityIndexWrapper>>

Get Location''s Visibility Index Get the latest location''s visibility index

getLocationsIdVisibilityIndexesInteresting({required String id, Date? startDate, Date? endDate, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<VisibilityIndexesWrapper>>

Get Historical Visibility Index Get a Visibility Index time series. Only days where the Visibility Index changed will be returned

getLocationsKeywords({BuiltList<String>? locationIds, BuiltList<String>? businessIds, BuiltList<String>? excludedLocationIds, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<KeywordsWrapper>>

Get the keywords for locations Get the keywords for locations

getLocationsLabels({String? query, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<LabelsResponseWrapper>>

Get the labels for locations Get the labels assigned to a location

getLocationsPostcodes({BuiltList<String>? locationIds, BuiltList<String>? businessIds, BuiltList<String>? countries, BuiltList<String>? provinces, BuiltList<String>? cities, String? query, int? max, int? offset, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<PostcodesResponseWrapper>>

Get the post / zip code for locations Get the post / zip code assigned to a location

getLocationsProvinces({BuiltList<String>? businessIds, BuiltList<String>? countries, String? query, int? max, int? offset, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<ProvincesResponseWrapper>>

Get the province/state for locations Get a list of provinces/states, for locations available to the user, with filtering on businesses, countries, or a search text

getLocationsStatistics({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<LocationStatisticsResponse>>

Get Locations'' Statistics Get statistics about the locations the current user is managing: total and breakdown by status

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patchLocations({required BuiltList<Location> location, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<UpdateResponseWrapper>>

Update Several Locations Make changes to a list of locations. Any blank parameter deletes an old value, any unspecified parameter does nothing

patchLocationsId({required String id, required Location location, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<LocationWrapper>>

Update a Location Make changes to a location. Any blank parameter deletes an old value, any unspecified parameter does nothing

patchLocationsIdEvDataUid({required String id, required String uid, required String status, required String body, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<EvDynamicDataWrapper>>

Update EV Dynamic Data Update EV Charging data for a given EV Charging Station.

postLocations({required Location location, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<LocationWrapper>>

Create a Location Create a location and add it to an existing business

postLocationsIdSync({required String id, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<LocationWrapper>>

Sync a Location Start a sync on all directories for a specific location

postLocationsSync({JsonObject? body, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<UberallResponse>>

Sync Several Locations Start a sync on all directories for several locations identified by their unique uberall id

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited