fix: added JSDoc comments for getFieldsByAppId implementation

This commit is contained in:
StevanFreeborn
2023-02-03 13:00:09 -06:00
parent 9cd2495b44
commit 5e80aaa128
2 changed files with 10 additions and 0 deletions
+4
View File
@@ -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>;
+6
View File
@@ -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)