PreferenceApiClientInterface
Methods
getAllPreferences()
getAllPreferences(
config
?):Promise
<SCPaginatedResponse
<SCPreferenceType
>>
Parameters
Parameter | Type |
---|---|
config ? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCPreferenceType
>>
Source
services/preference/index.ts:9
getSpecificPreference()
getSpecificPreference(
id
,config
?):Promise
<SCPreferenceType
>
Parameters
Parameter | Type |
---|---|
id | string | number |
config ? | AxiosRequestConfig <any > |
Returns
Promise
<SCPreferenceType
>
Source
services/preference/index.ts:17
searchPreferences()
searchPreferences(
search
?,section
?,keys
?,ordering
?,config
?):Promise
<SCPaginatedResponse
<SCPreferenceType
>>
Parameters
Parameter | Type |
---|---|
search ? | string |
section ? | string |
keys ? | string |
ordering ? | string |
config ? | AxiosRequestConfig <any > |
Returns
Promise
<SCPaginatedResponse
<SCPreferenceType
>>
Source
services/preference/index.ts:10
updatePreferences()
updatePreferences(
data
,config
?):Promise
<SCPreferenceType
|SCPreferenceType
[]>
Parameters
Parameter | Type |
---|---|
data | any |
config ? | AxiosRequestConfig <any > |
Returns
Promise
<SCPreferenceType
| SCPreferenceType
[]>