diff --git a/src/models/ApiResponse.ts b/src/models/ApiResponse.ts index 8c4119a..bcadc97 100644 --- a/src/models/ApiResponse.ts +++ b/src/models/ApiResponse.ts @@ -134,6 +134,10 @@ export class ApiResponse { ); } + /** + * @method AsFieldCollectionType - Converts the ApiResponse to an ApiResponse>. + * @returns {ApiResponse>} - An ApiResponse>. + */ public AsFieldCollectionType(): ApiResponse> { const apiResponse = this as ApiResponse; diff --git a/src/models/OnspringClient.ts b/src/models/OnspringClient.ts index d7c0343..7dbd4e6 100644 --- a/src/models/OnspringClient.ts +++ b/src/models/OnspringClient.ts @@ -112,6 +112,7 @@ export class OnspringClient { /** * @method getFieldById - Gets a field by its id. + * @param {number} fieldId - The id of the field to get. * @returns {Promise>} - A promise that resolves to an ApiResponse of type Field. */ public async getFieldById(fieldId: number): Promise> { @@ -125,6 +126,11 @@ export class OnspringClient { return apiResponse.AsFieldType(); } + /** + * @method getFieldsByIds - Gets a list of fields by their ids. + * @param {number[]} fieldIds - The ids of the fields to get. + * @returns {Promise>>} - A promise that resolves to an ApiResponse of type CollectionResponse. + */ public async getFieldsByIds( fieldIds: number[] ): Promise>> {