fix: add jsdoc comments
This commit is contained in:
@@ -4,6 +4,11 @@ import { CreatedWithIdResponse } from './CreatedWithIdResponse';
|
|||||||
* @class ListItemResponse - Represents a respons when a list item is created or updated.
|
* @class ListItemResponse - Represents a respons when a list item is created or updated.
|
||||||
*/
|
*/
|
||||||
export class ListItemResponse extends CreatedWithIdResponse {
|
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) {
|
constructor(id: number) {
|
||||||
super(id);
|
super(id);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -310,6 +310,11 @@ export class OnspringClient {
|
|||||||
return apiResponse;
|
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<ApiResponse<Record>>} - A promise that resolves to an ApiResponse of type Record.
|
||||||
|
*/
|
||||||
public async getRecordById(
|
public async getRecordById(
|
||||||
request: GetRecordRequest
|
request: GetRecordRequest
|
||||||
): Promise<ApiResponse<Record>> {
|
): Promise<ApiResponse<Record>> {
|
||||||
|
|||||||
@@ -1,9 +1,25 @@
|
|||||||
import { type Row } from './Row';
|
import { type Row } from './Row';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @class ReportData - Represents the data for a report.
|
||||||
|
*/
|
||||||
export class ReportData {
|
export class ReportData {
|
||||||
|
/**
|
||||||
|
* @property {string[]} columns - The columns in the report.
|
||||||
|
*/
|
||||||
public columns: string[];
|
public columns: string[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @property {Row[]} rows - The rows in the report.
|
||||||
|
*/
|
||||||
public rows: Row[];
|
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[]) {
|
constructor(columns: string[], rows: Row[]) {
|
||||||
this.columns = columns;
|
this.columns = columns;
|
||||||
this.rows = rows;
|
this.rows = rows;
|
||||||
|
|||||||
Reference in New Issue
Block a user