Skip to main content

LocalityApiClient

Contains all the endpoints needed to manage localities.

Constructors

Constructor

new LocalityApiClient(): LocalityApiClient

Returns

LocalityApiClient

Methods

getLocalities()

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

This endpoint retrieves the list of available localities.

Parameters

ParameterTypeDescription
params?BaseSearchParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCLocalityType>>


searchLocalities()

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

This endpoint searches localities

Parameters

ParameterTypeDescription
params?BaseSearchParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCLocalityType>>