ESPRMAdminCustomData
Defined in: src/ESPRMAdminCustomData.ts:11
Shell class for admin custom user data management operations. Methods are added via prototype augmentation in methods/ESPRMAdminCustomData/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminCustomData():
ESPRMAdminCustomData
Returns
Section titled “Returns”ESPRMAdminCustomData
Methods
Section titled “Methods”getCustomData()
Section titled “getCustomData()”getCustomData(
params?):Promise<CustomDataResponse>
Defined in: src/methods/ESPRMAdminCustomData/GetCustomData.ts:22
Retrieves custom data associated with a user, with optional filtering.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters to filter the custom data.
Returns
Section titled “Returns”Promise<CustomDataResponse>
The custom data response.
setCustomData()
Section titled “setCustomData()”setCustomData(
data,params?):Promise<CustomDataResponse>
Defined in: src/methods/ESPRMAdminCustomData/SetCustomData.ts:23
Sets or updates custom data for a user.
Parameters
Section titled “Parameters”Record<string, unknown>
The key-value custom data to set.
params?
Section titled “params?”Optional query parameters identifying the target user.
Returns
Section titled “Returns”Promise<CustomDataResponse>
The updated custom data response.