net.leanix.api

Class BookmarkSharesApi

java.lang.Object

net.leanix.api.BookmarkSharesApi

public class BookmarkSharesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
BookmarkSharesApi()
BookmarkSharesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
BookmarkSharesResponse	createBookmarkShare(BookmarkShareInputData bookmarkShare) createBookmarkShares Saves a bookmark share in the database
void	deleteBookmarkShare(UUID bookmarkId, UUID sharedWithUserId) deleteBookmarkShares Deletes a bookmark share by the calling user.
ApiClient	getApiClient()
BookmarkSharesResponse	getBookmarkShares(UUID bookmarkId) getBookmarkShares Retrieves all stored bookmark shared by the calling user.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

BookmarkSharesApi

public BookmarkSharesApi()

BookmarkSharesApi

public BookmarkSharesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createBookmarkShare

public BookmarkSharesResponse createBookmarkShare(BookmarkShareInputData bookmarkShare)
                                           throws ApiException

createBookmarkShares Saves a bookmark share in the database

Parameters:

bookmarkShare - Field SharedByUserId, if set, needs to be same as the calling user's id. (optional)

Returns:

BookmarkSharesResponse

Throws:

ApiException - if fails to make API call

deleteBookmarkShare

public void deleteBookmarkShare(UUID bookmarkId,
                                UUID sharedWithUserId)
                         throws ApiException

deleteBookmarkShares Deletes a bookmark share by the calling user.

Parameters:

bookmarkId - Specifies the bookmark id (required)

sharedWithUserId - Specifies the sharedWith userId (required)

Throws:

ApiException - if fails to make API call

getBookmarkShares

public BookmarkSharesResponse getBookmarkShares(UUID bookmarkId)
                                         throws ApiException

getBookmarkShares Retrieves all stored bookmark shared by the calling user.

Parameters:

bookmarkId - Specifies the bookmark id (required)

Returns:

BookmarkSharesResponse

Throws:

ApiException - if fails to make API call