xyz.euclia.jquots

Interface JQuots

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

JQuotsImplementation

public interface JQuots
extends Closeable

Author:

pantelispanka

Method Summary

Modifier and Type	Method and Description
Future<org.asynchttpclient.Response>	canProceed(String userid, String usageType, String usageSize) Checks user's ability to continue the task after the call users credits will be subtracted after a GET method at /users/{id}/quots with appid, usageType and usageSize params.
Future<org.asynchttpclient.Response>	createUser(String id, String username, String email) Creates user A POST method at /users The request body should be a QuotsUser
Future<org.asynchttpclient.Response>	deleteUser(String userid) Deletes user by id A Delete method at /users/{id} path
Future<org.asynchttpclient.Response>	getUserById(String id) Get user by id A GET method at /users/{id} path.
Future<org.asynchttpclient.Response>	updateUserCredits(QuotsUser quotsUser) Updates user's credits The provided credits will be the user's credits! A PUT method at /users/{id} path.

Methods inherited from interface java.io.Closeable

close

Method Detail

getUserById

Future<org.asynchttpclient.Response> getUserById(String id)

Get user by id A GET method at /users/{id} path.

Parameters:

id - is the users to be created id

Returns:

Future Response get the response when finished. If 200 status you get the user. Other you get an ErrorReport.

createUser

Future<org.asynchttpclient.Response> createUser(String id,
                                                String username,
                                                String email)

Creates user A POST method at /users The request body should be a QuotsUser

Parameters:

id - is the users to be created id

username - is the users to be created username

email - is the users to be created email

Returns:

Future Response get the response when finished. If 200 status you get the user that created Other you get an ErrorReport.

canProceed

Future<org.asynchttpclient.Response> canProceed(String userid,
                                                String usageType,
                                                String usageSize)

Checks user's ability to continue the task after the call users credits will be subtracted after a GET method at /users/{id}/quots with appid, usageType and usageSize params.

Parameters:

userid - is the users id

usageType - is the procedures type

usageSize - is the procedures size

Returns:

Future Response get the response when finished. At the body you get the CanProceed object

deleteUser

Future<org.asynchttpclient.Response> deleteUser(String userid)

Deletes user by id A Delete method at /users/{id} path

Parameters:

userid - is the users id

Returns:

Future Response Get the response when finished. If status 409 body contains the number one as per user deleted. Other than 409 returns an ErrorReport.

updateUserCredits

Future<org.asynchttpclient.Response> updateUserCredits(QuotsUser quotsUser)

Updates user's credits The provided credits will be the user's credits! A PUT method at /users/{id} path.

Parameters:

quotsUser - is the user that is to be updated

Returns:

Future Response Get the response when finished. If status 200 body contains the updated user. Other than 200 returns an ErrorReport.