PreferenceApiClient

Contains all the endpoints needed to manage dynamic preferences.

Constructors

Constructor

new PreferenceApiClient(): PreferenceApiClient

Returns

PreferenceApiClient

Methods

getAllPreferences()

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

This endpoint retrieves all available dynamic preferences.

Parameters

Parameter	Type	Description
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCPreferenceType>>

---

getSpecificPreference()

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

This endpoint retrieves a specific dynamic preference.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCPreferenceType>

---

searchPreferences()

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

This endpoint searches dynamic preferences.

Parameters

Parameter	Type	Description
search?	string
section?	string
keys?	string
ordering?	string
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCPreferenceType>>

---

updatePreferences()

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

This endpoint patches one or more dynamic preferences.

Parameters

Parameter	Type	Description
data	any
config?	AxiosRequestConfig

Returns

Promise<SCPreferenceType | SCPreferenceType[]>