Package ai.reveng.api

Class CollectionsApi

java.lang.Object
ai.reveng.api.CollectionsApi
public class CollectionsApi extends Object

  • 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

      @Deprecated public okhttp3.Call createCollectionCall(@Nonnull CollectionCreateRequest collectionCreateRequest, ApiCallback _callback) throws ApiException
      Deprecated.
      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

      @Deprecated public BaseResponseCollectionResponse createCollection(@Nonnull CollectionCreateRequest collectionCreateRequest) throws ApiException
      Deprecated.
      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

      @Deprecated public ApiResponse<BaseResponseCollectionResponse> createCollectionWithHttpInfo(@Nonnull CollectionCreateRequest collectionCreateRequest) throws ApiException
      Deprecated.
      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

      @Deprecated public okhttp3.Call createCollectionAsync(@Nonnull CollectionCreateRequest collectionCreateRequest, ApiCallback<BaseResponseCollectionResponse> _callback) throws ApiException
      Deprecated.
      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

      @Deprecated public okhttp3.Call deleteCollectionCall(@Nonnull Integer collectionId, ApiCallback _callback) throws ApiException
      Deprecated.
      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

      @Deprecated public BaseResponseBool deleteCollection(@Nonnull Integer collectionId) throws ApiException
      Deprecated.
      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

      @Deprecated public ApiResponse<BaseResponseBool> deleteCollectionWithHttpInfo(@Nonnull Integer collectionId) throws ApiException
      Deprecated.
      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

      @Deprecated public okhttp3.Call deleteCollectionAsync(@Nonnull Integer collectionId, ApiCallback<BaseResponseBool> _callback) throws ApiException
      Deprecated.
      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

      @Deprecated public okhttp3.Call getCollectionCall(@Nonnull Integer collectionId, @Nullable Boolean includeTags, @Nullable Boolean includeBinaries, @Nullable Integer pageSize, @Nullable Integer pageNumber, @Nullable String binarySearchStr, ApiCallback _callback) throws ApiException
      Deprecated.
      Build call for getCollection
      Parameters:
      collectionId - (required)
      includeTags - (optional, default to false)
      includeBinaries - (optional, default to false)
      pageSize - (optional, default to 10)
      pageNumber - (optional, default to 1)
      binarySearchStr - (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 -

    • getCollection

      @Deprecated public BaseResponseCollectionResponse getCollection(@Nonnull Integer collectionId, @Nullable Boolean includeTags, @Nullable Boolean includeBinaries, @Nullable Integer pageSize, @Nullable Integer pageNumber, @Nullable String binarySearchStr) throws ApiException
      Deprecated.
      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)
      pageSize - (optional, default to 10)
      pageNumber - (optional, default to 1)
      binarySearchStr - (optional)
      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

      @Deprecated public ApiResponse<BaseResponseCollectionResponse> getCollectionWithHttpInfo(@Nonnull Integer collectionId, @Nullable Boolean includeTags, @Nullable Boolean includeBinaries, @Nullable Integer pageSize, @Nullable Integer pageNumber, @Nullable String binarySearchStr) throws ApiException
      Deprecated.
      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)
      pageSize - (optional, default to 10)
      pageNumber - (optional, default to 1)
      binarySearchStr - (optional)
      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

      @Deprecated public okhttp3.Call getCollectionAsync(@Nonnull Integer collectionId, @Nullable Boolean includeTags, @Nullable Boolean includeBinaries, @Nullable Integer pageSize, @Nullable Integer pageNumber, @Nullable String binarySearchStr, ApiCallback<BaseResponseCollectionResponse> _callback) throws ApiException
      Deprecated.
      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)
      pageSize - (optional, default to 10)
      pageNumber - (optional, default to 1)
      binarySearchStr - (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 -

    • listCollectionsCall

      @Deprecated 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
      Deprecated.
      Build call for listCollections
      Parameters:
      searchTerm - (optional, default to )
      filters - (optional)
      limit - (optional, default to 20)
      offset - (optional, default to 0)
      orderBy - (optional, default to collection)
      order - (optional, default to ASC)
      _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

      @Deprecated public BaseResponseListCollectionResults listCollections(@Nullable String searchTerm, @Nullable List<Filters> filters, @Nullable Integer limit, @Nullable Integer offset, @Nullable AppApiRestV2CollectionsEnumsOrderBy orderBy, @Nullable Order order) throws ApiException
      Deprecated.
      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, default to collection)
      order - (optional, default to ASC)
      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

      @Deprecated 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
      Deprecated.
      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, default to collection)
      order - (optional, default to ASC)
      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

      @Deprecated 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
      Deprecated.
      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, default to collection)
      order - (optional, default to ASC)
      _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

      @Deprecated public okhttp3.Call updateCollectionCall(@Nonnull Integer collectionId, @Nonnull CollectionUpdateRequest collectionUpdateRequest, ApiCallback _callback) throws ApiException
      Deprecated.
      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

      @Deprecated public BaseResponseCollectionResponse updateCollection(@Nonnull Integer collectionId, @Nonnull CollectionUpdateRequest collectionUpdateRequest) throws ApiException
      Deprecated.
      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

      @Deprecated public ApiResponse<BaseResponseCollectionResponse> updateCollectionWithHttpInfo(@Nonnull Integer collectionId, @Nonnull CollectionUpdateRequest collectionUpdateRequest) throws ApiException
      Deprecated.
      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

      @Deprecated public okhttp3.Call updateCollectionAsync(@Nonnull Integer collectionId, @Nonnull CollectionUpdateRequest collectionUpdateRequest, ApiCallback<BaseResponseCollectionResponse> _callback) throws ApiException
      Deprecated.
      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

      @Deprecated public okhttp3.Call updateCollectionBinariesCall(@Nonnull Integer collectionId, @Nonnull CollectionBinariesUpdateRequest collectionBinariesUpdateRequest, ApiCallback _callback) throws ApiException
      Deprecated.
      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

      @Deprecated public BaseResponseCollectionBinariesUpdateResponse updateCollectionBinaries(@Nonnull Integer collectionId, @Nonnull CollectionBinariesUpdateRequest collectionBinariesUpdateRequest) throws ApiException
      Deprecated.
      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

      @Deprecated public ApiResponse<BaseResponseCollectionBinariesUpdateResponse> updateCollectionBinariesWithHttpInfo(@Nonnull Integer collectionId, @Nonnull CollectionBinariesUpdateRequest collectionBinariesUpdateRequest) throws ApiException
      Deprecated.
      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

      @Deprecated public okhttp3.Call updateCollectionBinariesAsync(@Nonnull Integer collectionId, @Nonnull CollectionBinariesUpdateRequest collectionBinariesUpdateRequest, ApiCallback<BaseResponseCollectionBinariesUpdateResponse> _callback) throws ApiException
      Deprecated.
      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

      @Deprecated public okhttp3.Call updateCollectionTagsCall(@Nonnull Integer collectionId, @Nonnull CollectionTagsUpdateRequest collectionTagsUpdateRequest, ApiCallback _callback) throws ApiException
      Deprecated.
      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

      @Deprecated public BaseResponseCollectionTagsUpdateResponse updateCollectionTags(@Nonnull Integer collectionId, @Nonnull CollectionTagsUpdateRequest collectionTagsUpdateRequest) throws ApiException
      Deprecated.
      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

      @Deprecated public ApiResponse<BaseResponseCollectionTagsUpdateResponse> updateCollectionTagsWithHttpInfo(@Nonnull Integer collectionId, @Nonnull CollectionTagsUpdateRequest collectionTagsUpdateRequest) throws ApiException
      Deprecated.
      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

      @Deprecated public okhttp3.Call updateCollectionTagsAsync(@Nonnull Integer collectionId, @Nonnull CollectionTagsUpdateRequest collectionTagsUpdateRequest, ApiCallback<BaseResponseCollectionTagsUpdateResponse> _callback) throws ApiException
      Deprecated.
      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 -

    • v3CreateCollectionCall

      public okhttp3.Call v3CreateCollectionCall(@Nonnull CreateCollectionInputBody createCollectionInputBody, ApiCallback _callback) throws ApiException
      Build call for v3CreateCollection
      Parameters:
      createCollectionInputBody - (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
      201 Created -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3CreateCollection

      public CreateCollectionOutputBody v3CreateCollection(@Nonnull CreateCollectionInputBody createCollectionInputBody) throws ApiException
      Create a collection. Creates a new collection, optionally tagging it and linking binary IDs to it. Tags and binaries are returned in the response only when they were supplied in the request. **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `422` [`VALIDATION_FAILED`](/errors/VALIDATION_FAILED) — Validation Failed
      Parameters:
      createCollectionInputBody - (required)
      Returns:
      CreateCollectionOutputBody
      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
      201 Created -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3CreateCollectionWithHttpInfo

      public ApiResponse<CreateCollectionOutputBody> v3CreateCollectionWithHttpInfo(@Nonnull CreateCollectionInputBody createCollectionInputBody) throws ApiException
      Create a collection. Creates a new collection, optionally tagging it and linking binary IDs to it. Tags and binaries are returned in the response only when they were supplied in the request. **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `422` [`VALIDATION_FAILED`](/errors/VALIDATION_FAILED) — Validation Failed
      Parameters:
      createCollectionInputBody - (required)
      Returns:
      ApiResponse<CreateCollectionOutputBody>
      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
      201 Created -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3CreateCollectionAsync

      public okhttp3.Call v3CreateCollectionAsync(@Nonnull CreateCollectionInputBody createCollectionInputBody, ApiCallback<CreateCollectionOutputBody> _callback) throws ApiException
      Create a collection. (asynchronously) Creates a new collection, optionally tagging it and linking binary IDs to it. Tags and binaries are returned in the response only when they were supplied in the request. **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `422` [`VALIDATION_FAILED`](/errors/VALIDATION_FAILED) — Validation Failed
      Parameters:
      createCollectionInputBody - (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
      201 Created -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3DeleteCollectionCall

      public okhttp3.Call v3DeleteCollectionCall(@Nonnull Long collectionId, ApiCallback _callback) throws ApiException
      Build call for v3DeleteCollection
      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
      204 No Content -
      403 Forbidden -
      404 Not Found -
      409 Conflict -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3DeleteCollection

      public void v3DeleteCollection(@Nonnull Long collectionId) throws ApiException
      Delete a collection. Deletes a collection. The collection must not have any linked binaries (call PATCH /v3/collections/{collection_id}/binaries with an empty list first). **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `409` [`CONFLICT`](/errors/CONFLICT) — Conflict
      Parameters:
      collectionId - (required)
      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
      204 No Content -
      403 Forbidden -
      404 Not Found -
      409 Conflict -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3DeleteCollectionWithHttpInfo

      public ApiResponse<Void> v3DeleteCollectionWithHttpInfo(@Nonnull Long collectionId) throws ApiException
      Delete a collection. Deletes a collection. The collection must not have any linked binaries (call PATCH /v3/collections/{collection_id}/binaries with an empty list first). **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `409` [`CONFLICT`](/errors/CONFLICT) — Conflict
      Parameters:
      collectionId - (required)
      Returns:
      ApiResponse<Void>
      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
      204 No Content -
      403 Forbidden -
      404 Not Found -
      409 Conflict -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3DeleteCollectionAsync

      public okhttp3.Call v3DeleteCollectionAsync(@Nonnull Long collectionId, ApiCallback<Void> _callback) throws ApiException
      Delete a collection. (asynchronously) Deletes a collection. The collection must not have any linked binaries (call PATCH /v3/collections/{collection_id}/binaries with an empty list first). **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `409` [`CONFLICT`](/errors/CONFLICT) — Conflict
      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
      204 No Content -
      403 Forbidden -
      404 Not Found -
      409 Conflict -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3GetCollectionCall

      public okhttp3.Call v3GetCollectionCall(@Nonnull Long collectionId, @Nullable Boolean includeTags, @Nullable Boolean includeBinaries, @Nullable Long pageSize, @Nullable Long pageNumber, @Nullable String binarySearchStr, ApiCallback _callback) throws ApiException
      Build call for v3GetCollection
      Parameters:
      collectionId - (required)
      includeTags - (optional)
      includeBinaries - (optional)
      pageSize - (optional, default to 10)
      pageNumber - (optional, default to 1)
      binarySearchStr - (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 OK -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3GetCollection

      public GetCollectionOutputBody v3GetCollection(@Nonnull Long collectionId, @Nullable Boolean includeTags, @Nullable Boolean includeBinaries, @Nullable Long pageSize, @Nullable Long pageNumber, @Nullable String binarySearchStr) throws ApiException
      Get a collection. Gets a single collection by ID. Optionally include tags and paginated binaries. **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found
      Parameters:
      collectionId - (required)
      includeTags - (optional)
      includeBinaries - (optional)
      pageSize - (optional, default to 10)
      pageNumber - (optional, default to 1)
      binarySearchStr - (optional)
      Returns:
      GetCollectionOutputBody
      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 OK -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3GetCollectionWithHttpInfo

      public ApiResponse<GetCollectionOutputBody> v3GetCollectionWithHttpInfo(@Nonnull Long collectionId, @Nullable Boolean includeTags, @Nullable Boolean includeBinaries, @Nullable Long pageSize, @Nullable Long pageNumber, @Nullable String binarySearchStr) throws ApiException
      Get a collection. Gets a single collection by ID. Optionally include tags and paginated binaries. **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found
      Parameters:
      collectionId - (required)
      includeTags - (optional)
      includeBinaries - (optional)
      pageSize - (optional, default to 10)
      pageNumber - (optional, default to 1)
      binarySearchStr - (optional)
      Returns:
      ApiResponse<GetCollectionOutputBody>
      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 OK -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3GetCollectionAsync

      public okhttp3.Call v3GetCollectionAsync(@Nonnull Long collectionId, @Nullable Boolean includeTags, @Nullable Boolean includeBinaries, @Nullable Long pageSize, @Nullable Long pageNumber, @Nullable String binarySearchStr, ApiCallback<GetCollectionOutputBody> _callback) throws ApiException
      Get a collection. (asynchronously) Gets a single collection by ID. Optionally include tags and paginated binaries. **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found
      Parameters:
      collectionId - (required)
      includeTags - (optional)
      includeBinaries - (optional)
      pageSize - (optional, default to 10)
      pageNumber - (optional, default to 1)
      binarySearchStr - (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 OK -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3ListCollectionsCall

      public okhttp3.Call v3ListCollectionsCall(@Nullable String searchTerm, @Nullable List<String> filters, @Nullable Long limit, @Nullable Long offset, @Nullable String orderBy, @Nullable String order, ApiCallback _callback) throws ApiException
      Build call for v3ListCollections
      Parameters:
      searchTerm - (optional)
      filters - (optional)
      limit - (optional, default to 20)
      offset - (optional, default to 0)
      orderBy - (optional, default to collection)
      order - (optional, default to ASC)
      _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 OK -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3ListCollections

      public ListCollectionsOutputBody v3ListCollections(@Nullable String searchTerm, @Nullable List<String> filters, @Nullable Long limit, @Nullable Long offset, @Nullable String orderBy, @Nullable String order) throws ApiException
      List collections. Lists collections accessible to the authenticated user. Supports search, filtering, ordering, and pagination. **Error codes:** - `422` [`VALIDATION_FAILED`](/errors/VALIDATION_FAILED) — Validation Failed
      Parameters:
      searchTerm - (optional)
      filters - (optional)
      limit - (optional, default to 20)
      offset - (optional, default to 0)
      orderBy - (optional, default to collection)
      order - (optional, default to ASC)
      Returns:
      ListCollectionsOutputBody
      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 OK -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3ListCollectionsWithHttpInfo

      public ApiResponse<ListCollectionsOutputBody> v3ListCollectionsWithHttpInfo(@Nullable String searchTerm, @Nullable List<String> filters, @Nullable Long limit, @Nullable Long offset, @Nullable String orderBy, @Nullable String order) throws ApiException
      List collections. Lists collections accessible to the authenticated user. Supports search, filtering, ordering, and pagination. **Error codes:** - `422` [`VALIDATION_FAILED`](/errors/VALIDATION_FAILED) — Validation Failed
      Parameters:
      searchTerm - (optional)
      filters - (optional)
      limit - (optional, default to 20)
      offset - (optional, default to 0)
      orderBy - (optional, default to collection)
      order - (optional, default to ASC)
      Returns:
      ApiResponse<ListCollectionsOutputBody>
      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 OK -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3ListCollectionsAsync

      public okhttp3.Call v3ListCollectionsAsync(@Nullable String searchTerm, @Nullable List<String> filters, @Nullable Long limit, @Nullable Long offset, @Nullable String orderBy, @Nullable String order, ApiCallback<ListCollectionsOutputBody> _callback) throws ApiException
      List collections. (asynchronously) Lists collections accessible to the authenticated user. Supports search, filtering, ordering, and pagination. **Error codes:** - `422` [`VALIDATION_FAILED`](/errors/VALIDATION_FAILED) — Validation Failed
      Parameters:
      searchTerm - (optional)
      filters - (optional)
      limit - (optional, default to 20)
      offset - (optional, default to 0)
      orderBy - (optional, default to collection)
      order - (optional, default to ASC)
      _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 OK -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3PatchCollectionCall

      public okhttp3.Call v3PatchCollectionCall(@Nonnull Long collectionId, @Nonnull PatchCollectionInputBody patchCollectionInputBody, ApiCallback _callback) throws ApiException
      Build call for v3PatchCollection
      Parameters:
      collectionId - (required)
      patchCollectionInputBody - (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 OK -
      403 Forbidden -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3PatchCollection

      public PatchCollectionOutputBody v3PatchCollection(@Nonnull Long collectionId, @Nonnull PatchCollectionInputBody patchCollectionInputBody) throws ApiException
      Update a collection. Updates a collection's name, description, and/or scope. Omitted fields keep their existing values. **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `422` [`VALIDATION_FAILED`](/errors/VALIDATION_FAILED) — Validation Failed
      Parameters:
      collectionId - (required)
      patchCollectionInputBody - (required)
      Returns:
      PatchCollectionOutputBody
      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 OK -
      403 Forbidden -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3PatchCollectionWithHttpInfo

      public ApiResponse<PatchCollectionOutputBody> v3PatchCollectionWithHttpInfo(@Nonnull Long collectionId, @Nonnull PatchCollectionInputBody patchCollectionInputBody) throws ApiException
      Update a collection. Updates a collection's name, description, and/or scope. Omitted fields keep their existing values. **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `422` [`VALIDATION_FAILED`](/errors/VALIDATION_FAILED) — Validation Failed
      Parameters:
      collectionId - (required)
      patchCollectionInputBody - (required)
      Returns:
      ApiResponse<PatchCollectionOutputBody>
      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 OK -
      403 Forbidden -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3PatchCollectionAsync

      public okhttp3.Call v3PatchCollectionAsync(@Nonnull Long collectionId, @Nonnull PatchCollectionInputBody patchCollectionInputBody, ApiCallback<PatchCollectionOutputBody> _callback) throws ApiException
      Update a collection. (asynchronously) Updates a collection's name, description, and/or scope. Omitted fields keep their existing values. **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `422` [`VALIDATION_FAILED`](/errors/VALIDATION_FAILED) — Validation Failed
      Parameters:
      collectionId - (required)
      patchCollectionInputBody - (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 OK -
      403 Forbidden -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3PatchCollectionBinariesCall

      public okhttp3.Call v3PatchCollectionBinariesCall(@Nonnull Long collectionId, @Nonnull PatchCollectionBinariesInputBody patchCollectionBinariesInputBody, ApiCallback _callback) throws ApiException
      Build call for v3PatchCollectionBinaries
      Parameters:
      collectionId - (required)
      patchCollectionBinariesInputBody - (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 OK -
      403 Forbidden -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3PatchCollectionBinaries

      public PatchCollectionBinariesOutputBody v3PatchCollectionBinaries(@Nonnull Long collectionId, @Nonnull PatchCollectionBinariesInputBody patchCollectionBinariesInputBody) throws ApiException
      Replace the binaries in a collection. Replaces the binaries linked to a collection with the supplied list. Binaries not present in the request are removed. All supplied binary IDs must belong to the same model as the collection. **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `422` [`VALIDATION_FAILED`](/errors/VALIDATION_FAILED) — Validation Failed
      Parameters:
      collectionId - (required)
      patchCollectionBinariesInputBody - (required)
      Returns:
      PatchCollectionBinariesOutputBody
      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 OK -
      403 Forbidden -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3PatchCollectionBinariesWithHttpInfo

      public ApiResponse<PatchCollectionBinariesOutputBody> v3PatchCollectionBinariesWithHttpInfo(@Nonnull Long collectionId, @Nonnull PatchCollectionBinariesInputBody patchCollectionBinariesInputBody) throws ApiException
      Replace the binaries in a collection. Replaces the binaries linked to a collection with the supplied list. Binaries not present in the request are removed. All supplied binary IDs must belong to the same model as the collection. **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `422` [`VALIDATION_FAILED`](/errors/VALIDATION_FAILED) — Validation Failed
      Parameters:
      collectionId - (required)
      patchCollectionBinariesInputBody - (required)
      Returns:
      ApiResponse<PatchCollectionBinariesOutputBody>
      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 OK -
      403 Forbidden -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3PatchCollectionBinariesAsync

      public okhttp3.Call v3PatchCollectionBinariesAsync(@Nonnull Long collectionId, @Nonnull PatchCollectionBinariesInputBody patchCollectionBinariesInputBody, ApiCallback<PatchCollectionBinariesOutputBody> _callback) throws ApiException
      Replace the binaries in a collection. (asynchronously) Replaces the binaries linked to a collection with the supplied list. Binaries not present in the request are removed. All supplied binary IDs must belong to the same model as the collection. **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `422` [`VALIDATION_FAILED`](/errors/VALIDATION_FAILED) — Validation Failed
      Parameters:
      collectionId - (required)
      patchCollectionBinariesInputBody - (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 OK -
      403 Forbidden -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3PatchCollectionTagsCall

      public okhttp3.Call v3PatchCollectionTagsCall(@Nonnull Long collectionId, @Nonnull PatchCollectionTagsInputBody patchCollectionTagsInputBody, ApiCallback _callback) throws ApiException
      Build call for v3PatchCollectionTags
      Parameters:
      collectionId - (required)
      patchCollectionTagsInputBody - (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 OK -
      403 Forbidden -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3PatchCollectionTags

      public PatchCollectionTagsOutputBody v3PatchCollectionTags(@Nonnull Long collectionId, @Nonnull PatchCollectionTagsInputBody patchCollectionTagsInputBody) throws ApiException
      Replace the tags on a collection. Replaces the tags on a collection with the supplied list. Tags not present in the request are removed. Empty or whitespace-only tags are filtered; duplicates are deduplicated. **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied
      Parameters:
      collectionId - (required)
      patchCollectionTagsInputBody - (required)
      Returns:
      PatchCollectionTagsOutputBody
      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 OK -
      403 Forbidden -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3PatchCollectionTagsWithHttpInfo

      public ApiResponse<PatchCollectionTagsOutputBody> v3PatchCollectionTagsWithHttpInfo(@Nonnull Long collectionId, @Nonnull PatchCollectionTagsInputBody patchCollectionTagsInputBody) throws ApiException
      Replace the tags on a collection. Replaces the tags on a collection with the supplied list. Tags not present in the request are removed. Empty or whitespace-only tags are filtered; duplicates are deduplicated. **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied
      Parameters:
      collectionId - (required)
      patchCollectionTagsInputBody - (required)
      Returns:
      ApiResponse<PatchCollectionTagsOutputBody>
      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 OK -
      403 Forbidden -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -

    • v3PatchCollectionTagsAsync

      public okhttp3.Call v3PatchCollectionTagsAsync(@Nonnull Long collectionId, @Nonnull PatchCollectionTagsInputBody patchCollectionTagsInputBody, ApiCallback<PatchCollectionTagsOutputBody> _callback) throws ApiException
      Replace the tags on a collection. (asynchronously) Replaces the tags on a collection with the supplied list. Tags not present in the request are removed. Empty or whitespace-only tags are filtered; duplicates are deduplicated. **Error codes:** - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied
      Parameters:
      collectionId - (required)
      patchCollectionTagsInputBody - (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 OK -
      403 Forbidden -
      404 Not Found -
      422 Unprocessable Entity -
      500 Internal Server Error -