tag

Interfaces

Data required to create a new tag

Property	Type	Description
`color?`	`string`	Optional hex color code for the tag. If not provided, a color will be assigned automatically
`name`	`string`	The name of the tag
`ownerResourceId`	`string`	The ID of the resource that will own this tag
`ownerResourceType`	`TagOwnerResourceType`	The type of resource that will own this tag

Parameters for getting tags for a resource

Property	Type	Description
`name?`	`string`	Filter tags by partial name match (case-insensitive)
`sortBy?`	`"createdAt"` \| `"updatedAt"` \| `"name"`	Sort tags by field

Data for updating an existing tag

Property	Type	Description
`color?`	`string`	The new hex color code for the tag
`name?`	`string`	The new name for the tag

function default(client): {
  createTag: Promise<Tag>;
  deleteTag: Promise<Tag>;
  getTags: Promise<Tags>;
  updateTag: Promise<Tag>;
};

Defines tag-related methods for the NuramaClient.

Parameter	Type	Description
`client`	`default`	The NuramaClient instance.

An object containing the tag-related methods.

Name	Type	Description
`createTag()`	(`tagData`) => `Promise`<`Tag`>	Creates a new tag for a specific resource.
`deleteTag()`	(`tagId`) => `Promise`<`Tag`>	Deletes a tag permanently.
`getTags()`	( `ownerResourceType`, `ownerResourceId`, `params?` ) => `Promise`<`Tags`>	Retrieves all tags for a specific resource.
`updateTag()`	(`tagId`, `updateData`) => `Promise`<`Tag`>	Updates an existing tag.