ESPRMAdminCommonCustomData
Defined in: src/ESPRMAdminCommonCustomData.ts:11
Shell class for admin common custom data operations. Methods are added via prototype augmentation in methods/ESPRMAdminCommonCustomData/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminCommonCustomData():
ESPRMAdminCommonCustomData
Returns
Section titled “Returns”ESPRMAdminCommonCustomData
Methods
Section titled “Methods”getCommonCustomData()
Section titled “getCommonCustomData()”getCommonCustomData(
params?):Promise<GetCommonCustomDataResponse>
Defined in: src/methods/ESPRMAdminCommonCustomData/GetCommonCustomData.ts:22
Retrieves common custom data shared across users, with optional filtering.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters to filter the common custom data.
Returns
Section titled “Returns”Promise<GetCommonCustomDataResponse>
The common custom data response.
setCommonCustomData()
Section titled “setCommonCustomData()”setCommonCustomData(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminCommonCustomData/SetCommonCustomData.ts:22
Sets or updates common custom data shared across users.
Parameters
Section titled “Parameters”params
Section titled “params”The common custom data payload to set.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the data was set.