Class SearchServiceArea

Hierarchy

Method
- SearchServiceArea

Index

Methods API

API Methods

byBrand

byBrand(criteria: SearchByBrandCriteria): Promise<ServiceAreaSearchResponse>

- Defined in methods/search.ts:123
Returns a list of service areas that meet the set criteria.
example
```
const criteria: SearchByBrandCriteria = {} // Pass valid criteria!
const searchResponse = await client.search.byBrand(criteria);
console.log(searchResponse);
```
Parameters
- criteria: SearchByBrandCriteria
  
  Criteria for searching the service area
Returns Promise<ServiceAreaSearchResponse>

byGeographicArea

byGeographicArea(criteria: SearchByGeographicAreaCriteria): Promise<ServiceAreaSearchResponse>

- Defined in methods/search.ts:60
Returns a list of service areas that meet the set criteria.
example
```
const criteria: SearchByGeographicAreaCriteria = {} // Pass valid criteria!
const searchResponse = await client.search.byGeographicArea(criteria);
console.log(searchResponse);
```
Parameters
- criteria: SearchByGeographicAreaCriteria
  
  Criteria for searching the service area
Returns Promise<ServiceAreaSearchResponse>

byHighway

byHighway(highwayId: string): Promise<ServiceAreaSearchResponse>

- Defined in methods/search.ts:94
Returns a list of service areas present on the highway section.
example
```
const searchResponse = await client.search.byHighway("A1");
console.log(searchResponse);
```
Parameters
- highwayId: string
  
  Id of the highway
Returns Promise<ServiceAreaSearchResponse>

byZone

byZone(criteria: SearchByZoneCriteria): Promise<ServiceAreaSearchResponse>

- Defined in methods/search.ts:26
Returns a list of service areas that meet the set criteria.
example
```
const criteria: SearchByZoneCriteria = {} // Pass valid criteria!
const searchResponse = await client.search.byZone(criteria);
console.log(searchResponse);
```
Parameters
- criteria: SearchByZoneCriteria
  
  Criteria for searching the service area
Returns Promise<ServiceAreaSearchResponse>

Generated using TypeDoc