fix: added jsdoc comments

This commit is contained in:
StevanFreeborn
2023-02-07 22:43:06 -06:00
parent 190c829dc3
commit 9e464049eb
2 changed files with 9 additions and 0 deletions
+4
View File
@@ -259,6 +259,10 @@ export class ApiResponse<T> {
); );
} }
/**
* @method asListItemResponseType - Converts the ApiResponse to an ApiResponse<ListItemResponse>.
* @returns {ApiResponse<ListItemResponse>} - An ApiResponse<ListItemResponse>.
*/
public asListItemResponseType(): ApiResponse<ListItemResponse> { public asListItemResponseType(): ApiResponse<ListItemResponse> {
const apiResponse = this as ApiResponse<any>; const apiResponse = this as ApiResponse<any>;
+5
View File
@@ -271,6 +271,11 @@ export class OnspringClient {
return apiResponse; return apiResponse;
} }
/**
* @method addOrUpdateListItem - Adds or updates a list item depending on if an id is provided or not.
* @param {ListItemRequest} listItemRequest - The request that will be used to add or update the list item.
* @returns {Promise<ApiResponse<ListItemResponse>>} - A promise that resolves to an ApiResponse of type ListItemResponse.
*/
public async addOrUpdateListItem( public async addOrUpdateListItem(
listItemRequest: ListItemRequest listItemRequest: ListItemRequest
): Promise<ApiResponse<ListItemResponse>> { ): Promise<ApiResponse<ListItemResponse>> {