Class: LocalityApiClient
services/locality.LocalityApiClient
Contains all the endpoints needed to manage localities.
Constructors
constructor
• new LocalityApiClient(): LocalityApiClient
Returns
Methods
getLocalities
▸ getLocalities(params?, config?): Promise<SCPaginatedResponse<SCLocalityType>>
This endpoint retrieves the list of available localities.
Parameters
| Name | Type |
|---|---|
params? | BaseSearchParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCLocalityType>>
Defined in
searchLocalities
▸ searchLocalities(params?, config?): Promise<SCPaginatedResponse<SCLocalityType>>
This endpoint searches localities
Parameters
| Name | Type |
|---|---|
params? | BaseSearchParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCLocalityType>>