From b6605a427524fac42d9d8c67e167aa6c9595cf10 Mon Sep 17 00:00:00 2001 From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com> Date: Wed, 8 Feb 2023 14:19:37 +0000 Subject: [PATCH] fix: add jsdoc comments --- src/models/OnspringClient.ts | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/models/OnspringClient.ts b/src/models/OnspringClient.ts index 55fcfdc..970398d 100644 --- a/src/models/OnspringClient.ts +++ b/src/models/OnspringClient.ts @@ -291,6 +291,12 @@ export class OnspringClient { return apiResponse.asListItemResponseType(); } + /** + * @method deleteListItemById - Deletes a list item by its id. + * @param {number} listId - The id of the list that the list item belongs to. + * @param {string} itemId - The id of the list item to delete. + * @returns {Promise>} - A promise that resolves to an ApiResponse of type any. + */ public async deleteListItemById( listId: number, itemId: string