Skip to main content

PreferenceApiClientInterface

Methods

getAllPreferences()

getAllPreferences(config?): Promise<SCPaginatedResponse<SCPreferenceType>>

Parameters

ParameterType
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCPreferenceType>>


getSpecificPreference()

getSpecificPreference(id, config?): Promise<SCPreferenceType>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCPreferenceType>


searchPreferences()

searchPreferences(search?, section?, keys?, ordering?, config?): Promise<SCPaginatedResponse<SCPreferenceType>>

Parameters

ParameterType
search?string
section?string
keys?string
ordering?string
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCPreferenceType>>


updatePreferences()

updatePreferences(data, config?): Promise<SCPreferenceType | SCPreferenceType[]>

Parameters

ParameterType
dataany
config?AxiosRequestConfig

Returns

Promise<SCPreferenceType | SCPreferenceType[]>