fix: added JSDoc comments for getFieldsByAppId implementation
This commit is contained in:
@@ -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> {
|
public AsGetPagedFieldsResponseType(): ApiResponse<GetPagedFieldsResponse> {
|
||||||
const apiResponse = this as ApiResponse<any>;
|
const apiResponse = this as ApiResponse<any>;
|
||||||
|
|
||||||
|
|||||||
@@ -146,6 +146,12 @@ export class OnspringClient {
|
|||||||
return apiResponse.AsFieldCollectionType();
|
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(
|
public async getFieldsByAppId(
|
||||||
appId: number,
|
appId: number,
|
||||||
pagingRequest: PagingRequest = new PagingRequest(1, 50)
|
pagingRequest: PagingRequest = new PagingRequest(1, 50)
|
||||||
|
|||||||
Reference in New Issue
Block a user