dev.haven.jclient.api

Interface DefaultApi

public interface DefaultApi

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<TenantServiceAccountAgentLoginResponse>	createAccessToken(TenantServiceAccountAgentLoginRequest tenantServiceAccountAgentLoginRequest)
retrofit2.Call<CreateWebhookResponse>	createWebhook(CreateWebhookRequest createWebhookRequest)
retrofit2.Call<EmptyResponse>	deleteAccount(java.lang.String accountId)
retrofit2.Call<EmptyResponse>	deleteForUser(java.lang.String endUserId)
retrofit2.Call<EmptyResponse>	deleteTransaction(java.lang.String transactionId)
retrofit2.Call<EmptyResponse>	deleteWebhook(java.lang.String webhookId)
retrofit2.Call<GetAccountsResponse>	getAccountsForUser(java.lang.String endUserId)
retrofit2.Call<GetMerchantResponse>	getMerchant(java.lang.String merchantId)
retrofit2.Call<GetTransactionsResponse>	getTransactions(java.lang.String endUserId, java.lang.String highWaterMark, java.lang.Integer limit)
retrofit2.Call<GetWebhooksResponse>	getWebhooks()
retrofit2.Call<EmptyResponse>	upsertAccount(AccountRequestWrapper accountRequestWrapper)
retrofit2.Call<EmptyResponse>	upsertBatchTransactions(UploadBatchTransactionsRequest uploadBatchTransactionsRequest)
retrofit2.Call<CleanSingleTransactionResponse>	upsertOneTransaction(CleanSingleTransactionRequest cleanSingleTransactionRequest)
retrofit2.Call<AddAnnotationResponse>	upsertUserAnnotation(java.lang.String transactionId, AddAnnotationRequest addAnnotationRequest)

Method Detail

createAccessToken

@Headers(value="Content-Type:application/json")
 @POST(value="v1/tokens")
retrofit2.Call<TenantServiceAccountAgentLoginResponse> createAccessToken(@Body
                                                                                                                                                   TenantServiceAccountAgentLoginRequest tenantServiceAccountAgentLoginRequest)

Parameters:

tenantServiceAccountAgentLoginRequest - (required)

Returns:

Call<TenantServiceAccountAgentLoginResponse>

createWebhook

@Headers(value="Content-Type:application/json")
 @POST(value="v1/webhooks")
retrofit2.Call<CreateWebhookResponse> createWebhook(@Body
                                                                                                                                CreateWebhookRequest createWebhookRequest)

Parameters:

createWebhookRequest - (required)

Returns:

Call<CreateWebhookResponse>

deleteAccount

@DELETE(value="v1/accounts/{AccountId}")
retrofit2.Call<EmptyResponse> deleteAccount(@Path(value="AccountId")
                                                                                     java.lang.String accountId)

Parameters:

accountId - (required)

Returns:

Call<EmptyResponse>

deleteForUser

@DELETE(value="v1/users/{EndUserId}")
retrofit2.Call<EmptyResponse> deleteForUser(@Path(value="EndUserId")
                                                                                  java.lang.String endUserId)

Parameters:

endUserId - (required)

Returns:

Call<EmptyResponse>

deleteTransaction

@DELETE(value="v1/transactions/{TransactionId}")
retrofit2.Call<EmptyResponse> deleteTransaction(@Path(value="TransactionId")
                                                                                                 java.lang.String transactionId)

Parameters:

transactionId - (required)

Returns:

Call<EmptyResponse>

deleteWebhook

@DELETE(value="v1/webhooks/{WebhookId}")
retrofit2.Call<EmptyResponse> deleteWebhook(@Path(value="WebhookId")
                                                                                     java.lang.String webhookId)

Parameters:

webhookId - (required)

Returns:

Call<EmptyResponse>

getAccountsForUser

@GET(value="v1/accounts/user/{EndUserId}")
retrofit2.Call<GetAccountsResponse> getAccountsForUser(@Path(value="EndUserId")
                                                                                                  java.lang.String endUserId)

Parameters:

endUserId - (required)

Returns:

Call<GetAccountsResponse>

getMerchant

@GET(value="v1/merchants/{MerchantId}")
retrofit2.Call<GetMerchantResponse> getMerchant(@Path(value="MerchantId")
                                                                                        java.lang.String merchantId)

Parameters:

merchantId - (required)

Returns:

Call<GetMerchantResponse>

getTransactions

@GET(value="v1/transactions/{EndUserId}")
retrofit2.Call<GetTransactionsResponse> getTransactions(@Path(value="EndUserId")
                                                                                                  java.lang.String endUserId,
                                                                                                  @Query(value="highWaterMark")
                                                                                                  java.lang.String highWaterMark,
                                                                                                  @Query(value="limit")
                                                                                                  java.lang.Integer limit)

Parameters:

endUserId - (required)

highWaterMark - (optional)

limit - (optional)

Returns:

Call<GetTransactionsResponse>

getWebhooks

@GET(value="v1/webhooks")
retrofit2.Call<GetWebhooksResponse> getWebhooks()

Returns:

Call<GetWebhooksResponse>

upsertAccount

@Headers(value="Content-Type:application/json")
 @PUT(value="v1/accounts")
retrofit2.Call<EmptyResponse> upsertAccount(@Body
                                                                                                                       AccountRequestWrapper accountRequestWrapper)

Parameters:

accountRequestWrapper - (required)

Returns:

Call<EmptyResponse>

upsertBatchTransactions

@Headers(value="Content-Type:application/json")
 @POST(value="v1/transactions/batch")
retrofit2.Call<EmptyResponse> upsertBatchTransactions(@Body
                                                                                                                                            UploadBatchTransactionsRequest uploadBatchTransactionsRequest)

Parameters:

uploadBatchTransactionsRequest - (required)

Returns:

Call<EmptyResponse>

upsertOneTransaction

@Headers(value="Content-Type:application/json")
 @POST(value="v1/transactions/online")
retrofit2.Call<CleanSingleTransactionResponse> upsertOneTransaction(@Body
                                                                                                                                                           CleanSingleTransactionRequest cleanSingleTransactionRequest)

Parameters:

cleanSingleTransactionRequest - (required)

Returns:

Call<CleanSingleTransactionResponse>

upsertUserAnnotation

@Headers(value="Content-Type:application/json")
 @POST(value="v1/annotations/{TransactionId}")
retrofit2.Call<AddAnnotationResponse> upsertUserAnnotation(@Path(value="TransactionId")
                                                                                                                                                          java.lang.String transactionId,
                                                                                                                                                          @Body
                                                                                                                                                          AddAnnotationRequest addAnnotationRequest)

Parameters:

transactionId - (required)

addAnnotationRequest - (required)

Returns:

Call<AddAnnotationResponse>