Class: PreferenceApiClient
services/preference.PreferenceApiClient
Contains all the endpoints needed to manage dynamic preferences.
Constructors
constructor
• new PreferenceApiClient(): PreferenceApiClient
Returns
Methods
getAllPreferences
▸ getAllPreferences(config?): Promise<SCPaginatedResponse<SCPreferenceType>>
This endpoint retrieves all available dynamic preferences.
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCPreferenceType>>
Defined in
services/preference/index.ts:28
getSpecificPreference
▸ getSpecificPreference(id, config?): Promise<SCPreferenceType>
This endpoint retrieves a specific dynamic preference.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPreferenceType>
Defined in
services/preference/index.ts:61
searchPreferences
▸ searchPreferences(search?, section?, keys?, ordering?, config?): Promise<SCPaginatedResponse<SCPreferenceType>>
This endpoint searches dynamic preferences.
Parameters
| Name | Type |
|---|---|
search? | string |
section? | string |
keys? | string |
ordering? | string |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCPreferenceType>>