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 { ); } + /** + * @method AsGetPagedFieldsResponseType - Converts the ApiResponse to an ApiResponse. + * @returns {ApiResponse} - An ApiResponse. + */ public AsGetPagedFieldsResponseType(): ApiResponse { const apiResponse = this as ApiResponse; 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>} - A promise that resolves to an ApiResponse of type GetPagedFieldsResponse. + */ public async getFieldsByAppId( appId: number, pagingRequest: PagingRequest = new PagingRequest(1, 50)