ESPRMAdminTag
Defined in: src/ESPRMAdminTag.ts:11
Shell class for admin tag management operations. Methods are added via prototype augmentation in methods/ESPRMAdminTag/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminTag():
ESPRMAdminTag
Returns
Section titled “Returns”ESPRMAdminTag
Methods
Section titled “Methods”attachTags()
Section titled “attachTags()”attachTags(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminTag/AttachTags.ts:27
Attaches tags to a specified resource.
Parameters
Section titled “Parameters”params
Section titled “params”The resource type, resource ID, and tags to attach.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the tags were attached.
detachTags()
Section titled “detachTags()”detachTags(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminTag/DetachTags.ts:27
Detaches tags from a specified resource.
Parameters
Section titled “Parameters”params
Section titled “params”The resource type, resource ID, and tags to detach.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the tags were detached.
getTagNames()
Section titled “getTagNames()”getTagNames(
params?):Promise<GetTagNamesResponse>
Defined in: src/methods/ESPRMAdminTag/GetTagNames.ts:22
Retrieves the list of distinct tag names with optional filtering.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters to filter tag names.
Returns
Section titled “Returns”Promise<GetTagNamesResponse>
The list of tag names matching the query.
getTags()
Section titled “getTags()”getTags(
params?):Promise<GetAdminTagsResponse>
Defined in: src/methods/ESPRMAdminTag/GetTags.ts:22
Retrieves admin tags with optional filtering and pagination.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters to filter or paginate tags.
Returns
Section titled “Returns”Promise<GetAdminTagsResponse>
The list of tags matching the query.