Class TagsAPI

constructor

• new TagsAPI(httpRequest): TagsAPI

• Parameters

  • httpRequest: BaseHttpRequest

  Returns TagsAPI

Readonly httpRequest

createTag

• createTag(__namedParameters): CancelablePromise<CreateTagResponse>

• Create tag Create a new tag for a company.

  Parameters

  • __namedParameters: {
        companyId: string;
        requestBody: CreateTagRequestBody;
    }

    • companyId: string

      ID of the company

    • requestBody: CreateTagRequestBody

  Returns CancelablePromise<CreateTagResponse>

  CreateTagResponse

  Throws

  ApiError

deleteTag

• deleteTag(__namedParameters): CancelablePromise<SuccessResponse>

• Delete tag Delete an existing tag.

  Parameters

  • __namedParameters: {
        companyId: string;
        id: string;
    }

    • companyId: string

      ID of the company

    • id: string

      ID of the tag

  Returns CancelablePromise<SuccessResponse>

  SuccessResponse

  Throws

  ApiError

getTag

• getTag(__namedParameters): CancelablePromise<GetTagResponse>

• Get tag details Get details of a specific tag.

  Parameters

  • __namedParameters: {
        companyId: string;
        id: string;
    }

    • companyId: string

      ID of the company

    • id: string

      ID of the tag

  Returns CancelablePromise<GetTagResponse>

  GetTagResponse

  Throws

  ApiError

listTags

• listTags(__namedParameters): CancelablePromise<ListTagsResponse>

• List tags List all tags that belong to a company.

  Parameters

  • __namedParameters: {
        companyId: string;
    }

    • companyId: string

      ID of the company

  Returns CancelablePromise<ListTagsResponse>

  ListTagsResponse

  Throws

  ApiError

updateTag

• updateTag(__namedParameters): CancelablePromise<UpdateTagResponse>

• Update tag Update an existing tag.

  Parameters

  • __namedParameters: {
        companyId: string;
        id: string;
        requestBody: CreateTagRequestBody;
    }

    • companyId: string

      ID of the company

    • id: string

      ID of the tag

    • requestBody: CreateTagRequestBody

  Returns CancelablePromise<UpdateTagResponse>

  UpdateTagResponse

  Throws

  ApiError