LocalityApiClient

Contains all the endpoints needed to manage localities.

Constructors

new LocalityApiClient()

new LocalityApiClient(): LocalityApiClient

Returns

LocalityApiClient

Methods

getLocalities()

static getLocalities(params?, config?): Promise <SCPaginatedResponse<SCLocalityType>>

This endpoint retrieves the list of available localities.

Parameters

Parameter	Type	Description
params?	BaseSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCLocalityType>>

Source

services/locality/index.ts:22

---

searchLocalities()

static searchLocalities(params?, config?): Promise <SCPaginatedResponse<SCLocalityType>>

This endpoint searches localities

Parameters

Parameter	Type	Description
params?	BaseSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCLocalityType>>

Source

services/locality/index.ts:32