net.leanix.api

Class BookmarksApi

java.lang.Object

net.leanix.api.BookmarksApi

public class BookmarksApi
extends Object

Constructor Summary

Constructors

Constructor and Description
BookmarksApi()
BookmarksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
BookmarkResponse	createBookmark(Bookmark body) createBookmark Saves a bookmark in the database
void	deleteBookmark(UUID id) deleteBookmark Deletes a bookmark identified by the given ID
BookmarkResponse	deleteWorkingCopy(UUID id) deleteWorkingCopy Deletes a working copy for a bookmark stored in the database
ApiClient	getApiClient()
BookmarkResponse	getBookmark(UUID id, Boolean markAsViewed) getBookmark Retrieves a bookmark by ID
BookmarkListResponse	getBookmarks(String bookmarkType, String groupKey) getBookmarks Retrieves all stored bookmarks a user can read.
void	setApiClient(ApiClient apiClient)
BookmarkResponse	updateBookmark(UUID id, Bookmark body) updateBookmark Updates a bookmark stored in the database
BookmarkResponse	updateWorkingCopy(UUID id, BookmarkWorkingCopy body) updateWorkingCopy Updates a working copy for a bookmark stored in the database

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BookmarksApi

public BookmarksApi()

BookmarksApi

public BookmarksApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createBookmark

public BookmarkResponse createBookmark(Bookmark body)
                                throws ApiException

createBookmark Saves a bookmark in the database

Parameters:

body - bookmark (optional)

Returns:

BookmarkResponse

Throws:

ApiException - if fails to make API call

deleteBookmark

public void deleteBookmark(UUID id)
                    throws ApiException

deleteBookmark Deletes a bookmark identified by the given ID

Parameters:

id - (required)

Throws:

ApiException - if fails to make API call

deleteWorkingCopy

public BookmarkResponse deleteWorkingCopy(UUID id)
                                   throws ApiException

deleteWorkingCopy Deletes a working copy for a bookmark stored in the database

Parameters:

id - (required)

Returns:

BookmarkResponse

Throws:

ApiException - if fails to make API call

getBookmark

public BookmarkResponse getBookmark(UUID id,
                                    Boolean markAsViewed)
                             throws ApiException

getBookmark Retrieves a bookmark by ID

Parameters:

id - (required)

markAsViewed - (optional, default to true)

Returns:

BookmarkResponse

Throws:

ApiException - if fails to make API call

getBookmarks

public BookmarkListResponse getBookmarks(String bookmarkType,
                                         String groupKey)
                                  throws ApiException

getBookmarks Retrieves all stored bookmarks a user can read.

Parameters:

bookmarkType - Specifies the bookmark type (required)

groupKey - A key used to separate bookmarks within the same query type (optional)

Returns:

BookmarkListResponse

Throws:

ApiException - if fails to make API call

updateBookmark

public BookmarkResponse updateBookmark(UUID id,
                                       Bookmark body)
                                throws ApiException

updateBookmark Updates a bookmark stored in the database

Parameters:

id - (required)

body - bookmark (optional)

Returns:

BookmarkResponse

Throws:

ApiException - if fails to make API call

updateWorkingCopy

public BookmarkResponse updateWorkingCopy(UUID id,
                                          BookmarkWorkingCopy body)
                                   throws ApiException

updateWorkingCopy Updates a working copy for a bookmark stored in the database

Parameters:

id - (required)

body - workingCopy (optional)

Returns:

BookmarkResponse

Throws:

ApiException - if fails to make API call