Initializes the cartography domain
The connector to interact with the API
Creates a new building in the API.
The building information used to create it.
Promise
Creates a new floor
The floor information used to create it
Promise
Creates a new geofence.
The geofence information used to create it.
Promise
Creates a new POI
The poi information used to create it
Promise
Creates a new POI category.
The form data for the POI category to be created.
Promise
Creates an array of POIs in bulk.
An array of POI objects to create.
Promise<Poi[]> A Promise that resolves to an array of created POIs.
Deletes a building given its id
The building id to delete
Promise
Deletes a floor given its ID.
The ID of the floor to delete
Promise
Deletes a geofence by its ID.
The ID of the geofence to delete.
Promise
Deletes the GeoJSON for a building.
The ID of the building
Resolves when deletion completes
Deletes a POI given its id.
The POI id to delete.
Promise
Deletes a POI category.
The ID of the POI category to delete.
void A Promise that resolves when the deletion is successful.
Deletes an array of POIs in batch.
An array of POI ids to delete.
Promise<void[]> A Promise that resolves to void.
Returns the building information for a given ID.
The ID of the building to fetch.
Optionalparams: { view?: "compact" } = {}The parameters for the request.
Optionalview?: "compact"The view of the building.
Promise
Retrieves a list of buildings.
The parameters for the request.
Optionalview?: "compact"The view of the buildings.
Promise<readonly BuildingListElement[]> - A promise that resolves to a list of building list elements.
Retrieves the current organization from the API.
Promise
Retrieves a floor by its ID.
The ID of the floor to retrieve
Promise
Returns a list of floors given a search criteria
the list of parameters to filter the response
Promise<readonly Floor[]> A promise that resolves to a list of floors
Retrieves a geofence by its ID.
The ID of the geofence to retrieve.
Promise
Retrieves a paginated list of geofences based on the provided search parameters. If no organizationId is provided in the search parameters, it retrieves the organizationId from the JWT.
Optionalparams: GeofenceSearch = {}The search parameters for the geofences.
Promise<Paginated
Retrieves paths based on the provided parameters.
The search parameters for fetching paths.
Promise<Paths[]> - A Promise that resolves to an array of paths.
Retrieves a list of POI categories.
Promise<PoiCategory[]> A Promise that resolves to an array of POICategory objects.
Retrieves a list of Poi objects based on the provided search parameters.
Optionalparams: PoiSearch = {}Optional search parameters to filter the Poi objects.
Promise<Poi[]> - A Promise that resolves to an array of Poi objects.
Updates a building given its id and the information to update
the building id to update
the building information to use
Promise
Updates a floor given its id and the information to update
the floor id to update
the floor information to use
Promise
Updates a geofence with the specified ID using the provided data.
The ID of the geofence to update.
The partial data to update the geofence with.
Promise
Updates a POI (Point of Interest) with the given ID using the provided form data.
The ID of the POI to update.
The form data containing the updated POI information.
Promise
Patches a POI category.
The ID of the POI category to patch.
The partial POI category form.
Promise
Updates an array of POIs in bulk.
An array of POI update forms.
Promise<Poi[]> An array of Promises that resolves to an array of updated POIs or reject if the update has failed.
Uploads a GeoJSON for a building.
Upload configuration
Resolves when upload completes
Uploads a GeoJSON theme configuration for a building.
Upload configuration
Resolves when upload completes
Service that exposes the cartography domain.
Represents the CartographyAPI class that provides methods for listing/creating/updating/deleting buildings, floors, geofences, POIs, paths, and POI categories.