io.scanbot.shoeboxed

Class ShoeboxedApi

java.lang.Object

io.scanbot.shoeboxed.ShoeboxedApi

public class ShoeboxedApi
extends Object

Shoeboxed API. Replicates HTTP methods of official documentation. For more information, visit official website

Author:

Dmitry Zaytsev

Method Summary

Methods

Modifier and Type	Method and Description
Category	createCategory(long accountId, CreateCategoryRequest request)
Document	createDocument(long accountId, retrofit.mime.TypedFile file, CreateDocumentRequest request)
void	deleteDocument(long accountId, String documentId)
static ShoeboxedApi	forSession(ShoeboxedSession shoeboxedSession)
List<Account>	getAccounts()
List<Category>	getCategories(long accountId)

Methods inherited from class java.lang.Object

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

Method Detail

forSession

public static ShoeboxedApi forSession(ShoeboxedSession shoeboxedSession)

Parameters:

shoeboxedSession - authorized session

Returns:

instance of ShoeboxedApi

getAccounts

public List<Account> getAccounts()
                          throws IOException

Returns:

accounts associated with OAuth token

Throws:

IOException - in case of communication error

getCategories

public List<Category> getCategories(long accountId)
                             throws IOException

Parameters:

accountId - account id

Returns:

list of account categories

Throws:

IOException - in case of communication error

createCategory

public Category createCategory(long accountId,
                      CreateCategoryRequest request)
                        throws IOException

Parameters:

accountId - account id

request - CreateCategoryRequest with information about category

Returns:

newly created Category

Throws:

IOException - in case of communication error

createDocument

public Document createDocument(long accountId,
                      retrofit.mime.TypedFile file,
                      CreateDocumentRequest request)
                        throws IOException

Parameters:

accountId - account id

file - TypedFile to be attached to the document

request - CreateDocumentRequest with information about document

Returns:

newly created Document

Throws:

IOException - in case of communication error

deleteDocument

public void deleteDocument(long accountId,
                  String documentId)
                    throws IOException

Parameters:

accountId - account id

documentId - id of document to delete

Throws:

IOException - in case of communication error