Skip to main content

TagApiClientInterface

Methods

assignATag()

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

Parameters

ParameterType
idstring | number
user?number
category?number
config?AxiosRequestConfig

Returns

Promise<SCTagType>


createTag()

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

Parameters

ParameterType
dataTagParams
config?AxiosRequestConfig

Returns

Promise<SCTagType>


getAllTags()

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

Parameters

ParameterType
params?TagGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCTagType>>


getSpecificTag()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCTagType>


patchTag()

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

Parameters

ParameterType
idstring | number
data?TagParams
config?AxiosRequestConfig

Returns

Promise<SCTagType>


searchUserTags()

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

Parameters

ParameterType
params?TagGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCTagType>>


updateTag()

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

Parameters

ParameterType
idstring | number
data?TagParams
config?AxiosRequestConfig

Returns

Promise<SCTagType>