Class Streets

Methods for dealing with Streets.

Hierarchy

SdkModule
- Streets

Index

Methods

addStreet getAll getById getStreet updateStreet

Methods

addStreet

addStreet(args: { cityId?: number; streetName: string }): Street
Add a new street.
Parameters
- args: { cityId?: number; streetName: string }
  - OptionalcityId?: number
    An id of the city to add the street. If none provided, the top city from the data model would be used.
  - streetName: string
    A name for the new street.
Returns Street
a new street object

Throws
DataModelNotFoundError in case the city is not found in the WME data model

Throws
InvalidStateError in case not allowed to add a new street, if the street already exists or if cityId wasn't provided and top city not found.

getAll

getAll(): Street[]
Returns Street[]
an array of all the streets in the WME data model

getById

getById(args: { streetId: number }): null | Street
Parameters
- args: { streetId: number }
  - streetId: number
    An id of the street to look for.
Returns null | Street
street with id, or null if not found in the WME data model

getStreet

getStreet(args: { cityId?: number; streetName: string }): null | Street
Find a street by the name.
Parameters
- args: { cityId?: number; streetName: string }
  - OptionalcityId?: number
    An optional id of the city the street must be in.
  - streetName: string
    A name of the street to look for.
Returns null | Street
a street object or null if not found

Throws
DataModelNotFoundError in case the city was not found in the WME data model

updateStreet

updateStreet(args: { direction?: string; streetId: number }): void
Update street attributes. Currently, only supports updating the direction of a street.
Parameters
- args: { direction?: string; streetId: number }
Returns void
Throws
DataModelNotFoundError if the street with the given streetId is not found in the WME data model.

Throws
InvalidStateError if editing is not currently allowed(e.g., not in edit mode) or if the update action fails for other reasons.