feat: Adds new shared labels endpoints and functions

Author: scottlovegrove

src/TodoistApi.ts

@@ -24,6 +24,8 @@ import {
     UpdateSectionArgs,
     UpdateTaskArgs,
     QuickAddTaskArgs,
+    RenameSharedLabelArgs,
+    RemoveSharedLabelArgs,
 } from './types/requests'
 import { request, isSuccess } from './restClient'
 import { getTaskFromQuickAddResponse } from './utils/taskConverters'
@@ -39,6 +41,9 @@ import {
     ENDPOINT_REST_PROJECT_COLLABORATORS,
     ENDPOINT_REST_SECTIONS,
     ENDPOINT_REST_COMMENTS,
+    ENDPOINT_REST_LABELS_SHARED,
+    ENDPOINT_REST_LABELS_SHARED_RENAME,
+    ENDPOINT_REST_LABELS_SHARED_REMOVE,
 } from './consts/endpoints'
 import {
     validateComment,
@@ -313,6 +318,9 @@ export class TodoistApi {
         return isSuccess(response)
     }
 
+    /**
+     * Fetches a personal label
+     */
     async getLabel(id: number): Promise<Label> {
         Int.check(id)
         const response = await request<Label>(
@@ -325,6 +333,9 @@ export class TodoistApi {
         return validateLabel(response.data)
     }
 
+    /**
+     * Fetches the personal labels
+     */
     async getLabels(): Promise<Label[]> {
         const response = await request<Label[]>(
             'GET',
@@ -336,6 +347,9 @@ export class TodoistApi {
         return validateLabelArray(response.data)
     }
 
+    /**
+     * Adds a personal label
+     */
     async addLabel(args: AddLabelArgs, requestId?: string): Promise<Label> {
         const response = await request<Label>(
             'POST',
@@ -349,6 +363,9 @@ export class TodoistApi {
         return validateLabel(response.data)
     }
 
+    /**
+     * Updates a personal label
+     */
     async updateLabel(id: number, args: UpdateLabelArgs, requestId?: string): Promise<boolean> {
         Int.check(id)
         const response = await request(
@@ -362,6 +379,9 @@ export class TodoistApi {
         return isSuccess(response)
     }
 
+    /**
+     * Deletes a personal label
+     */
     async deleteLabel(id: number, requestId?: string): Promise<boolean> {
         Int.check(id)
         const response = await request(
@@ -375,6 +395,37 @@ export class TodoistApi {
         return isSuccess(response)
     }
 
+    async getSharedLabels(): Promise<string[]> {
+        const response = await request<string[]>(
+            'GET',
+            API_REST_BASE_URI,
+            ENDPOINT_REST_LABELS_SHARED,
+            this.authToken,
+        )
+
+        return response.data
+    }
+
+    async renameSharedLabel(args: RenameSharedLabelArgs): Promise<void> {
+        await request<void>(
+            'POST',
+            API_REST_BASE_URI,
+            ENDPOINT_REST_LABELS_SHARED_RENAME,
+            this.authToken,
+            args,
+        )
+    }
+
+    async removeSharedLabel(args: RemoveSharedLabelArgs): Promise<void> {
+        await request<void>(
+            'POST',
+            API_REST_BASE_URI,
+            ENDPOINT_REST_LABELS_SHARED_REMOVE,
+            this.authToken,
+            args,
+        )
+    }
+
     async getComments(args: GetTaskCommentsArgs | GetProjectCommentsArgs): Promise<Comment[]> {
         const response = await request<Comment[]>(
             'GET',

src/consts/endpoints.ts

@@ -6,6 +6,9 @@ export const ENDPOINT_REST_TASKS = 'tasks'
 export const ENDPOINT_REST_PROJECTS = 'projects'
 export const ENDPOINT_REST_SECTIONS = 'sections'
 export const ENDPOINT_REST_LABELS = 'labels'
+export const ENDPOINT_REST_LABELS_SHARED = ENDPOINT_REST_LABELS + '/shared'
+export const ENDPOINT_REST_LABELS_SHARED_RENAME = ENDPOINT_REST_LABELS_SHARED + '/rename'
+export const ENDPOINT_REST_LABELS_SHARED_REMOVE = ENDPOINT_REST_LABELS_SHARED + '/remove'
 export const ENDPOINT_REST_COMMENTS = 'comments'
 export const ENDPOINT_REST_TASK_CLOSE = 'close'
 export const ENDPOINT_REST_TASK_REOPEN = 'reopen'