com.constantcontact.v2

Interface LibraryService

public interface LibraryService

Retrofit interface for Library Information, File, and Folder calls against the Constant Contact API

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<Folder>	createFolder(Folder folder) Create a new Folder
retrofit2.Call<retrofit2.Response>	deleteFile(java.lang.String fileId) Delete a File
retrofit2.Call<retrofit2.Response>	deleteFilesInTrash() Delete all File in the Trash Folder
retrofit2.Call<retrofit2.Response>	deleteFolder(java.lang.String folderId) Delete a Folder
retrofit2.Call<File>	getFile(java.lang.String fileId) Get a specific File
retrofit2.Call<Paged<File>>	getFiles(int limit, FileSortOrder sortOrder, FileSource source, FileTypeQuery type) Get a Paged collection of File
retrofit2.Call<Paged<File>>	getFiles(java.lang.String nextLink) Get a Paged collection of File
retrofit2.Call<Paged<File>>	getFilesByFolder(java.lang.String folderId, int limit, FileSortOrder sortOrder, FileSource source, FileTypeQuery type) Get a Paged collection of File from a specific Folder.
retrofit2.Call<Paged<File>>	getFilesByFolder(java.lang.String folderId, java.lang.String nextLink) Get a Paged collection of File from a specific Folder.
retrofit2.Call<FileUploadStatus[]>	getFileUploadStatus(java.lang.String fileIds) Get the FileUploadStatus of one or more File
retrofit2.Call<Folder>	getFolder(java.lang.String folderId) Get a specific Folder
retrofit2.Call<Paged<Folder>>	getFolders(int limit, FolderSortOrder sortOrder) Get a Paged collection of Folder
retrofit2.Call<Paged<Folder>>	getFolders(java.lang.String nextLink) Get a Paged collection of Folder
retrofit2.Call<LibraryInfo>	getLibraryInfo() Get the Account's LibraryInfo
retrofit2.Call<File>	moveFiles(java.lang.String folderId, java.lang.String[] fileIds) Move multiple File to a different Folder
retrofit2.Call<File>	updateFile(java.lang.String fileId, File file) Update a File
retrofit2.Call<Folder>	updateFolder(java.lang.String folderId, Folder folder) Update a Folder
retrofit2.Call<retrofit2.Response>	uploadFile(okhttp3.RequestBody file, java.lang.String description, java.lang.String fileName, java.lang.String fileType, java.lang.String folderId, java.lang.String source) Upload a new File to the Library

Method Detail

getLibraryInfo

@GET(value="v2/library/info")
retrofit2.Call<LibraryInfo> getLibraryInfo()

Get the Account's LibraryInfo

Returns:

an Observable that emits LibraryInfo

getFolders

@GET(value="v2/library/folders")
retrofit2.Call<Paged<Folder>> getFolders(@Query(value="limit")
                                                                          int limit,
                                                                          @Query(value="sort_by")
                                                                          FolderSortOrder sortOrder)

Get a Paged collection of Folder

Parameters:

limit - Size of page to return (1-1000)

sortOrder - FolderSortOrder

Returns:

an Observable that emits Paged Folders

getFolders

@GET(value="v2/library/folders?next={next}")
retrofit2.Call<Paged<Folder>> getFolders(@Path(value="next")
                                                                                      java.lang.String nextLink)

Get a Paged collection of Folder

Parameters:

nextLink - Value of the link found in the meta of the original call

Returns:

an Observable that emits Paged Folders

createFolder

@POST(value="v2/library/folders")
retrofit2.Call<Folder> createFolder(@Body
                                                                      Folder folder)

Create a new Folder

Parameters:

folder - Folder with only the name and parentId values

Returns:

an Observable that emits a Folder

getFolder

@GET(value="v2/library/folders/{folderId}")
retrofit2.Call<Folder> getFolder(@Path(value="folderId")
                                                                             java.lang.String folderId)

Get a specific Folder

Parameters:

folderId - The Folder ID

Returns:

an Observable that emits a Folder

updateFolder

@PUT(value="v2/library/folders/{folderId}?include_payload=TRUE")
retrofit2.Call<Folder> updateFolder(@Path(value="folderId")
                                                                                                     java.lang.String folderId,
                                                                                                     @Body
                                                                                                     Folder folder)

Update a Folder

Parameters:

folderId - The Folder ID

folder - Folder

Returns:

an Observable that emits an updated Folder

deleteFolder

@DELETE(value="v2/library/folders/{folderId}")
retrofit2.Call<retrofit2.Response> deleteFolder(@Path(value="folderId")
                                                                                               java.lang.String folderId)

Delete a Folder

Parameters:

folderId - The Folder ID

Returns:

an Observable that emits a Response

getFiles

@GET(value="v2/library/files")
retrofit2.Call<Paged<File>> getFiles(@Query(value="limit")
                                                                    int limit,
                                                                    @Query(value="sort_by")
                                                                    FileSortOrder sortOrder,
                                                                    @Query(value="source")
                                                                    FileSource source,
                                                                    @Query(value="type")
                                                                    FileTypeQuery type)

Get a Paged collection of File

Parameters:

limit - Size of page to return (1-1000)

sortOrder - FileSortOrder

source - FileSource

type - FileTypeQuery

Returns:

an Observable that emits Paged Files

getFiles

@GET(value="v2/library/files?next={next}")
retrofit2.Call<Paged<File>> getFiles(@Path(value="next")
                                                                                java.lang.String nextLink)

Get a Paged collection of File

Parameters:

nextLink - Value of the link found in the meta of the original call

Returns:

an Observable that emits Paged Files

getFilesByFolder

@GET(value="v2/library/folders/{folderId}/files")
retrofit2.Call<Paged<File>> getFilesByFolder(@Path(value="folderId")
                                                                                               java.lang.String folderId,
                                                                                               @Query(value="limit")
                                                                                               int limit,
                                                                                               @Query(value="sort_by")
                                                                                               FileSortOrder sortOrder,
                                                                                               @Query(value="source")
                                                                                               FileSource source,
                                                                                               @Query(value="type")
                                                                                               FileTypeQuery type)

Get a Paged collection of File from a specific Folder.

To get a list of files in the trash folder, pass "trash" as the folderId.

Parameters:

folderId - The Folder ID

limit - Size of page to return (1-1000)

sortOrder - FileSortOrder

source - FileSource

type - FileTypeQuery

Returns:

an Observable that emits Paged Files

getFilesByFolder

@GET(value="v2/library/folders/{folderId}/files?next={next}")
retrofit2.Call<Paged<File>> getFilesByFolder(@Path(value="folderId")
                                                                                                           java.lang.String folderId,
                                                                                                           @Path(value="next")
                                                                                                           java.lang.String nextLink)

Get a Paged collection of File from a specific Folder.

Parameters:

folderId - The Folder ID

nextLink - Value of the link found in the meta of the original call

Returns:

an Observable that emits Paged Files

getFile

@GET(value="v2/library/files/{fileId}")
retrofit2.Call<File> getFile(@Path(value="fileId")
                                                                     java.lang.String fileId)

Get a specific File

Parameters:

fileId - The File ID

Returns:

an Observable that emits a File

updateFile

@PUT(value="v2/library/files/{fileId}?include_payload=TRUE")
retrofit2.Call<File> updateFile(@Path(value="fileId")
                                                                                             java.lang.String fileId,
                                                                                             @Body
                                                                                             File file)

Update a File

Parameters:

fileId - The File ID

file - File

Returns:

an Observable that emits an updated File

moveFiles

@PUT(value="v2/library/folders/{folderId}/files")
retrofit2.Call<File> moveFiles(@Path(value="folderId")
                                                                                 java.lang.String folderId,
                                                                                 @Body
                                                                                 java.lang.String[] fileIds)

Move multiple File to a different Folder

Parameters:

folderId - The Folder ID

fileIds - Array of File ID's that will be moved to the new folder

Returns:

an Observable that emits an Array of updated Files

deleteFile

@DELETE(value="v2/library/files/{fileId}")
retrofit2.Call<retrofit2.Response> deleteFile(@Path(value="fileId")
                                                                                         java.lang.String fileId)

Delete a File

Parameters:

fileId - The File ID

Returns:

an Observable that emits a Response

deleteFilesInTrash

@DELETE(value="v2/library/folders/trash/files")
retrofit2.Call<retrofit2.Response> deleteFilesInTrash()

Delete all File in the Trash Folder

Returns:

an Observable that emits a Response

getFileUploadStatus

@GET(value="v2/library/files/uploadstatus/{fileId}")
retrofit2.Call<FileUploadStatus[]> getFileUploadStatus(@Path(value="fileId")
                                                                                                            java.lang.String fileIds)

Get the FileUploadStatus of one or more File

Parameters:

fileIds - Send one File ID, or multiples merged into one string separated by commas (no spaces)

Returns:

an Observable that emits an array of FileUploadStatuses

uploadFile

@Multipart
 @Headers(value="Content-Type: multipart/form-data")
 @POST(value="v2/library/files")
retrofit2.Call<retrofit2.Response> uploadFile(@Part(value="data")
                                                                                                                                               okhttp3.RequestBody file,
                                                                                                                                               @Part(value="description")
                                                                                                                                               java.lang.String description,
                                                                                                                                               @Part(value="file_name")
                                                                                                                                               java.lang.String fileName,
                                                                                                                                               @Part(value="file_type")
                                                                                                                                               java.lang.String fileType,
                                                                                                                                               @Part(value="folder_id")
                                                                                                                                               java.lang.String folderId,
                                                                                                                                               @Part(value="source")
                                                                                                                                               java.lang.String source)

Upload a new File to the Library

Parameters:

file - File

description - A description of the file

fileName - The name of the file

fileType - FileType

folderId - The ID of the Folder you wish to upload to

source - FileSource

Returns:

an Observable that emits a Response - the File's new ID can be obtained from the headers of the Response