com.plaid.client.PlaidApiService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plaid-java Show documentation
Show all versions of plaid-java Show documentation
Bindings for the Plaid (plaid.com) API.
package com.plaid.client;
import com.plaid.client.request.AccountsBalanceGetRequest;
import com.plaid.client.request.AccountsGetRequest;
import com.plaid.client.request.AssetReportAuditCopyCreateRequest;
import com.plaid.client.request.AssetReportAuditCopyGetRequest;
import com.plaid.client.request.AssetReportAuditCopyRemoveRequest;
import com.plaid.client.request.AssetReportCreateRequest;
import com.plaid.client.request.AssetReportFilterRequest;
import com.plaid.client.request.AssetReportGetRequest;
import com.plaid.client.request.AssetReportPdfGetRequest;
import com.plaid.client.request.AssetReportRefreshRequest;
import com.plaid.client.request.AssetReportRemoveRequest;
import com.plaid.client.request.AuthGetRequest;
import com.plaid.client.request.CategoriesGetRequest;
import com.plaid.client.request.CreditDetailsGetRequest;
import com.plaid.client.request.IdentityGetRequest;
import com.plaid.client.request.IncomeGetRequest;
import com.plaid.client.request.InstitutionsGetByIdRequest;
import com.plaid.client.request.InstitutionsGetRequest;
import com.plaid.client.request.InstitutionsSearchRequest;
import com.plaid.client.request.ItemAccessTokenInvalidateRequest;
import com.plaid.client.request.ItemAccessTokenUpdateVersionRequest;
import com.plaid.client.request.ItemApexProcessorTokenCreateRequest;
import com.plaid.client.request.ItemCreateRequest;
import com.plaid.client.request.ItemCredentialsEncryptRequest;
import com.plaid.client.request.ItemCredentialsUpdateRequest;
import com.plaid.client.request.ItemDeleteRequest;
import com.plaid.client.request.ItemDwollaProcessorTokenCreateRequest;
import com.plaid.client.request.ItemGetRequest;
import com.plaid.client.request.ItemMfaEncryptRequest;
import com.plaid.client.request.ItemMfaRequest;
import com.plaid.client.request.ItemPublicTokenCreateRequest;
import com.plaid.client.request.ItemPublicTokenExchangeRequest;
import com.plaid.client.request.ItemRemoveRequest;
import com.plaid.client.request.ItemStripeTokenCreateRequest;
import com.plaid.client.request.ItemWebhookUpdateRequest;
import com.plaid.client.request.SandboxItemResetLoginRequest;
import com.plaid.client.request.SandboxPublicTokenCreateRequest;
import com.plaid.client.request.TransactionsGetRequest;
import com.plaid.client.response.AccountsBalanceGetResponse;
import com.plaid.client.response.AccountsGetResponse;
import com.plaid.client.response.AssetReportAuditCopyCreateResponse;
import com.plaid.client.response.AssetReportAuditCopyRemoveResponse;
import com.plaid.client.response.AssetReportCreateResponse;
import com.plaid.client.response.AssetReportGetResponse;
import com.plaid.client.response.AssetReportRemoveResponse;
import com.plaid.client.response.AuthGetResponse;
import com.plaid.client.response.CategoriesGetResponse;
import com.plaid.client.response.CreditDetailsGetResponse;
import com.plaid.client.response.IdentityGetResponse;
import com.plaid.client.response.IncomeGetResponse;
import com.plaid.client.response.InstitutionsGetByIdResponse;
import com.plaid.client.response.InstitutionsGetResponse;
import com.plaid.client.response.InstitutionsSearchResponse;
import com.plaid.client.response.ItemAccessTokenInvalidateResponse;
import com.plaid.client.response.ItemAccessTokenUpdateVersionResponse;
import com.plaid.client.response.ItemApexProcessorTokenCreateResponse;
import com.plaid.client.response.ItemCreateResponse;
import com.plaid.client.response.ItemCredentialsEncryptResponse;
import com.plaid.client.response.ItemCredentialsUpdateResponse;
import com.plaid.client.response.ItemDeleteResponse;
import com.plaid.client.response.ItemDwollaProcessorTokenCreateResponse;
import com.plaid.client.response.ItemGetResponse;
import com.plaid.client.response.ItemMfaEncryptResponse;
import com.plaid.client.response.ItemMfaResponse;
import com.plaid.client.response.ItemPublicTokenCreateResponse;
import com.plaid.client.response.ItemPublicTokenExchangeResponse;
import com.plaid.client.response.ItemRemoveResponse;
import com.plaid.client.response.ItemStripeTokenCreateResponse;
import com.plaid.client.response.ItemWebhookUpdateResponse;
import com.plaid.client.response.SandboxItemResetLoginResponse;
import com.plaid.client.response.SandboxPublicTokenCreateResponse;
import com.plaid.client.response.TransactionsGetResponse;
import okhttp3.ResponseBody;
import retrofit2.Call;
import retrofit2.http.Body;
import retrofit2.http.POST;
public interface PlaidApiService {
// item, link, and credentials calls
////////////////////////////////////////////////////////
////////////////////////////////////////////////////////
@POST("/item/create")
Call itemCreate(@Body ItemCreateRequest request);
@POST("/item/mfa")
Call itemMfa(@Body ItemMfaRequest request);
@POST("/item/get")
Call itemGet(@Body ItemGetRequest request);
@POST("/item/credentials/update")
Call itemCredentialsUpdate(@Body ItemCredentialsUpdateRequest request);
@POST("/item/credentials/encrypt")
Call itemCredentialsEncrypt(@Body ItemCredentialsEncryptRequest request);
@POST("/item/mfa/encrypt")
Call itemMfaEncrypt(@Body ItemMfaEncryptRequest request);
@POST("/item/public_token/exchange")
Call itemPublicTokenExchange(@Body ItemPublicTokenExchangeRequest request);
@POST("/item/public_token/create")
Call itemPublicTokenCreate(@Body ItemPublicTokenCreateRequest request);
@POST("/processor/stripe/bank_account_token/create")
Call itemStripeTokenCreate(@Body ItemStripeTokenCreateRequest request);
@POST("/processor/apex/processor_token/create")
Call itemApexProcessorTokenCreate(@Body ItemApexProcessorTokenCreateRequest request);
@POST("/processor/dwolla/processor_token/create")
Call itemDwollaProcessorTokenCreate(@Body ItemDwollaProcessorTokenCreateRequest request);
@POST("/item/access_token/invalidate")
Call itemAccessTokenInvalidate(@Body ItemAccessTokenInvalidateRequest request);
@POST("/item/access_token/update_version")
Call itemAccessTokenUpdateVersion(@Body ItemAccessTokenUpdateVersionRequest request);
@POST("/item/delete")
Call itemDelete(@Body ItemDeleteRequest request);
@POST("/item/remove")
Call itemRemove(@Body ItemRemoveRequest request);
@POST("/item/webhook/update")
Call itemWebhookUpdate(@Body ItemWebhookUpdateRequest request);
// sandbox-only endpoints
////////////////////////////////////////////////////////
////////////////////////////////////////////////////////
@POST("/sandbox/item/reset_login")
Call sandboxItemResetLogin(@Body SandboxItemResetLoginRequest request);
@POST("/sandbox/public_token/create")
Call sandboxPublicTokenCreate(@Body SandboxPublicTokenCreateRequest request);
// products
////////////////////////////////////////////////////////
////////////////////////////////////////////////////////
@POST("/accounts/get")
Call accountsGet(@Body AccountsGetRequest request);
@POST("/accounts/balance/get")
Call accountsBalanceGet(@Body AccountsBalanceGetRequest request);
@POST("/asset_report/create")
Call assetReportCreate(@Body AssetReportCreateRequest request);
@POST("/asset_report/get")
Call assetReportGet(@Body AssetReportGetRequest request);
// This returns raw bytes so we don't have a wrapper class
@POST("/asset_report/pdf/get")
Call assetReportPdfGet(@Body AssetReportPdfGetRequest request);
@POST("/asset_report/remove")
Call assetReportRemove(@Body AssetReportRemoveRequest request);
@POST("/asset_report/audit_copy/create")
Call assetReportAuditCopyCreate(@Body AssetReportAuditCopyCreateRequest request);
@POST("/asset_report/audit_copy/remove")
Call assetReportAuditCopyRemove(@Body AssetReportAuditCopyRemoveRequest request);
@POST("/asset_report/audit_copy/get")
Call assetReportAuditCopyGet(@Body AssetReportAuditCopyGetRequest request);
@POST("/asset_report/refresh")
Call assetReportRefresh(@Body AssetReportRefreshRequest assetReportRefreshRequest);
@POST("/asset_report/filter")
Call assetReportFilter(@Body AssetReportFilterRequest assetReportFilterRequest);
@POST("/auth/get")
Call authGet(@Body AuthGetRequest request);
@POST("/identity/get")
Call identityGet(@Body IdentityGetRequest request);
@POST("/income/get")
Call incomeGet(@Body IncomeGetRequest request);
@POST("/transactions/get")
Call transactionsGet(@Body TransactionsGetRequest request);
@POST("/credit_details/get")
Call creditDetailsGet(@Body CreditDetailsGetRequest request);
@POST("/categories/get")
Call categoriesGet(@Body CategoriesGetRequest request);
// institutions
////////////////////////////////////////////////////////
////////////////////////////////////////////////////////
@POST("/institutions/get")
Call institutionsGet(@Body InstitutionsGetRequest request);
@POST("/institutions/get_by_id")
Call institutionsGetById(@Body InstitutionsGetByIdRequest request);
@POST("/institutions/search")
Call institutionsSearch(@Body InstitutionsSearchRequest request);
}