com.inmanlabs.commons.onfleet

Class OnfleetClient

java.lang.Object

com.inmanlabs.commons.onfleet.OnfleetClient

@Service
public class OnfleetClient
extends Object

Constructor Summary

Constructors

Constructor and Description
OnfleetClient()

Method Summary

Modifier and Type	Method and Description
OnfleetDestination	createDestination(OnfleetDestination destination) Creates a Destination (the location details for a Task)
OnfleetRecipient	createRecipient(OnfleetRecipient recipient) Creates a Recipient (an organization’s customer and a target for a task, that is, whom the task is being delivered to.)
OnfleetTask	createTask(OnfleetTask task)
OnfleetDestination	getDestination(String id) Gets a Destination by ID
OnfleetOrganization	getMyOrganization() Loads the organization of the caller from OnFleet.
OnfleetRecipient	getRecipient(String id) Gets a Destination by ID
OnfleetAuthTestResponse	testAuth()
List<OnfleetTask>	uploadTasksBatch(List<OnfleetTask> tasks)

Methods inherited from class java.lang.Object

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

Constructor Detail

OnfleetClient

public OnfleetClient()

Method Detail

createDestination

public OnfleetDestination createDestination(OnfleetDestination destination)
                                     throws FailedDependencyException

Creates a Destination (the location details for a Task)

http://docs.onfleet.com/docs/destinations

Returns:

the created Onfleet resource

Throws:

FailedDependencyException

getDestination

public OnfleetDestination getDestination(String id)
                                  throws FailedDependencyException

Gets a Destination by ID

http://docs.onfleet.com/docs/destinations

Returns:

the requested OnFleet Destination

Throws:

FailedDependencyException

getMyOrganization

public OnfleetOrganization getMyOrganization()
                                      throws FailedDependencyException

Loads the organization of the caller from OnFleet.

http://docs.onfleet.com/docs/organizations

Returns:

the configured OnFleet Organization

Throws:

FailedDependencyException

createRecipient

public OnfleetRecipient createRecipient(OnfleetRecipient recipient)
                                 throws FailedDependencyException

Creates a Recipient (an organization’s customer and a target for a task, that is, whom the task is being delivered to.)

http://docs.onfleet.com/docs/recipients

Returns:

the created Onfleet Recipient

Throws:

FailedDependencyException

getRecipient

public OnfleetRecipient getRecipient(String id)
                              throws FailedDependencyException

Gets a Destination by ID

http://docs.onfleet.com/docs/destinations

Returns:

the requested OnFleet Recipient

Throws:

FailedDependencyException

createTask

public OnfleetTask createTask(@NonNull
                              OnfleetTask task)
                       throws FailedDependencyException

Throws:

FailedDependencyException

uploadTasksBatch

public List<OnfleetTask> uploadTasksBatch(@NonNull
                                          List<OnfleetTask> tasks)
                                   throws FailedDependencyException

Throws:

FailedDependencyException

testAuth

public OnfleetAuthTestResponse testAuth()
                                 throws FailedDependencyException

Throws:

FailedDependencyException