TagService

Tag service can be used in the following way:

1. Import the service from our library:

import {TagService} from "@selfcommunity/api-services";

2. Create a function and put the service inside it!
The async function `getAllTags` will return the paginated list of tags.

async getAllTags() {
       return await TagService.getAllTags();
     }

In case of required `params`, just add them inside the brackets.

async getSpecificTag(tagId) {
      return await TagService.getSpecificTag(tagId);
     }

If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).

1. Declare it(or declare them, it is possible to add multiple params)

const headers = headers: {Authorization: `Bearer ${yourToken}`}

2. Add it inside the brackets and pass it to the function, as shown in the previous example!

Constructors

Constructor

new TagService(): TagService

Returns

TagService

Methods

assignATag()

static assignATag(id, user?, category?, config?): Promise<SCTagType>

Parameters

Parameter	Type
id	string | number
user?	number
category?	number
config?	AxiosRequestConfig

Returns

Promise<SCTagType>

---

createTag()

static createTag(data, config?): Promise<SCTagType>

Parameters

Parameter	Type
data	TagParams
config?	AxiosRequestConfig

Returns

Promise<SCTagType>

---

getAllTags()

static getAllTags(params?, config?): Promise<SCPaginatedResponse<SCTagType>>

Parameters

Parameter	Type
params?	TagGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCTagType>>

---

getSpecificTag()

static getSpecificTag(id, config?): Promise<SCTagType>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCTagType>

---

patchTag()

static patchTag(id, data?, config?): Promise<SCTagType>

Parameters

Parameter	Type
id	string | number
data?	TagParams
config?	AxiosRequestConfig

Returns

Promise<SCTagType>

---

searchUserTags()

static searchUserTags(params?, config?): Promise<SCPaginatedResponse<SCTagType>>

Parameters

Parameter	Type
params?	TagGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCTagType>>

---

updateTag()

static updateTag(id, data?, config?): Promise<SCTagType>

Parameters

Parameter	Type
id	string | number
data?	TagParams
config?	AxiosRequestConfig

Returns

Promise<SCTagType>