Waze Map Editor JavaScript SDK

https://www.waze.com/editor/sdk/
Admin
The Waze Map Editor (WME) JavaScript SDK provides a seamless way to execute community userscripts...
Tokens:86,721
Snippets:810
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install SDK Type Definitions

Source: https://www.waze.com/editor/sdk/index.html

Use npm to install the SDK type definitions package as a development dependency.

```bash
npm install --save-dev https://web-assets.waze.com/wme_sdk_docs/production/latest/wme-sdk-typings.tgz
```

--------------------------------

### Venue Opening Hours Example

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.Venue.html

Illustrates how to define opening hours for a venue. It shows examples for setting hours for all days and specific days of the week.

```json
[
  { "days": [0, 1, 2, 3, 4, 5, 6], "fromHour": "09:00", "toHour": "17:00" },
  { "days": [5, 6], "fromHour": "09:00", "toHour": "22:00" }
]
```

--------------------------------

### Venue Image Example

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.Venue.html

An example of the structure for an image associated with a venue. This includes the date, ID, approval status, and URL of the image.

```json
[{
  "date": 1678886400000,
  "id": "12345678-90ab-cdef-1234-567890abcdef",
  "isApproved": true,
  "url": "https://www.example.com/image.jpg"
}]
```

--------------------------------

### Define Opening Hours for updateVenue

Source: https://www.waze.com/editor/sdk/classes/index.SDK.Venues.html

Example structure for the openingHours parameter in the updateVenue method.

```json
[
  { days: [0, 1, 2, 3, 4, 5, 6], fromHour: "09:00", toHour: "17:00" }, // Open every day 9am-5pm
  { days: [5, 6], fromHour: "09:00", toHour: "22:00" },             // Open weekends 9am-10pm
]
```

--------------------------------

### Tampermonkey @grant Configuration

Source: https://www.waze.com/editor/sdk/index.html

Examples of how @grant settings affect window access and the use of unsafeWindow.

```javascript
...  
// @grant none  
...  
window.SDK_INITIALIZED.then(initScript); // <- works fine!
```

```javascript
...  
// @grant GM_setClipboard  
...  
window.SDK_INITIALIZED.then(initScript); // <- fails with "Uncaught (in promise) TypeError: Cannot read properties of undefined (reading 'then')"
```

```javascript
...  
// @grant GM_setClipboard  
// @grant unsafeWindow  
...  
unsafeWindow.SDK_INITIALIZED.then(initScript); // <- works fine!
```

--------------------------------

### GET /BigJunctions/getAll

Source: https://www.waze.com/editor/sdk/classes/index.SDK.BigJunctions.html

Retrieves an array of all BigJunction objects currently present in the WME data model.

```APIDOC
## GET /BigJunctions/getAll

### Description
Retrieves an array of all BigJunction objects currently present in the WME data model.

### Method
GET

### Endpoint
/BigJunctions/getAll

### Response
#### Success Response (200)
- **BigJunction[]** (Array) - An array of all the bigJunctions in the WME data model

#### Response Example
[
  { "id": 123, "name": "Junction A" },
  { "id": 456, "name": "Junction B" }
]
```

--------------------------------

### Get Script Initialization Name

Source: https://www.waze.com/editor/sdk/classes/index.SDK.WmeSDK.html

Retrieves the name of the script used to initialize the SDK instance. This method is synchronous and returns a string.

```javascript
const scriptName = WmeSDK.getScriptName();
console.log(`SDK Script Name: ${scriptName}`);
```

--------------------------------

### GET /BigJunctions/getAllPossibleTurns

Source: https://www.waze.com/editor/sdk/classes/index.SDK.BigJunctions.html

Retrieves all possible turns for a specific big junction. Note that this operation may be computationally expensive.

```APIDOC
## GET /BigJunctions/getAllPossibleTurns

### Description
Retrieves all possible turns for a given bigJunction. Note: This calculation can sometimes take a significant amount of time to complete.

### Method
GET

### Endpoint
/BigJunctions/getAllPossibleTurns

### Parameters
#### Query Parameters
- **bigJunctionId** (number) - Required - The id of the bigJunction to find all possible turns for.

### Response
#### Success Response (200)
- **Turn[]** (Array) - All possible turns for the bigJunction

#### Error Handling
- **DataModelNotFoundError** - Thrown if the bigJunction is not found in the WME data model

#### Response Example
[
  { "from": 1, "to": 2, "type": "left" }
]
```

--------------------------------

### Get WME SDK Instance (JavaScript)

Source: https://www.waze.com/editor/sdk/functions/index.getWmeSdk.html

Retrieves an instance of the Waze Map Editor SDK. It takes an options object with `scriptId`, `scriptName`, and an optional `version`. Subsequent calls with the same `scriptId` return the same instance. Throws an `InvalidStateError` if a different version was previously requested for the same `scriptId`.

```javascript
/**
 * Get a reference to the WME SDK.
 * If preferred version not specified, returns the latest SDK.
 * Subsequent calls to this function with the same scriptId would return the same SDK instance.
 *
 * @param {object} options - SDK initialization options.
 * @param {string} options.scriptId - A unique id of the userscript.
 * @param {string} options.scriptName - Userscript display name.
 * @param {string} [options.version] - Preferred SDK version, optional.
 * @returns {WmeSDK} a reference to the WME SDK.
 * @throws {InvalidStateError} if another instance of the SDK had been requested with a different version.
 */
function getWmeSdk(options) {
  // Implementation details...
}
```

--------------------------------

### Get All Registered Shortcuts (JavaScript)

Source: https://www.waze.com/editor/sdk/classes/index.SDK.Shortcuts.html

The `getAllShortcuts` method retrieves an array of all currently registered keyboard shortcuts for the userscript. It returns an array of `KeyboardShortcut` objects.

```javascript
/**
 * Retrieves all registered shortcuts for the userscript.
 * @returns {KeyboardShortcut[]} An array of all registered shortcuts.
 */
const allShortcuts = Shortcuts.getAllShortcuts();
console.log(allShortcuts);
```

--------------------------------

### addClosure

Source: https://www.waze.com/editor/sdk/classes/index.SDK.TurnClosures.html

Adds a new turn closure to the WME data model. Requires details like description, start and end dates, and the associated turn ID. Optional parameters include permanence and a major traffic event ID.

```APIDOC
## addClosure

### Description
Adds a new turn closure to the WME data model.

### Method
addClosure

### Parameters
#### args: object
- **description** (string) - Required - The description of the turn closure.
- **endDate** (number) - Required - The end date of the turn closure as a Unix timestamp (milliseconds).
- **isPermanent** (boolean) - Optional - A flag to indicate if the closure should be auto finished when traffic is detected in the road. (defaults to false)
- **majorTrafficEventId** (string) - Optional - The id of the major traffic event associated with the turn closure.
- **startDate** (number) - Required - The start date of the turn closure as a Unix timestamp (milliseconds).
- **turnId** (string) - Required - The id of the turn that this closure applies to.

### Returns
TurnClosure - The newly created turn closure object.

### Throws
- DataModelNotFoundError: if the specified turn or its segments cannot be found in the data model.
- DataModelNotFoundError: if the majorTrafficEventId is provided and cannot be found in the data model.
- InvalidStateError: if the turn is not allowed.
```

--------------------------------

### Get WME Frontend Version

Source: https://www.waze.com/editor/sdk/classes/index.SDK.WmeSDK.html

Retrieves the current version of the Waze Map Editor frontend. This method is synchronous and returns a string representing the WME frontend version.

```javascript
const wmeVersion = WmeSDK.getWMEVersion();
console.log(`WME Frontend Version: ${wmeVersion}`);
```

--------------------------------

### Get User Info - JavaScript

Source: https://www.waze.com/editor/sdk/classes/index.SDK.WmeState.html

Fetches information about the currently logged-in user. If no user is logged in, it returns null. This method is part of the WmeState class and returns a UserSession object or null.

```javascript
WmeState.getUserInfo()
```

--------------------------------

### Get WME Backend Version

Source: https://www.waze.com/editor/sdk/classes/index.SDK.WmeSDK.html

Retrieves the current version of the Waze Map Editor backend. This method is asynchronous and returns a Promise that resolves to a string representing the WME backend version.

```javascript
WmeSDK.getWMEBackEndVersion().then(backendVersion => {
  console.log(`WME Backend Version: ${backendVersion}`);
});
```

--------------------------------

### wme-ready

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.SdkEvents.html

This event fires once after initialization, login, and initial map data loading are complete.

```APIDOC
## wme-ready

### Description
The event happens only once when the `wme-initialized`, `wme-logged-in`, and `wme-map-initial-data-loaded` had been dispatched.

### Event Payload
- `undefined`: This event does not carry a specific payload.
```

--------------------------------

### GET /BigJunctions/getById

Source: https://www.waze.com/editor/sdk/classes/index.SDK.BigJunctions.html

Retrieves a specific BigJunction object by its unique identifier.

```APIDOC
## GET /BigJunctions/getById

### Description
Retrieves a specific BigJunction object by its unique identifier.

### Method
GET

### Endpoint
/BigJunctions/getById

### Parameters
#### Query Parameters
- **bigJunctionId** (number) - Required - The id of the bigJunction to find.

### Response
#### Success Response (200)
- **BigJunction | null** (Object) - The bigJunction object if found, otherwise null

#### Response Example
{
  "id": 123,
  "name": "Main Intersection"
}
```

--------------------------------

### Initialize WME SDK

Source: https://www.waze.com/editor/sdk/index.html

Wait for the SDK initialization promise before calling getWmeSdk to access the API modules.

```javascript
// the sdk init function will be available after the SDK is initialized  
window.SDK_INITIALIZED.then(initScript);  
  
function initScript() {  
  // initialize the sdk with your script id and script name  
  const wmeSDK = getWmeSdk(  
      {scriptId: "your-userscript-id", scriptName: "Script Display Name"});  
  
  // Start using the SDK  
  const mapCenter = wmeSDK.Map.getMapCenter();  
  const topCountry = wmeSDK.DataModel.Countries.getTopCountry();  
  
  // query the WME data model  
  const mySegment = wmeSDK.DataModel.Segments.getById({segmentId: 123});  
  if (mySegment.isAtoB) {  
    // do something  
  }  
  
  // add new features  
  wmeSDK.DataModel.Venues.addVenue({category, geometry});  
  
  // save edits  
  wmeSDK.Editing.save().then(() => {  
    // edits saved  
  });  
  
  // register to events  
  wmeSDK.Events.once({ eventName: "wme-ready" }).then(() => { ... });  
  wmeSDK.Events.on({  
    eventName: "wme-map-move",  
    eventHandler: () => { ... }  
  });  
  wmeSDK.Events.on({  
    eventName: "wme-map-data-loaded",  
    eventHandler: () => { ... }  
  });  
  wmeSDK.Events.on({  
    eventName: "wme-selection-changed",  
    eventHandler: () => { ... }  
  });  
}
```

--------------------------------

### Import and Use SDK Types

Source: https://www.waze.com/editor/sdk/index.html

Import SDK types for TypeScript support and initialize the SDK instance after verifying availability.

```typescript
import { KeyboardShortcut, WmeSDK } from "wme-sdk-typings";  
  
if (!window.getWmeSdk) {  
  throw new Error("SDK not available");  
}  
const sdk: WmeSDK = window.getWmeSdk({ scriptId: "test", scriptName: "test" });  
  
const shortcut: KeyboardShortcut = {  
  callback: () => {  
    console.log("Hello world!");  
  },  
  description: "test shortcut",  
  shortcutId: "test-shortcut",  
  shortcutKeys: "A+l",  
};  
sdk.Shortcuts.createShortcut(shortcut);
```

--------------------------------

### wme-editing-house-numbers

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.SdkEvents.html

This event was used to indicate the start or stop of house number editing but is now deprecated.

```APIDOC
## wme-editing-house-numbers

### Description
This event for house number editing start/stop is no longer active, use `wme-map-house-number-marker-added` instead.

### Event Payload
- **isEditingHouseNumbers** (boolean) - Indicates if house number editing is active.
```

--------------------------------

### wme-initialized

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.SdkEvents.html

This event fires when the WME has fully initialized its internal components and rendered the UI.

```APIDOC
## wme-initialized

### Description
The event happens when WME initialized the `window.W` global object and its internals and rendered the UI. Note: at this point the map data hasn't been fetched yet.

### Event Payload
None
```

--------------------------------

### SDK Initialization Error

Source: https://www.waze.com/editor/sdk/index.html

The common error encountered when the SDK is accessed before it is fully initialized.

```javascript
window.SDK_INITIALIZED.then(initScript); // <- "Uncaught (in promise) TypeError: Cannot read properties of undefined (reading 'then')"
```

--------------------------------

### GET /MajorTrafficEvents/getById

Source: https://www.waze.com/editor/sdk/classes/index.SDK.MajorTrafficEvents.html

Retrieves a specific major traffic event by its unique identifier.

```APIDOC
## GET /MajorTrafficEvents/getById

### Description
Finds and returns a specific major traffic event based on the provided ID.

### Method
GET

### Endpoint
/MajorTrafficEvents/getById

### Parameters
#### Query Parameters
- **majorTrafficEventId** (string) - Required - The unique identifier of the major traffic event.

### Response
#### Success Response (200)
- **event** (MajorTrafficEvent | null) - The major traffic event object, or null if no event matches the provided ID.

#### Response Example
{
  "id": "event_123",
  "type": "construction"
}
```

--------------------------------

### Handling DOMContentLoaded Initialization

Source: https://www.waze.com/editor/sdk/index.html

Wrap initialization logic in a DOMContentLoaded event listener to ensure the SDK is ready.

```javascript
document.addEventListener("DOMContentLoaded", () => {  
  window.SDK_INITIALIZED.then(initScript); // <- works fine!  
});
```

--------------------------------

### wme-ready

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.SdkEvents.html

The event is triggered when the WME is ready to be used.

```APIDOC
## wme-ready

### Description
The event is triggered when the WME is ready to be used.

### Event Payload
This event does not have a payload.
```

--------------------------------

### GET /cities

Source: https://www.waze.com/editor/sdk/classes/index.SDK.Cities.html

Retrieves all cities or specific cities based on filters.

```APIDOC
## GET /cities

### Description
Retrieves a list of all cities or finds a specific city by ID or name.

### Methods
- **getAll()**: Returns an array of all cities.
- **getById(cityId)**: Finds a city by its unique ID.
- **getCity(cityName, countryId, stateId)**: Finds a city by name and optional location context.
- **getTopCity()**: Returns the city with the majority of segments.

### Parameters
#### Query Parameters
- **cityId** (number) - Required for getById - The ID of the city.
- **cityName** (string) - Required for getCity - The name of the city.

### Response
#### Success Response (200)
- **City[] | City | null** - Returns an array, a single object, or null if not found.
```

--------------------------------

### Get Layer Z-Index

Source: https://www.waze.com/editor/sdk/classes/index.SDK.Map.html

Retrieves the z-index value of a specified map layer.

```APIDOC
## POST /websites/waze_editor_sdk/getLayerZIndex

### Description
Retrieves the z-index value of a specified map layer.

### Method
POST

### Endpoint
/websites/waze_editor_sdk/getLayerZIndex

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **args** (object) - Required - An object containing the layer name.
  - **layerName** (string) - Required - The name of the layer to get the z-index for.

### Request Example
```json
{
  "args": {
    "layerName": "my_layer"
  }
}
```

### Response
#### Success Response (200)
- **number** - The map layer's z-index value.

#### Response Example
```json
10
```
```

--------------------------------

### wme-initialized

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.SdkEvents.html

The event is triggered when the WME SDK has been initialized.

```APIDOC
## wme-initialized

### Description
The event is triggered when the WME SDK has been initialized.

### Event Payload
This event does not have a payload.
```

--------------------------------

### getAll

Source: https://www.waze.com/editor/sdk/classes/index.SDK.Venues.html

Retrieves all venues in the WME data model.

```APIDOC
## getAll(): Venue[]

### Description
Retrieves all venues in the WME data model.

### Returns
- **Venue[]** - an array of all the venues in the WME data model
```

--------------------------------

### GET /restricted-driving-areas/{id}

Source: https://www.waze.com/editor/sdk/classes/index.SDK.RestrictedDrivingAreas.html

Retrieves a specific restricted driving area by its unique identifier.

```APIDOC
## GET /restricted-driving-areas/{restrictedDrivingAreaId}

### Description
Finds and returns a specific restricted driving area by its ID, or null if it does not exist.

### Method
GET

### Endpoint
/restricted-driving-areas/{restrictedDrivingAreaId}

### Parameters
#### Path Parameters
- **restrictedDrivingAreaId** (number) - Required - The unique identifier of the restricted driving area.

### Response
#### Success Response (200)
- **data** (RestrictedDrivingArea | null) - The restricted driving area object or null.

#### Response Example
{
  "id": 123,
  "name": "Restricted Zone A"
}
```

--------------------------------

### Get Layer Opacity

Source: https://www.waze.com/editor/sdk/classes/index.SDK.Map.html

Retrieves the current opacity level of a specified map layer.

```APIDOC
## POST /websites/waze_editor_sdk/getLayerOpacity

### Description
Get map layer opacity level.

### Method
POST

### Endpoint
/websites/waze_editor_sdk/getLayerOpacity

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **args** (object) - Required - An object containing the layer name.
  - **layerName** (string) - Required - The name of the layer to be checked.

### Request Example
```json
{
  "args": {
    "layerName": "my_layer"
  }
}
```

### Response
#### Success Response (200)
- **number** - The layer's opacity level, a float number between 0.0 and 1.0.

#### Response Example
```json
0.8
```
```

--------------------------------

### GET /restricted-driving-areas

Source: https://www.waze.com/editor/sdk/classes/index.SDK.RestrictedDrivingAreas.html

Retrieves a list of all restricted driving areas currently in the WME data model.

```APIDOC
## GET /restricted-driving-areas

### Description
Returns an array of all restricted driving areas available in the Waze Map Editor data model.

### Method
GET

### Endpoint
/restricted-driving-areas

### Response
#### Success Response (200)
- **data** (RestrictedDrivingArea[]) - An array of restricted driving area objects.

#### Response Example
[
  {
    "id": 123,
    "name": "Restricted Zone A"
  }
]
```

--------------------------------

### wme-logged-in

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.SdkEvents.html

This event fires after the WME successfully fetches user information or after a user logs in.

```APIDOC
## wme-logged-in

### Description
The event happens when the WME fetches the user info of the currently logged-in user, or after the user logs in using the login form.

### Event Payload
None
```

--------------------------------

### Get All States (JavaScript)

Source: https://www.waze.com/editor/sdk/classes/index.SDK.States.html

Retrieves all states from the WME data model. Returns an array of State objects.

```javascript
W.model.states.getAll()
```

--------------------------------

### Register Global SDK Events

Source: https://www.waze.com/editor/sdk/index.html

Use the sdk.Events module to listen for global lifecycle and state change events in the Waze Editor.

```javascript
sdk.Events.once({ eventName: "wme-ready" }).then(() => {  
  console.log("WME is initialized, user is logged in and map data loaded");  
});  
sdk.Events.on({  
  eventName: "wme-map-data-loaded",  
  eventHandler: () => {  
    console.log("new data loaded");  
  },  
});  
sdk.Events.on({  
  eventName: "wme-map-zoom-changed",  
  eventHandler: () => {  
    sdk.Map.getZoomLevel();  
  },  
});  
sdk.Events.on({  
  eventName: "wme-user-settings-changed",  
  eventHandler: () => {  
    sdk.Settings.getUserSettings().isImperial;  
  },  
});
```

--------------------------------

### wme-map-initial-data-loaded

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.SdkEvents.html

This event fires exactly once when the WME has completed its initial map data fetch from the server.

```APIDOC
## wme-map-initial-data-loaded

### Description
The event happens exactly once when the WME completes its initial fetch of map data from the server.

### Event Payload
None
```

--------------------------------

### GET /MajorTrafficEvents/getAll

Source: https://www.waze.com/editor/sdk/classes/index.SDK.MajorTrafficEvents.html

Retrieves a list of all major traffic events currently present in the WME data model.

```APIDOC
## GET /MajorTrafficEvents/getAll

### Description
Retrieves an array of all major traffic events available in the Waze Map Editor data model.

### Method
GET

### Endpoint
/MajorTrafficEvents/getAll

### Response
#### Success Response (200)
- **events** (Array<MajorTrafficEvent>) - An array of all major traffic event objects.

#### Response Example
[
  {
    "id": "event_123",
    "type": "construction"
  }
]
```

--------------------------------

### Get Live Map Link

Source: https://www.waze.com/editor/sdk/classes/index.SDK.Map.html

Generates and returns a link to the LiveMap reflecting the current state of the map.

```APIDOC
## POST /websites/waze_editor_sdk/getLiveMapLink

### Description
Generates and returns a link to the LiveMap reflecting the current state of the map.

### Method
POST

### Endpoint
/websites/waze_editor_sdk/getLiveMapLink

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **string** - A URL to the LiveMap with the current map state.

#### Response Example
```json
"https://www.waze.com/live-map/...?lat=37.7749&lon=-122.4194&z=12"
```
```

--------------------------------

### getAll

Source: https://www.waze.com/editor/sdk/classes/index.SDK.TurnClosures.html

Retrieves an array of all turn closures currently present in the WME data model.

```APIDOC
## getAll

### Description
Retrieves an array of all the turn closures in the WME data model.

### Method
getAll

### Returns
TurnClosure[] - An array of all the turn closures in the WME data model.
```

--------------------------------

### Get Feature DOM Element

Source: https://www.waze.com/editor/sdk/classes/index.SDK.Map.html

Retrieves the DOM element associated with a specific feature within a given layer.

```APIDOC
## POST /websites/waze_editor_sdk/getFeatureDomElement

### Description
Retrieves the DOM element associated with a specific feature within a given layer.

### Method
POST

### Endpoint
/websites/waze_editor_sdk/getFeatureDomElement

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **args** (object) - Required - An object containing the feature ID and layer name.
  - **featureId** (string | number) - Required - The ID of the feature to retrieve the element for.
  - **layerName** (string) - Required - The name of the layer the feature should be searched within.

### Request Example
```json
{
  "args": {
    "featureId": "feature-123",
    "layerName": "my_layer"
  }
}
```

### Response
#### Success Response (200)
- **null | HTMLElement | SVGElement** - The DOM element of the feature. Returns `HTMLElement` for markers, `SVGElement` for others, or `null` if the feature is not found.

#### Response Example
```html
<div class="marker">...</div>
```
```

--------------------------------

### UserProfile Properties Explanation (Markdown)

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.UserProfile.html

Explains the properties of the UserProfile interface, detailing the type and meaning of each field, such as daily edit counts over the last 90 days and a breakdown of edits by type.

```markdown
### Properties

dailyEditCount editCountByType totalEditCount

## Properties

### dailyEditCount
dailyEditCount: number[]
User's daily edit counts from the last 90 days. An array ordered from the oldest edit count to the newest, i.e. the number of edits for today is the last element in the array

### editCountByType
editCountByType: {
  mapProblems: number;
  placeUpdateRequests: number;
  segmentHouseNumbers: number;
  segments: number;
  updateRequests: number;
  venues: number;
}
Number of edits by type made by user.

### totalEditCount
totalEditCount: number
Total number of edits made by user.
```

--------------------------------

### addVenue

Source: https://www.waze.com/editor/sdk/classes/index.SDK.Venues.html

Adds a new venue to the map.

```APIDOC
## addVenue(args: { category: VenueCategoryId; geometry: Point | Polygon }): number

### Description
Adds a new venue to the map.

### Parameters
- **args** (object) - Required
  - **category** (VenueCategoryId) - Required - Category id of the new venue.
  - **geometry** (Point | Polygon) - Required - Venue geometry.

### Returns
- **number** - id of the new venue

### Throws
- **InvalidStateError** - if not allowed to add a new venue
```

--------------------------------

### GET /PermanentHazards/getCameraById

Source: https://www.waze.com/editor/sdk/classes/index.SDK.PermanentHazards.html

Retrieves a specific camera object from the WME data model based on the provided unique camera ID.

```APIDOC
## GET /PermanentHazards/getCameraById

### Description
Finds and returns a specific camera by its ID. Returns null if the camera is not found.

### Method
GET

### Endpoint
/PermanentHazards/getCameraById

### Parameters
#### Query Parameters
- **cameraId** (number) - Required - The unique identifier of the camera to retrieve.

### Response
#### Success Response (200)
- **camera** (Camera | null) - The camera object if found, otherwise null.

#### Response Example
{
  "id": 12345,
  "type": "speed_camera"
}
```

--------------------------------

### TileLayerOptions Properties Explanation (TypeScript)

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.TileLayerOptions.html

Explains the individual properties of the TileLayerOptions interface. It details the purpose of tileHeight, tileWidth, and the nested url object, which includes fileName, optional params, and an array of servers. This provides clarity on how to configure tile fetching.

```typescript
// The tile image height
tileHeight: number;

// The tile image width
tileWidth: number;

// Details for the tile server url
url: {
  // The file pattern for the tiles, usually similar to `tiles/${z}/${x}/${y}` or `tiles/${z}/${x}/${y}.png`
  fileName: string;
  // Optional URL params to append to the tile URL after the fileName
  params?: Record<string, unknown>;
  // An array of tile server base paths, with no appending `/` Requests for tiles will be distributed between the servers in the array
  servers: string[];
}
```

--------------------------------

### GET /PermanentHazards/getAllCameras

Source: https://www.waze.com/editor/sdk/classes/index.SDK.PermanentHazards.html

Retrieves a complete list of all camera objects currently present in the Waze Map Editor data model.

```APIDOC
## GET /PermanentHazards/getAllCameras

### Description
Retrieves an array of all cameras available in the WME data model.

### Method
GET

### Endpoint
/PermanentHazards/getAllCameras

### Response
#### Success Response (200)
- **cameras** (Array<Camera>) - An array of all camera objects.

#### Response Example
[
  {
    "id": 12345,
    "type": "speed_camera"
  }
]
```

--------------------------------

### wme-map-initial-data-loaded

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.SdkEvents.html

The event is triggered when the initial map data has been loaded.

```APIDOC
## wme-map-initial-data-loaded

### Description
The event is triggered when the initial map data has been loaded.

### Event Payload
This event does not have a payload.
```

--------------------------------

### showVenueUpdateRequestDialog

Source: https://www.waze.com/editor/sdk/classes/index.SDK.Venues.html

Displays the Place Update Request dialog for a specific venue.

```APIDOC
## showVenueUpdateRequestDialog(args: { venueId: string }): void

### Description
Display the Place Update Request dialog for the specified venue, showing any pending update requests.

### Parameters
- **venueId** (string) - Required - The ID of the venue for which to display the update requests.

### Throws
- **DataModelNotFoundError** - If the venue with the specified venueId is not found.
```

--------------------------------

### Get Script Initialization ID

Source: https://www.waze.com/editor/sdk/classes/index.SDK.WmeSDK.html

Retrieves the unique script ID with which the SDK instance was initialized. This method is synchronous and returns a string.

```javascript
const scriptId = WmeSDK.getScriptId();
console.log(`SDK Script ID: ${scriptId}`);
```

--------------------------------

### Settings API

Source: https://www.waze.com/editor/sdk/classes/index.SDK.Settings.html

Methods for managing user settings within the Waze Map Editor SDK.

```APIDOC
## Class Settings

Methods for managing user settings.

### getLocale

Retrieves the current locale information.

- **Method**: GET
- **Endpoint**: N/A (Method within SDK)
- **Returns**:
  - `localeCode` (string) - The code of the current locale.
  - `localeName` (string) - The name of the current locale.

### getRegionCode

Retrieves the current region code.

- **Method**: GET
- **Endpoint**: N/A (Method within SDK)
- **Returns**:
  - `RegionCode` | `null` - The current region code, or null if not available.

### getUserSettings

Retrieves the current user settings.

- **Method**: GET
- **Endpoint**: N/A (Method within SDK)
- **Returns**:
  - `UserSettings` - The current user settings or default settings if the user is not logged in.

### setRegionCode

Sets the application region code and reloads the application.

**Note**: Calling this method will cause the WME application to reload, and any subsequent methods will not be executed due to page unloading.

- **Method**: POST
- **Endpoint**: N/A (Method within SDK)
- **Parameters**:
  - **Path Parameters**: None
  - **Query Parameters**: None
  - **Request Body**:
    - `args` (object) - Required - Contains the region code to set.
      - `regionCode` (RegionCode) - Required - The region code to set.
- **Returns**: `void`

### setUserSettings

Sets values for user settings.

- **Method**: POST
- **Endpoint**: N/A (Method within SDK)
- **Parameters**:
  - **Path Parameters**: None
  - **Query Parameters**: None
  - **Request Body**:
    - `options` (Partial<UserSettings>) - Required - An object containing the user settings to update.
- **Returns**: `void`
```

--------------------------------

### Get State by ID (JavaScript)

Source: https://www.waze.com/editor/sdk/classes/index.SDK.States.html

Retrieves a specific state from the WME data model by its ID. Returns a State object or null if not found.

```javascript
W.model.states.getById({ stateId: 123 })
```

--------------------------------

### WmeSDK Properties

Source: https://www.waze.com/editor/sdk/classes/index.SDK.WmeSDK.html

Accessing core WME modules and services through the SDK instance.

```APIDOC
## GET /WmeSDK/properties

### Description
Provides access to the read-only properties of the WmeSDK, which expose the core functionality of the Waze Map Editor.

### Properties
- **DataModel** (DataModel) - Access to the map data layer.
- **Editing** (Editing) - Tools and methods for map editing.
- **Errors** (Object) - Custom error classes for SDK operations.
- **Events** (SdkEventBus) - Event bus for subscribing to WME updates.
- **LayerSwitcher** (LayerSwitcher) - Controls for map layer visibility.
- **Map** (Map) - Core map interaction object.
- **Settings** (Settings) - WME configuration settings.
- **Shortcuts** (Shortcuts) - Keyboard shortcut management.
- **Sidebar** (Sidebar) - UI sidebar controls.
- **State** (WmeState) - Current application state.
```

--------------------------------

### Get Street by ID using Waze SDK

Source: https://www.waze.com/editor/sdk/classes/index.SDK.Streets.html

Retrieves a specific street from the Waze map data model using its unique ID. Returns null if no street is found with the provided ID.

```javascript
/**
 * Retrieves a street by its ID.
 * @param {{ streetId: number }} args - The parameters for retrieving a street.
 * @returns {null | Street} The street object if found, otherwise null.
 */
const street = streets.getById({ streetId: 456 });
```

--------------------------------

### Get All Non-Default States (JavaScript)

Source: https://www.waze.com/editor/sdk/classes/index.SDK.States.html

Retrieves all states from the WME data model, excluding the default state. Returns an array of State objects.

```javascript
W.model.states.getAllWithoutDefault()
```

--------------------------------

### DriveProfile Properties (Documentation)

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.DriveProfile.html

Lists and describes the properties of the DriveProfile interface. Each property specifies its data type and purpose within the SDK. This section serves as a reference for understanding the structure of a drive profile.

```markdown
## Properties
### licensePlateNumber
licensePlateNumber: string
### numPassengers
numPassengers: number
### subscriptions
subscriptions: string[]
### vehicleTypes
vehicleTypes: VehicleType[]
```

--------------------------------

### Get Function Method

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.CallSite.html

The getFunction method returns the Function object associated with the call site. This allows for introspection of the function itself. It returns undefined if not available.

```javascript
getFunction(): undefined | Function;
```

--------------------------------

### Get Eval Origin Method

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.CallSite.html

The getEvalOrigin method returns the origin of the eval expression if the call site is within an eval. It returns undefined if not applicable.

```javascript
getEvalOrigin(): undefined | string;
```

--------------------------------

### getAll

Source: https://www.waze.com/editor/sdk/classes/index.SDK.Segments.html

Retrieves an array of all segments currently in the WME data model.

```APIDOC
## getAll()

### Description
Returns an array of all the segments in the WME data model.

### Returns
- **Segment[]** - An array of all segments.
```

--------------------------------

### Venue Interface Properties

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.Venue.html

This section outlines the various properties available within the Venue interface, including their types and descriptions.

```APIDOC
## Interface Venue

### Properties

*   **aliases**: `string[]` - Aliases or alternative names for the venue.
*   **approved**: `boolean` - 'approved' is `false` for new venues suggested as PUR. The venue must be approved before it can be edited.
*   **brand**: `null | string` - The brand associated with the venue.
*   **categories**: `VenueCategoryId[]` - The list of categories, assigned to the venue.
*   **description**: `string` - The description of the venue.
*   **externalProviderIds**: `string[]` - The list of the venue's external provider ids.
*   **geometry**: `Point | Polygon` - The GeoJSON Point/Polygon representation of the venue's geometry.
*   **id**: `string` - The unique identifier for the venue.
*   **images**: `VenueImage[]` - Array of images associated with the venue.
    #### Example
    ```json
    [
      {
        "date": 1678886400000,
        "id": "12345678-90ab-cdef-1234-567890abcdef",
        "isApproved": true,
        "url": "https://www.example.com/image.jpg"
      }
    ]
    ```
*   **isAdLocked**: `boolean` - Whether the venue is locked for advertising purposes.
*   **isResidential**: `boolean` - Whether the venue is residential or not.
*   **lockRank**: `number` - The lock rank of the venue.
*   **modificationData**: `ModificationMetadata` - Contains metadata about the last modification.
*   **name**: `string` - The name of the venue.
*   **navigationPoints**: `NavigationPoint[]` - List of entry and exit points for the venue.
*   **openingHours**: `OpeningHour[]` - Array of opening hour objects. Each object defines a set of opening hours for specific days of the week.
    #### Example
    ```json
    [
      { "days": [0, 1, 2, 3, 4, 5, 6], "fromHour": "09:00", "toHour": "17:00" }, // Open every day 9am-5pm
      { "days": [5, 6], "fromHour": "09:00", "toHour": "22:00" } // Open weekends 9am-10pm
    ]
    ```
    *Note: `days` is an array of numbers representing days of the week (0 = Sunday, 1 = Monday, etc.) and `fromHour` and `toHour` are strings in 24-hour format ("HH:MM").*
*   **phone**: `string` - The phone number of the venue.
*   **services**: `ServiceType[]` - Services offered at the venue.
*   **url**: `string` - The website URL of the venue.
*   **venueUpdateRequests**: `VenueUpdateRequest[]` - Update Requests of the venue.
```

--------------------------------

### Get This Method

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.CallSite.html

The getThis method returns the 'this' value at the call site. This is essential for understanding the context in which a function is executed. It returns unknown as the type can vary.

```javascript
getThis(): unknown;
```

--------------------------------

### wme-logged-in

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.SdkEvents.html

The event is triggered when a user logs into the WME.

```APIDOC
## wme-logged-in

### Description
The event is triggered when a user logs into the WME.

### Event Payload
This event does not have a payload.
```

--------------------------------

### Get Column Number Method

Source: https://www.waze.com/editor/sdk/interfaces/index.SDK.CallSite.html

The getColumnNumber method of the CallSite interface returns the column number of the current call site. This can be null if the column number is not available.

```javascript
getColumnNumber(): null | number;
```

--------------------------------

### Get Top State (JavaScript)

Source: https://www.waze.com/editor/sdk/classes/index.SDK.States.html

Retrieves the state designated as the top state in the WME data model. Returns a State object or null if none is set.

```javascript
W.model.states.getTopState()
```

--------------------------------

### ParkingLot Class Methods

Source: https://www.waze.com/editor/sdk/classes/index.SDK.ParkingLot.html

This section details the methods available within the ParkingLot class for interacting with parking lot data in the Waze Map Editor SDK.

```APIDOC
## Class ParkingLot

Methods for dealing with Parking Lots.

### Methods

- `canExitWhileClosed(args: { venueId: string }): null | boolean`
- `getBrands(): string[]`
- `getCostType(args: { venueId: string }): null | ParkingLotCostType`
- `getEstimatedNumberOfSpots(args: { venueId: string }): null | SpotsEstimate`
- `getLotTypes(args: { venueId: string }): null | LotType[]`
- `getParkingLotType(args: { venueId: string }): ParkingType`
- `getPaymentMethods(args: { venueId: string }): null | PaymentType[]`
- `isLotTypeDependentOnDayTime(args: { venueId: string }): null | boolean`
- `setEstimatedNumberOfSpots(args: { estimatedNumberOfSpots: SpotsEstimate; venueId: string }): void`

---

### `canExitWhileClosed`

#### Description
Checks if a parking lot allows exiting while closed.

#### Method
`canExitWhileClosed`

#### Parameters
- **args** (object) - Required
  - **venueId** (string) - Required - The ID of the parking lot to check.

#### Returns
- `null | boolean` - Returns `true` if exit while closed is allowed, `false` otherwise. Returns `null` if the venue is not a parking lot.

#### Throws
- `DataModelNotFoundError` - In case the venue is not found in the WME data model.

---

### `getBrands`

#### Description
Retrieves a list of available parking lot brands.

#### Method
`getBrands`

#### Parameters
None

#### Returns
- `string[]` - An array of strings representing parking lot brands.

---

### `getCostType`

#### Description
Gets the cost type of a parking lot.

#### Method
`getCostType`

#### Parameters
- **args** (object) - Required
  - **venueId** (string) - Required - The ID of the parking lot to get the cost type for.

#### Returns
- `null | ParkingLotCostType` - The cost type of the parking lot, or `null` if the venue is not a parking lot.

#### Throws
- `DataModelNotFoundError` - In case the venue is not found in the WME data model.

---

### `getEstimatedNumberOfSpots`

#### Description
Gets the estimated number of available spots in a parking lot.

#### Method
`getEstimatedNumberOfSpots`

#### Parameters
- **args** (object) - Required
  - **venueId** (string) - Required - The ID of the parking lot to get the estimated number of spots for.

#### Returns
- `null | SpotsEstimate` - The estimated number of spots, or `null` if the venue is not a parking lot.

#### Throws
- `DataModelNotFoundError` - In case the venue is not found in the WME data model.

---

### `getLotTypes`

#### Description
Retrieves the types of a parking lot.

#### Method
`getLotTypes`

#### Parameters
- **args** (object) - Required
  - **venueId** (string) - Required - The ID of the venue to get the parking lot types for.

#### Returns
- `null | LotType[]` - An array of parking lot types, or `null` if the venue is not a parking lot.

#### Throws
- `DataModelNotFoundError` - In case the venue is not found in the WME data model.

---

### `getParkingLotType`

#### Description
Gets the parking type of a venue.

#### Method
`getParkingLotType`

#### Parameters
- **args** (object) - Required
  - **venueId** (string) - Required - The ID of the venue to get the parking lot type for.

#### Returns
- `ParkingType` - The parking type of the venue. Returns `null` if the venue is not a parking lot.

#### Throws
- `DataModelNotFoundError` - In case the venue is not found in the WME data model.

---

### `getPaymentMethods`

#### Description
Retrieves the payment methods accepted by a parking lot.

#### Method
`getPaymentMethods`

#### Parameters
- **args** (object) - Required
  - **venueId** (string) - Required - The ID of the parking lot to get the payment method for.

#### Returns
- `null | PaymentType[]` - An array of payment types, or `null` if the venue is not a parking lot.

#### Throws
- `DataModelNotFoundError` - In case the venue is not found in the WME data model.

---

### `isLotTypeDependentOnDayTime`

#### Description
Checks if the parking lot type varies depending on the time or day.

#### Method
`isLotTypeDependentOnDayTime`

#### Parameters
- **args** (object) - Required
  - **venueId** (string) - Required - The ID of the parking lot to check.

#### Returns
- `null | boolean` - Returns `true` if the lot type varies, `false` otherwise. Returns `null` if the venue is not a parking lot.

#### Throws
- `DataModelNotFoundError` - In case the venue is not found in the WME data model.

---

### `setEstimatedNumberOfSpots`

#### Description
Sets the estimated number of spots for a parking lot.

#### Method
`setEstimatedNumberOfSpots`

#### Parameters
- **args** (object) - Required
  - **estimatedNumberOfSpots** (SpotsEstimate) - Required - The estimated number of spots to set.
  - **venueId** (string) - Required - The ID of the parking lot to update.

#### Returns
- `void`

#### Throws
- `DataModelNotFoundError` - In case the venue is not found in the WME data model.

```

--------------------------------

### sdk.Events.on

Source: https://www.waze.com/editor/sdk/index.html

Registers an event handler for a specific event name.

```APIDOC
## sdk.Events.on

### Description
Registers a persistent event listener for a specified event name.

### Parameters
- **eventName** (string) - Required - The name of the event to listen for.
- **eventHandler** (function) - Required - The callback function to execute when the event is triggered.
```

--------------------------------

### Get All Road Closures - JavaScript

Source: https://www.waze.com/editor/sdk/classes/index.SDK.RoadClosures.html

Retrieves an array of all road closures currently present in the WME data model. This method is straightforward and does not require any parameters.

```javascript
getAll(): RoadClosure[]
```
Tokens:
Raw