From 5e80aaa128b2d2d84e8188bb0e36d7c11f9856a6 Mon Sep 17 00:00:00 2001
From: StevanFreeborn <sfreeborn7@gmail.com>
Date: Fri, 3 Feb 2023 13:00:09 -0600
Subject: [PATCH] fix: added JSDoc comments for getFieldsByAppId implementation

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

diff --git a/src/models/ApiResponse.ts b/src/models/ApiResponse.ts
index 5f4cbd1..a21d6e0 100644
--- a/src/models/ApiResponse.ts
+++ b/src/models/ApiResponse.ts
@@ -166,6 +166,10 @@ export class ApiResponse<T> {
     );
   }
 
+  /**
+   * @method AsGetPagedFieldsResponseType - Converts the ApiResponse to an ApiResponse<GetPagedFieldsResponse>.
+   * @returns {ApiResponse<GetPagedFieldsResponse>} - An ApiResponse<GetPagedFieldsResponse>.
+   */
   public AsGetPagedFieldsResponseType(): ApiResponse<GetPagedFieldsResponse> {
     const apiResponse = this as ApiResponse<any>;
 
diff --git a/src/models/OnspringClient.ts b/src/models/OnspringClient.ts
index 2b862ef..40cf193 100644
--- a/src/models/OnspringClient.ts
+++ b/src/models/OnspringClient.ts
@@ -146,6 +146,12 @@ export class OnspringClient {
     return apiResponse.AsFieldCollectionType();
   }
 
+  /**
+   * @method getFieldsByAppId - Gets a paged list of fields by an app id.
+   * @param {number} appId - The id of the app to get the fields for.
+   * @param {PagingRequest} pagingRequest - The paging request that will be used to get the fields.
+   * @returns {Promise<ApiResponse<GetPagedFieldsResponse>>} - A promise that resolves to an ApiResponse of type GetPagedFieldsResponse.
+   */
   public async getFieldsByAppId(
     appId: number,
     pagingRequest: PagingRequest = new PagingRequest(1, 50)