Package 

Class ManageCollectionsApi

    • Constructor Detail

      • ManageCollectionsApi

        ManageCollectionsApi(String basePath, OkHttpClient client)

    • Method Detail

      • collectionCreateCollection

         final CollectionModel collectionCreateCollection(Long libraryId, CollectionUpdateCollectionRequest collectionUpdateCollectionRequest)

        Create Collection Creates a new collection in the specified video library using the provided collection details.

        Parameters:
        libraryId - The ID of the video library where the new collection will be created.
        collectionUpdateCollectionRequest - Collection model containing the details for the new collection.

      • collectionCreateCollectionWithHttpInfo

         final ApiResponse<CollectionModel> collectionCreateCollectionWithHttpInfo(Long libraryId, CollectionUpdateCollectionRequest collectionUpdateCollectionRequest)

        Create Collection Creates a new collection in the specified video library using the provided collection details.

        Parameters:
        libraryId - The ID of the video library where the new collection will be created.
        collectionUpdateCollectionRequest - Collection model containing the details for the new collection.

      • collectionDeleteCollection

         final StatusModel collectionDeleteCollection(Long libraryId, String collectionId)

        Delete Collection Deletes the specified collection permanently from the video library.

        Parameters:
        libraryId - The ID of the video library containing the collection.
        collectionId - The unique identifier of the collection to be deleted.

      • collectionDeleteCollectionWithHttpInfo

         final ApiResponse<StatusModel> collectionDeleteCollectionWithHttpInfo(Long libraryId, String collectionId)

        Delete Collection Deletes the specified collection permanently from the video library.

        Parameters:
        libraryId - The ID of the video library containing the collection.
        collectionId - The unique identifier of the collection to be deleted.

      • collectionDeleteCollectionRequestConfig

         final RequestConfig<Unit> collectionDeleteCollectionRequestConfig(Long libraryId, String collectionId)

        To obtain the request config of the operation collectionDeleteCollection

        Parameters:
        libraryId - The ID of the video library containing the collection.
        collectionId - The unique identifier of the collection to be deleted.

      • collectionGetCollection

         final CollectionModel collectionGetCollection(Long libraryId, String collectionId, Boolean includeThumbnails)

        Get Collection Retrieves details of a specific collection. Use the query parameter &#39;includeThumbnails&#39; to include preview images if available.

        Parameters:
        libraryId - The ID of the video library containing the collection.
        collectionId - The unique identifier of the collection.
        includeThumbnails - If true, the response will include preview image URLs for the collection.

      • collectionGetCollectionWithHttpInfo

         final ApiResponse<CollectionModel> collectionGetCollectionWithHttpInfo(Long libraryId, String collectionId, Boolean includeThumbnails)

        Get Collection Retrieves details of a specific collection. Use the query parameter &#39;includeThumbnails&#39; to include preview images if available.

        Parameters:
        libraryId - The ID of the video library containing the collection.
        collectionId - The unique identifier of the collection.
        includeThumbnails - If true, the response will include preview image URLs for the collection.

      • collectionGetCollectionRequestConfig

         final RequestConfig<Unit> collectionGetCollectionRequestConfig(Long libraryId, String collectionId, Boolean includeThumbnails)

        To obtain the request config of the operation collectionGetCollection

        Parameters:
        libraryId - The ID of the video library containing the collection.
        collectionId - The unique identifier of the collection.
        includeThumbnails - If true, the response will include preview image URLs for the collection.

      • collectionList

         final PaginationListOfCollectionModel collectionList(Long libraryId, Integer page, Integer itemsPerPage, String search, String orderBy, Boolean includeThumbnails)

        Get Collection List Retrieves a paginated list of collections for the specified video library. Optional query parameters allow for filtering, pagination, and ordering the results.

        Parameters:
        libraryId - The ID of the video library.
        page - The page number to retrieve.
        itemsPerPage - The number of items per page.
        search - A search term to filter collections by name or other metadata.
        orderBy - Specifies the field by which to order the results.
        includeThumbnails - If true, includes thumbnail image URLs in the response.

      • collectionListWithHttpInfo

         final ApiResponse<PaginationListOfCollectionModel> collectionListWithHttpInfo(Long libraryId, Integer page, Integer itemsPerPage, String search, String orderBy, Boolean includeThumbnails)

        Get Collection List Retrieves a paginated list of collections for the specified video library. Optional query parameters allow for filtering, pagination, and ordering the results.

        Parameters:
        libraryId - The ID of the video library.
        page - The page number to retrieve.
        itemsPerPage - The number of items per page.
        search - A search term to filter collections by name or other metadata.
        orderBy - Specifies the field by which to order the results.
        includeThumbnails - If true, includes thumbnail image URLs in the response.

      • collectionListRequestConfig

         final RequestConfig<Unit> collectionListRequestConfig(Long libraryId, Integer page, Integer itemsPerPage, String search, String orderBy, Boolean includeThumbnails)

        To obtain the request config of the operation collectionList

        Parameters:
        libraryId - The ID of the video library.
        page - The page number to retrieve.
        itemsPerPage - The number of items per page.
        search - A search term to filter collections by name or other metadata.
        orderBy - Specifies the field by which to order the results.
        includeThumbnails - If true, includes thumbnail image URLs in the response.

      • collectionUpdateCollection

         final StatusModel collectionUpdateCollection(Long libraryId, String collectionId, CollectionUpdateCollectionRequest collectionUpdateCollectionRequest)

        Update Collection Updates an existing collection. Provide the new collection details in the request body using the UpdateCollectionModel.

        Parameters:
        libraryId - The ID of the video library containing the collection.
        collectionId - The unique identifier of the collection to be updated.
        collectionUpdateCollectionRequest - Collection model containing the fields to be updated.

      • collectionUpdateCollectionWithHttpInfo

         final ApiResponse<StatusModel> collectionUpdateCollectionWithHttpInfo(Long libraryId, String collectionId, CollectionUpdateCollectionRequest collectionUpdateCollectionRequest)

        Update Collection Updates an existing collection. Provide the new collection details in the request body using the UpdateCollectionModel.

        Parameters:
        libraryId - The ID of the video library containing the collection.
        collectionId - The unique identifier of the collection to be updated.
        collectionUpdateCollectionRequest - Collection model containing the fields to be updated.