Package ai.reveng.api

Class CollectionsApi

java.lang.Object

ai.reveng.api.CollectionsApi

public class CollectionsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
CollectionsApi()
CollectionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
BaseResponseCollectionResponse	createCollection(CollectionCreateRequest collectionCreateRequest)	Creates new collection information A collection is a group of binaries that are related in some way.
okhttp3.Call	createCollectionAsync(CollectionCreateRequest collectionCreateRequest, ApiCallback<BaseResponseCollectionResponse> _callback)	Creates new collection information (asynchronously) A collection is a group of binaries that are related in some way.
okhttp3.Call	createCollectionCall(CollectionCreateRequest collectionCreateRequest, ApiCallback _callback)	Build call for createCollection
ApiResponse<BaseResponseCollectionResponse>	createCollectionWithHttpInfo(CollectionCreateRequest collectionCreateRequest)	Creates new collection information A collection is a group of binaries that are related in some way.
BaseResponseBool	deleteCollection(Integer collectionId)	Deletes a collection Deletes a collection
okhttp3.Call	deleteCollectionAsync(Integer collectionId, ApiCallback<BaseResponseBool> _callback)	Deletes a collection (asynchronously) Deletes a collection
okhttp3.Call	deleteCollectionCall(Integer collectionId, ApiCallback _callback)	Build call for deleteCollection
ApiResponse<BaseResponseBool>	deleteCollectionWithHttpInfo(Integer collectionId)	Deletes a collection Deletes a collection
ApiClient	getApiClient()
BaseResponseCollectionResponse	getCollection(Integer collectionId, Boolean includeTags, Boolean includeBinaries)	Returns a collection Gets a single collection.
okhttp3.Call	getCollectionAsync(Integer collectionId, Boolean includeTags, Boolean includeBinaries, ApiCallback<BaseResponseCollectionResponse> _callback)	Returns a collection (asynchronously) Gets a single collection.
okhttp3.Call	getCollectionCall(Integer collectionId, Boolean includeTags, Boolean includeBinaries, ApiCallback _callback)	Build call for getCollection
ApiResponse<BaseResponseCollectionResponse>	getCollectionWithHttpInfo(Integer collectionId, Boolean includeTags, Boolean includeBinaries)	Returns a collection Gets a single collection.
String	getCustomBaseUrl()
int	getHostIndex()
BaseResponseListCollectionResults	listCollections(String searchTerm, List<Filters> filters, Integer limit, Integer offset, AppApiRestV2CollectionsEnumsOrderBy orderBy, Order order)	Gets basic collections information Returns a list of collections
okhttp3.Call	listCollectionsAsync(String searchTerm, List<Filters> filters, Integer limit, Integer offset, AppApiRestV2CollectionsEnumsOrderBy orderBy, Order order, ApiCallback<BaseResponseListCollectionResults> _callback)	Gets basic collections information (asynchronously) Returns a list of collections
okhttp3.Call	listCollectionsCall(String searchTerm, List<Filters> filters, Integer limit, Integer offset, AppApiRestV2CollectionsEnumsOrderBy orderBy, Order order, ApiCallback _callback)	Build call for listCollections
ApiResponse<BaseResponseListCollectionResults>	listCollectionsWithHttpInfo(String searchTerm, List<Filters> filters, Integer limit, Integer offset, AppApiRestV2CollectionsEnumsOrderBy orderBy, Order order)	Gets basic collections information Returns a list of collections
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
BaseResponseCollectionResponse	updateCollection(Integer collectionId, CollectionUpdateRequest collectionUpdateRequest)	Updates a collection Updates a collection, you can update the collection name, description, and scope
okhttp3.Call	updateCollectionAsync(Integer collectionId, CollectionUpdateRequest collectionUpdateRequest, ApiCallback<BaseResponseCollectionResponse> _callback)	Updates a collection (asynchronously) Updates a collection, you can update the collection name, description, and scope
BaseResponseCollectionBinariesUpdateResponse	updateCollectionBinaries(Integer collectionId, CollectionBinariesUpdateRequest collectionBinariesUpdateRequest)	Updates a collection binaries Updates/changes a collection binaries to whatever is provided in the request.
okhttp3.Call	updateCollectionBinariesAsync(Integer collectionId, CollectionBinariesUpdateRequest collectionBinariesUpdateRequest, ApiCallback<BaseResponseCollectionBinariesUpdateResponse> _callback)	Updates a collection binaries (asynchronously) Updates/changes a collection binaries to whatever is provided in the request.
okhttp3.Call	updateCollectionBinariesCall(Integer collectionId, CollectionBinariesUpdateRequest collectionBinariesUpdateRequest, ApiCallback _callback)	Build call for updateCollectionBinaries
ApiResponse<BaseResponseCollectionBinariesUpdateResponse>	updateCollectionBinariesWithHttpInfo(Integer collectionId, CollectionBinariesUpdateRequest collectionBinariesUpdateRequest)	Updates a collection binaries Updates/changes a collection binaries to whatever is provided in the request.
okhttp3.Call	updateCollectionCall(Integer collectionId, CollectionUpdateRequest collectionUpdateRequest, ApiCallback _callback)	Build call for updateCollection
BaseResponseCollectionTagsUpdateResponse	updateCollectionTags(Integer collectionId, CollectionTagsUpdateRequest collectionTagsUpdateRequest)	Updates a collection tags Updates/changes a collection tags to whatever is provided in the request.
okhttp3.Call	updateCollectionTagsAsync(Integer collectionId, CollectionTagsUpdateRequest collectionTagsUpdateRequest, ApiCallback<BaseResponseCollectionTagsUpdateResponse> _callback)	Updates a collection tags (asynchronously) Updates/changes a collection tags to whatever is provided in the request.
okhttp3.Call	updateCollectionTagsCall(Integer collectionId, CollectionTagsUpdateRequest collectionTagsUpdateRequest, ApiCallback _callback)	Build call for updateCollectionTags
ApiResponse<BaseResponseCollectionTagsUpdateResponse>	updateCollectionTagsWithHttpInfo(Integer collectionId, CollectionTagsUpdateRequest collectionTagsUpdateRequest)	Updates a collection tags Updates/changes a collection tags to whatever is provided in the request.
ApiResponse<BaseResponseCollectionResponse>	updateCollectionWithHttpInfo(Integer collectionId, CollectionUpdateRequest collectionUpdateRequest)	Updates a collection Updates a collection, you can update the collection name, description, and scope

Methods inherited from class java.lang.Object

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

Constructor Details

CollectionsApi

public CollectionsApi()

CollectionsApi

public CollectionsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createCollectionCall

public okhttp3.Call createCollectionCall(@Nonnull
 CollectionCreateRequest collectionCreateRequest,
 ApiCallback _callback)
                                  throws ApiException

Build call for createCollection

Parameters:

collectionCreateRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

createCollection

public BaseResponseCollectionResponse createCollection(@Nonnull
 CollectionCreateRequest collectionCreateRequest)
                                                throws ApiException

Creates new collection information A collection is a group of binaries that are related in some way. This endpoint creates a new collection and allows you to add tags and binaries to it. If you add tags or binaries to the collection, they will be returned in the response.

Parameters:

collectionCreateRequest - (required)

Returns:

BaseResponseCollectionResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

createCollectionWithHttpInfo

public ApiResponse<BaseResponseCollectionResponse> createCollectionWithHttpInfo(@Nonnull
 CollectionCreateRequest collectionCreateRequest)
                                                                         throws ApiException

Creates new collection information A collection is a group of binaries that are related in some way. This endpoint creates a new collection and allows you to add tags and binaries to it. If you add tags or binaries to the collection, they will be returned in the response.

Parameters:

collectionCreateRequest - (required)

Returns:

ApiResponse<BaseResponseCollectionResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

createCollectionAsync

public okhttp3.Call createCollectionAsync(@Nonnull
 CollectionCreateRequest collectionCreateRequest,
 ApiCallback<BaseResponseCollectionResponse> _callback)
                                   throws ApiException

Creates new collection information (asynchronously) A collection is a group of binaries that are related in some way. This endpoint creates a new collection and allows you to add tags and binaries to it. If you add tags or binaries to the collection, they will be returned in the response.

Parameters:

collectionCreateRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

deleteCollectionCall

public okhttp3.Call deleteCollectionCall(@Nonnull
 Integer collectionId,
 ApiCallback _callback)
                                  throws ApiException

Build call for deleteCollection

Parameters:

collectionId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

deleteCollection

public BaseResponseBool deleteCollection(@Nonnull
 Integer collectionId)
                                  throws ApiException

Deletes a collection Deletes a collection

Parameters:

collectionId - (required)

Returns:

BaseResponseBool

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

deleteCollectionWithHttpInfo

public ApiResponse<BaseResponseBool> deleteCollectionWithHttpInfo(@Nonnull
 Integer collectionId)
                                                           throws ApiException

Deletes a collection Deletes a collection

Parameters:

collectionId - (required)

Returns:

ApiResponse<BaseResponseBool>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

deleteCollectionAsync

public okhttp3.Call deleteCollectionAsync(@Nonnull
 Integer collectionId,
 ApiCallback<BaseResponseBool> _callback)
                                   throws ApiException

Deletes a collection (asynchronously) Deletes a collection

Parameters:

collectionId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

getCollectionCall

public okhttp3.Call getCollectionCall(@Nonnull
 Integer collectionId,
 @Nullable
 Boolean includeTags,
 @Nullable
 Boolean includeBinaries,
 ApiCallback _callback)
                               throws ApiException

Build call for getCollection

Parameters:

collectionId - (required)

includeTags - (optional, default to false)

includeBinaries - (optional, default to false)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

getCollection

public BaseResponseCollectionResponse getCollection(@Nonnull
 Integer collectionId,
 @Nullable
 Boolean includeTags,
 @Nullable
 Boolean includeBinaries)
                                             throws ApiException

Returns a collection Gets a single collection. The collection can include binaries and tags if requested. You can specify whether to include tags and binaries in the response by using the query string parameters defined.

Parameters:

collectionId - (required)

includeTags - (optional, default to false)

includeBinaries - (optional, default to false)

Returns:

BaseResponseCollectionResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

getCollectionWithHttpInfo

public ApiResponse<BaseResponseCollectionResponse> getCollectionWithHttpInfo(@Nonnull
 Integer collectionId,
 @Nullable
 Boolean includeTags,
 @Nullable
 Boolean includeBinaries)
                                                                      throws ApiException

Returns a collection Gets a single collection. The collection can include binaries and tags if requested. You can specify whether to include tags and binaries in the response by using the query string parameters defined.

Parameters:

collectionId - (required)

includeTags - (optional, default to false)

includeBinaries - (optional, default to false)

Returns:

ApiResponse<BaseResponseCollectionResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

getCollectionAsync

public okhttp3.Call getCollectionAsync(@Nonnull
 Integer collectionId,
 @Nullable
 Boolean includeTags,
 @Nullable
 Boolean includeBinaries,
 ApiCallback<BaseResponseCollectionResponse> _callback)
                                throws ApiException

Returns a collection (asynchronously) Gets a single collection. The collection can include binaries and tags if requested. You can specify whether to include tags and binaries in the response by using the query string parameters defined.

Parameters:

collectionId - (required)

includeTags - (optional, default to false)

includeBinaries - (optional, default to false)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

listCollectionsCall

public okhttp3.Call listCollectionsCall(@Nullable
 String searchTerm,
 @Nullable
 List<Filters> filters,
 @Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 AppApiRestV2CollectionsEnumsOrderBy orderBy,
 @Nullable
 Order order,
 ApiCallback _callback)
                                 throws ApiException

Build call for listCollections

Parameters:

searchTerm - (optional, default to )

filters - (optional)

limit - (optional, default to 20)

offset - (optional, default to 0)

orderBy - (optional)

order - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

listCollections

public BaseResponseListCollectionResults listCollections(@Nullable
 String searchTerm,
 @Nullable
 List<Filters> filters,
 @Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 AppApiRestV2CollectionsEnumsOrderBy orderBy,
 @Nullable
 Order order)
                                                  throws ApiException

Gets basic collections information Returns a list of collections

Parameters:

searchTerm - (optional, default to )

filters - (optional)

limit - (optional, default to 20)

offset - (optional, default to 0)

orderBy - (optional)

order - (optional)

Returns:

BaseResponseListCollectionResults

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

listCollectionsWithHttpInfo

public ApiResponse<BaseResponseListCollectionResults> listCollectionsWithHttpInfo(@Nullable
 String searchTerm,
 @Nullable
 List<Filters> filters,
 @Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 AppApiRestV2CollectionsEnumsOrderBy orderBy,
 @Nullable
 Order order)
                                                                           throws ApiException

Gets basic collections information Returns a list of collections

Parameters:

searchTerm - (optional, default to )

filters - (optional)

limit - (optional, default to 20)

offset - (optional, default to 0)

orderBy - (optional)

order - (optional)

Returns:

ApiResponse<BaseResponseListCollectionResults>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

listCollectionsAsync

public okhttp3.Call listCollectionsAsync(@Nullable
 String searchTerm,
 @Nullable
 List<Filters> filters,
 @Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 AppApiRestV2CollectionsEnumsOrderBy orderBy,
 @Nullable
 Order order,
 ApiCallback<BaseResponseListCollectionResults> _callback)
                                  throws ApiException

Gets basic collections information (asynchronously) Returns a list of collections

Parameters:

searchTerm - (optional, default to )

filters - (optional)

limit - (optional, default to 20)

offset - (optional, default to 0)

orderBy - (optional)

order - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

updateCollectionCall

public okhttp3.Call updateCollectionCall(@Nonnull
 Integer collectionId,
 @Nonnull
 CollectionUpdateRequest collectionUpdateRequest,
 ApiCallback _callback)
                                  throws ApiException

Build call for updateCollection

Parameters:

collectionId - (required)

collectionUpdateRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

updateCollection

public BaseResponseCollectionResponse updateCollection(@Nonnull
 Integer collectionId,
 @Nonnull
 CollectionUpdateRequest collectionUpdateRequest)
                                                throws ApiException

Updates a collection Updates a collection, you can update the collection name, description, and scope

Parameters:

collectionId - (required)

collectionUpdateRequest - (required)

Returns:

BaseResponseCollectionResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

updateCollectionWithHttpInfo

public ApiResponse<BaseResponseCollectionResponse> updateCollectionWithHttpInfo(@Nonnull
 Integer collectionId,
 @Nonnull
 CollectionUpdateRequest collectionUpdateRequest)
                                                                         throws ApiException

Updates a collection Updates a collection, you can update the collection name, description, and scope

Parameters:

collectionId - (required)

collectionUpdateRequest - (required)

Returns:

ApiResponse<BaseResponseCollectionResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

updateCollectionAsync

public okhttp3.Call updateCollectionAsync(@Nonnull
 Integer collectionId,
 @Nonnull
 CollectionUpdateRequest collectionUpdateRequest,
 ApiCallback<BaseResponseCollectionResponse> _callback)
                                   throws ApiException

Updates a collection (asynchronously) Updates a collection, you can update the collection name, description, and scope

Parameters:

collectionId - (required)

collectionUpdateRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

updateCollectionBinariesCall

public okhttp3.Call updateCollectionBinariesCall(@Nonnull
 Integer collectionId,
 @Nonnull
 CollectionBinariesUpdateRequest collectionBinariesUpdateRequest,
 ApiCallback _callback)
                                          throws ApiException

Build call for updateCollectionBinaries

Parameters:

collectionId - (required)

collectionBinariesUpdateRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

updateCollectionBinaries

public BaseResponseCollectionBinariesUpdateResponse updateCollectionBinaries(@Nonnull
 Integer collectionId,
 @Nonnull
 CollectionBinariesUpdateRequest collectionBinariesUpdateRequest)
                                                                      throws ApiException

Updates a collection binaries Updates/changes a collection binaries to whatever is provided in the request. After this update the collection will only contain the binaries provided in the request.

Parameters:

collectionId - (required)

collectionBinariesUpdateRequest - (required)

Returns:

BaseResponseCollectionBinariesUpdateResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

updateCollectionBinariesWithHttpInfo

public ApiResponse<BaseResponseCollectionBinariesUpdateResponse> updateCollectionBinariesWithHttpInfo(@Nonnull
 Integer collectionId,
 @Nonnull
 CollectionBinariesUpdateRequest collectionBinariesUpdateRequest)
                                                                                               throws ApiException

Updates a collection binaries Updates/changes a collection binaries to whatever is provided in the request. After this update the collection will only contain the binaries provided in the request.

Parameters:

collectionId - (required)

collectionBinariesUpdateRequest - (required)

Returns:

ApiResponse<BaseResponseCollectionBinariesUpdateResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

updateCollectionBinariesAsync

public okhttp3.Call updateCollectionBinariesAsync(@Nonnull
 Integer collectionId,
 @Nonnull
 CollectionBinariesUpdateRequest collectionBinariesUpdateRequest,
 ApiCallback<BaseResponseCollectionBinariesUpdateResponse> _callback)
                                           throws ApiException

Updates a collection binaries (asynchronously) Updates/changes a collection binaries to whatever is provided in the request. After this update the collection will only contain the binaries provided in the request.

Parameters:

collectionId - (required)

collectionBinariesUpdateRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

updateCollectionTagsCall

public okhttp3.Call updateCollectionTagsCall(@Nonnull
 Integer collectionId,
 @Nonnull
 CollectionTagsUpdateRequest collectionTagsUpdateRequest,
 ApiCallback _callback)
                                      throws ApiException

Build call for updateCollectionTags

Parameters:

collectionId - (required)

collectionTagsUpdateRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

updateCollectionTags

public BaseResponseCollectionTagsUpdateResponse updateCollectionTags(@Nonnull
 Integer collectionId,
 @Nonnull
 CollectionTagsUpdateRequest collectionTagsUpdateRequest)
                                                              throws ApiException

Updates a collection tags Updates/changes a collection tags to whatever is provided in the request. After this update the collection will only contain the tags provided in the request.

Parameters:

collectionId - (required)

collectionTagsUpdateRequest - (required)

Returns:

BaseResponseCollectionTagsUpdateResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

updateCollectionTagsWithHttpInfo

public ApiResponse<BaseResponseCollectionTagsUpdateResponse> updateCollectionTagsWithHttpInfo(@Nonnull
 Integer collectionId,
 @Nonnull
 CollectionTagsUpdateRequest collectionTagsUpdateRequest)
                                                                                       throws ApiException

Updates a collection tags Updates/changes a collection tags to whatever is provided in the request. After this update the collection will only contain the tags provided in the request.

Parameters:

collectionId - (required)

collectionTagsUpdateRequest - (required)

Returns:

ApiResponse<BaseResponseCollectionTagsUpdateResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-

updateCollectionTagsAsync

public okhttp3.Call updateCollectionTagsAsync(@Nonnull
 Integer collectionId,
 @Nonnull
 CollectionTagsUpdateRequest collectionTagsUpdateRequest,
 ApiCallback<BaseResponseCollectionTagsUpdateResponse> _callback)
                                       throws ApiException

Updates a collection tags (asynchronously) Updates/changes a collection tags to whatever is provided in the request. After this update the collection will only contain the tags provided in the request.

Parameters:

collectionId - (required)

collectionTagsUpdateRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Successful Response	-
422	Invalid request parameters	-