com.bynder.sdk.api

Interface BynderApi

public interface BynderApi

Interface of the Bynder API to handle the HTTP communication.

Method Summary

Modifier and Type	Method and Description
io.reactivex.Observable<retrofit2.Response<Void>>	addMediaToCollection(String collectionId, Map<String,String> params) Adds media assets to a collection.
io.reactivex.Observable<retrofit2.Response<Void>>	createCollection(Map<String,String> params) Creates a collection.
io.reactivex.Observable<retrofit2.Response<Usage>>	createUsage(Map<String,String> params) Creates a usage record for a media asset.
io.reactivex.Observable<retrofit2.Response<Void>>	deleteCollection(Map<String,String> params) Deletes a collection.
io.reactivex.Observable<retrofit2.Response<Void>>	deleteMedia(Map<String,String> params) Deletes a media asset.
io.reactivex.Observable<retrofit2.Response<Void>>	deleteUsage(Map<String,String> params) Deletes a usage record of a media asset.
io.reactivex.Observable<retrofit2.Response<FinaliseResponse>>	finaliseUpload(Map<String,String> params) Finalises a completely uploaded file.
io.reactivex.Observable<retrofit2.Response<List<Brand>>>	getBrands() Gets list of the brands.
io.reactivex.Observable<retrofit2.Response<String>>	getClosestS3Endpoint() Gets the URL of the Amazon S3 bucket-endpoint in the region closest to the server.
io.reactivex.Observable<retrofit2.Response<Collection>>	getCollectionInfo(Map<String,String> params) Gets all the collection information for a specific collection id.
io.reactivex.Observable<retrofit2.Response<List<String>>>	getCollectionMediaIds(String collectionId) Gets a list of the media assets ids of a collection.
io.reactivex.Observable<retrofit2.Response<List<Collection>>>	getCollections(Map<String,String> params) Gets list of the collections.
io.reactivex.Observable<retrofit2.Response<List<Derivative>>>	getDerivatives() Gets list of the account derivatives.
io.reactivex.Observable<retrofit2.Response<DownloadUrl>>	getMediaDownloadUrl(String mediaId) Gets the download file URL for a specific media id.
io.reactivex.Observable<retrofit2.Response<DownloadUrl>>	getMediaDownloadUrl(String mediaId, String mediaItemId) Gets the download file URL for specific media item id.
io.reactivex.Observable<retrofit2.Response<Media>>	getMediaInfo(Map<String,String> params) Gets all the media information for a specific media id.
io.reactivex.Observable<retrofit2.Response<List<Media>>>	getMediaList(Map<String,String> params) Gets a list of media assets filtered by parameters.
io.reactivex.Observable<retrofit2.Response<Map<String,Metaproperty>>>	getMetaproperties(Map<String,String> params) Gets map of the metaproperties.
io.reactivex.Observable<retrofit2.Response<PollStatus>>	getPollStatus(Map<String,String> params) Gets poll processing status of finalised files.
io.reactivex.Observable<retrofit2.Response<List<Smartfilter>>>	getSmartfilters() Gets list of the smartfilters.
io.reactivex.Observable<retrofit2.Response<List<Tag>>>	getTags() Gets list of the tags.
io.reactivex.Observable<retrofit2.Response<UploadRequest>>	getUploadInformation(Map<String,String> params) Initialises a file upload with Bynder and returns authorisation information to allow uploading to the Amazon S3 bucket-endpoint.
io.reactivex.Observable<retrofit2.Response<List<Usage>>>	getUsage(Map<String,String> params) Gets all the media assets usage records.
io.reactivex.Observable<retrofit2.Response<Void>>	modifyMedia(Map<String,String> params) Modifies the media metadata for a specific media id.
io.reactivex.Observable<retrofit2.Response<Void>>	registerChunk(Map<String,String> params) Registers an uploaded chunk in Bynder.
io.reactivex.Observable<retrofit2.Response<Void>>	removeMediaFromCollection(String collectionId, Map<String,String> params) Removes media assets from a collection.
io.reactivex.Observable<retrofit2.Response<SaveMediaResponse>>	saveMedia(Map<String,String> params) Saves a new media asset in Bynder.
io.reactivex.Observable<retrofit2.Response<Void>>	shareCollection(String collectionId, Map<String,String> params) Shares a collection.

Method Detail

getDerivatives

@GET(value="/api/v4/account/derivatives/")
io.reactivex.Observable<retrofit2.Response<List<Derivative>>> getDerivatives()

Gets list of the account derivatives.

Returns:

Observable with list of Derivative.

getBrands

@GET(value="/api/v4/brands/")
io.reactivex.Observable<retrofit2.Response<List<Brand>>> getBrands()

Gets list of the brands.

Returns:

Observable with list of Brand.

getTags

@GET(value="/api/v4/tags/")
io.reactivex.Observable<retrofit2.Response<List<Tag>>> getTags()

Gets list of the tags.

Returns:

Observable with list of Tag.

getMetaproperties

@GET(value="/api/v4/metaproperties/")
io.reactivex.Observable<retrofit2.Response<Map<String,Metaproperty>>> getMetaproperties(@QueryMap
                                                                                                                              Map<String,String> params)

Gets map of the metaproperties. The key of the map returned is the name of the metaproperty.

Parameters:

params - QueryMap with parameters.

Returns:

Observable with Map of metaproperties.

getMediaList

@GET(value="/api/v4/media/")
io.reactivex.Observable<retrofit2.Response<List<Media>>> getMediaList(@QueryMap
                                                                                                   Map<String,String> params)

Gets a list of media assets filtered by parameters.

Parameters:

params - QueryMap with parameters.

Returns:

Observable with list of Media.

getMediaInfo

@GET(value="/api/v4/media/")
io.reactivex.Observable<retrofit2.Response<Media>> getMediaInfo(@QueryMap
                                                                                             Map<String,String> params)

Gets all the media information for a specific media id.

Parameters:

params - QueryMap with parameters.

Returns:

Observable with Media information.

modifyMedia

@FormUrlEncoded
 @POST(value="/api/v4/media/")
io.reactivex.Observable<retrofit2.Response<Void>> modifyMedia(@FieldMap
                                                                                                             Map<String,String> params)

Modifies the media metadata for a specific media id.

Parameters:

params - FieldMap with parameters.

Returns:

Observable with the Response.

deleteMedia

@DELETE(value="/api/v4/media/")
io.reactivex.Observable<retrofit2.Response<Void>> deleteMedia(@QueryMap
                                                                                              Map<String,String> params)

Deletes a media asset.

Parameters:

params - QueryMap with parameters.

Returns:

Observable with the Response.

getMediaDownloadUrl

@GET(value="/api/v4/media/{id}/download/")
io.reactivex.Observable<retrofit2.Response<DownloadUrl>> getMediaDownloadUrl(@Path(value="id")
                                                                                                                        String mediaId)

Gets the download file URL for a specific media id.

Parameters:

mediaId - Media id of which we want to get the download URL.

Returns:

Observable with the DownloadUrl information of the media.

getMediaDownloadUrl

@GET(value="/api/v4/media/{id}/download/{itemId}/")
io.reactivex.Observable<retrofit2.Response<DownloadUrl>> getMediaDownloadUrl(@Path(value="id")
                                                                                                                                 String mediaId,
                                                                                                                                 @Path(value="itemId")
                                                                                                                                 String mediaItemId)

Gets the download file URL for specific media item id.

Parameters:

mediaId - Media id of which the media item belongs to.

mediaItemId - Media item id of which we want to get the download URL.

Returns:

Observable with the DownloadUrl information of the media item.

createUsage

@FormUrlEncoded
 @POST(value="/api/media/usage/")
io.reactivex.Observable<retrofit2.Response<Usage>> createUsage(@FieldMap
                                                                                                                 Map<String,String> params)

Creates a usage record for a media asset.

Parameters:

params - FieldMap with parameters.

Returns:

Observable with Usage information.

getUsage

@GET(value="/api/media/usage/")
io.reactivex.Observable<retrofit2.Response<List<Usage>>> getUsage(@QueryMap
                                                                                                  Map<String,String> params)

Gets all the media assets usage records.

Parameters:

params - QueryMap with parameters.

Returns:

Observable with list of Usage.

deleteUsage

@DELETE(value="/api/media/usage/")
io.reactivex.Observable<retrofit2.Response<Void>> deleteUsage(@QueryMap
                                                                                                 Map<String,String> params)

Deletes a usage record of a media asset.

Parameters:

params - QueryMap with parameters.

Returns:

Observable with the Response.

getSmartfilters

@GET(value="/api/v4/smartfilters/")
io.reactivex.Observable<retrofit2.Response<List<Smartfilter>>> getSmartfilters()

Gets list of the smartfilters.

Returns:

Observable with List of smartfilters.

getCollections

@GET(value="/api/v4/collections/")
io.reactivex.Observable<retrofit2.Response<List<Collection>>> getCollections(@QueryMap
                                                                                                                Map<String,String> params)

Gets list of the collections.

Parameters:

params - QueryMap with parameters.

Returns:

Observable with list of Collection.

getCollectionInfo

@GET(value="/api/v4/collections/")
io.reactivex.Observable<retrofit2.Response<Collection>> getCollectionInfo(@QueryMap
                                                                                                             Map<String,String> params)

Gets all the collection information for a specific collection id.

Parameters:

params - QueryMap with parameters.

Returns:

Observable with Collection information.

createCollection

@FormUrlEncoded
 @POST(value="/api/v4/collections/")
io.reactivex.Observable<retrofit2.Response<Void>> createCollection(@FieldMap
                                                                                                                        Map<String,String> params)

Creates a collection.

Parameters:

params - FieldMap with parameters.

Returns:

Observable with the Response.

deleteCollection

@DELETE(value="/api/v4/collections/")
io.reactivex.Observable<retrofit2.Response<Void>> deleteCollection(@QueryMap
                                                                                                         Map<String,String> params)

Deletes a collection.

Parameters:

params - QueryMap with parameters.

Returns:

Observable with the Response.

getCollectionMediaIds

@GET(value="/api/v4/collections/{id}/media/")
io.reactivex.Observable<retrofit2.Response<List<String>>> getCollectionMediaIds(@Path(value="id")
                                                                                                                              String collectionId)

Gets a list of the media assets ids of a collection.

Parameters:

collectionId - Collection id of which we want to get the media assets ids.

Returns:

Observable with list of media assets ids.

addMediaToCollection

@FormUrlEncoded
 @POST(value="/api/v4/collections/{id}/media/")
io.reactivex.Observable<retrofit2.Response<Void>> addMediaToCollection(@Path(value="id")
                                                                                                                                       String collectionId,
                                                                                                                                       @FieldMap
                                                                                                                                       Map<String,String> params)

Adds media assets to a collection.

Parameters:

collectionId - Collection id to which we want to add media assets.

params - FieldMap with parameters.

Returns:

Observable with the Response.

removeMediaFromCollection

@DELETE(value="/api/v4/collections/{id}/media/")
io.reactivex.Observable<retrofit2.Response<Void>> removeMediaFromCollection(@Path(value="id")
                                                                                                                             String collectionId,
                                                                                                                             @QueryMap
                                                                                                                             Map<String,String> params)

Removes media assets from a collection.

Parameters:

collectionId - Collection id from which we want to remove media assets.

params - QueryMap with parameters.

Returns:

Observable with the Response.

shareCollection

@FormUrlEncoded
 @POST(value="/api/v4/collections/{id}/share/")
io.reactivex.Observable<retrofit2.Response<Void>> shareCollection(@Path(value="id")
                                                                                                                                  String collectionId,
                                                                                                                                  @FieldMap
                                                                                                                                  Map<String,String> params)

Shares a collection.

Parameters:

collectionId - Id of the collection we want to share.

params - FieldMap with parameters.

Returns:

Observable with the Response.

getUploadInformation

@FormUrlEncoded
 @POST(value="/api/upload/init/")
io.reactivex.Observable<retrofit2.Response<UploadRequest>> getUploadInformation(@FieldMap
                                                                                                                                  Map<String,String> params)

Initialises a file upload with Bynder and returns authorisation information to allow uploading to the Amazon S3 bucket-endpoint.

Parameters:

params - FieldMap with parameters.

Returns:

Observable with UploadRequest authorisation information.

getClosestS3Endpoint

@GET(value="/api/upload/endpoint/")
io.reactivex.Observable<retrofit2.Response<String>> getClosestS3Endpoint()

Gets the URL of the Amazon S3 bucket-endpoint in the region closest to the server. This URL is used to upload parts to Amazon.

Returns:

Observable with the URL.

registerChunk

@FormUrlEncoded
 @POST(value="/api/v4/upload/")
io.reactivex.Observable<retrofit2.Response<Void>> registerChunk(@FieldMap
                                                                                                                Map<String,String> params)

Registers an uploaded chunk in Bynder.

Parameters:

params - FieldMap with parameters.

Returns:

Observable with the Response.

finaliseUpload

@FormUrlEncoded
 @POST(value="/api/v4/upload/")
io.reactivex.Observable<retrofit2.Response<FinaliseResponse>> finaliseUpload(@FieldMap
                                                                                                                             Map<String,String> params)

Finalises a completely uploaded file.

Parameters:

params - FieldMap with parameters.

Returns:

Observable with FinaliseResponse information.

getPollStatus

@GET(value="/api/v4/upload/poll/")
io.reactivex.Observable<retrofit2.Response<PollStatus>> getPollStatus(@QueryMap
                                                                                                         Map<String,String> params)

Gets poll processing status of finalised files.

Parameters:

params - QueryMap with parameters.

Returns:

Observable with PollStatus information.

saveMedia

@FormUrlEncoded
 @POST(value="/api/v4/media/save/")
io.reactivex.Observable<retrofit2.Response<SaveMediaResponse>> saveMedia(@FieldMap
                                                                                                                             Map<String,String> params)

Saves a new media asset in Bynder. If media id is specified in the query a new version of the asset will be saved. Otherwise a new asset will be saved.

Parameters:

params - FieldMap with parameters.

Returns:

Observable with the SaveMediaResponse information.