Skip to main content
Version: 2.1

Settings Client

To use setting sdk client we need retrive from the SDK using rumsanService.client

const settingClient = getSettingsClient(rumsanService.client);

As the mutation function or query function may contain some payload to be pass which are the parmaeter.

settingClient.create
ParameterTypeDescription
namestringname of the setting
valueObjectstructured data object containing key-value pairs
requiredFieldsstring[]specifies which key should be present in value parameter
isReadOnlyboolean or null
isPrivateboolean or null
Response
    success: true
data: [
{
name: string
value: any
dataType: string
requiredFields: string[]
isReadOnly: boolean
isPrivate: boolean
}
]
settingClient.list
Response
  sucess: boolean
data: any