diff --git a/src/models/ListItemResponse.ts b/src/models/ListItemResponse.ts index 4fc8b8b..d68ecac 100644 --- a/src/models/ListItemResponse.ts +++ b/src/models/ListItemResponse.ts @@ -4,6 +4,11 @@ import { CreatedWithIdResponse } from './CreatedWithIdResponse'; * @class ListItemResponse - Represents a respons when a list item is created or updated. */ export class ListItemResponse extends CreatedWithIdResponse { + /** + * @constructor - Creates a new instance of ListItemResponse. + * @param {number} id - The id of the list item. + * @returns {ListItemResponse} - A new instance of ListItemResponse. + */ constructor(id: number) { super(id); } diff --git a/src/models/OnspringClient.ts b/src/models/OnspringClient.ts index e5f6964..3d844c4 100644 --- a/src/models/OnspringClient.ts +++ b/src/models/OnspringClient.ts @@ -310,6 +310,11 @@ export class OnspringClient { return apiResponse; } + /** + * @method getRecordById - Gets a record by its id. + * @param {GetRecordRequest} request - The request that will be used to get the record. + * @returns {Promise>} - A promise that resolves to an ApiResponse of type Record. + */ public async getRecordById( request: GetRecordRequest ): Promise> { diff --git a/src/models/ReportData.ts b/src/models/ReportData.ts index 1cee83f..ed513d6 100644 --- a/src/models/ReportData.ts +++ b/src/models/ReportData.ts @@ -1,9 +1,25 @@ import { type Row } from './Row'; +/** + * @class ReportData - Represents the data for a report. + */ export class ReportData { + /** + * @property {string[]} columns - The columns in the report. + */ public columns: string[]; + + /** + * @property {Row[]} rows - The rows in the report. + */ public rows: Row[]; + /** + * @constructor - Creates a new instance of ReportData. + * @param {string[]} columns - The columns in the report. + * @param {Row[]} rows - The rows in the report. + * @returns {ReportData} - A new instance of ReportData. + */ constructor(columns: string[], rows: Row[]) { this.columns = columns; this.rows = rows;