From 9e464049eb329887fb8733b5dee3084ef645d664 Mon Sep 17 00:00:00 2001
From: StevanFreeborn <sfreeborn7@gmail.com>
Date: Tue, 7 Feb 2023 22:43:06 -0600
Subject: [PATCH] fix: added jsdoc comments

---
 src/models/ApiResponse.ts    | 4 ++++
 src/models/OnspringClient.ts | 5 +++++
 2 files changed, 9 insertions(+)

diff --git a/src/models/ApiResponse.ts b/src/models/ApiResponse.ts
index 20967a4..de1e7d2 100644
--- a/src/models/ApiResponse.ts
+++ b/src/models/ApiResponse.ts
@@ -259,6 +259,10 @@ export class ApiResponse<T> {
     );
   }
 
+  /**
+   * @method asListItemResponseType - Converts the ApiResponse to an ApiResponse<ListItemResponse>.
+   * @returns {ApiResponse<ListItemResponse>} - An ApiResponse<ListItemResponse>.
+   */
   public asListItemResponseType(): ApiResponse<ListItemResponse> {
     const apiResponse = this as ApiResponse<any>;
 
diff --git a/src/models/OnspringClient.ts b/src/models/OnspringClient.ts
index ff6280f..7eab5ef 100644
--- a/src/models/OnspringClient.ts
+++ b/src/models/OnspringClient.ts
@@ -271,6 +271,11 @@ export class OnspringClient {
     return apiResponse;
   }
 
+  /**
+   * @method addOrUpdateListItem - Adds or updates a list item depending on if an id is provided or not.
+   * @param {ListItemRequest} listItemRequest - The request that will be used to add or update the list item.
+   * @returns {Promise<ApiResponse<ListItemResponse>>} - A promise that resolves to an ApiResponse of type ListItemResponse.
+   */
   public async addOrUpdateListItem(
     listItemRequest: ListItemRequest
   ): Promise<ApiResponse<ListItemResponse>> {