Package cm.xd.genapi.ynab.api

Class PayeesApi

java.lang.Object

cm.xd.genapi.ynab.api.PayeesApi

public class PayeesApi
extends Object

Constructor Summary

Constructors

Constructor	Description
PayeesApi()
PayeesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
SavePayeeResponse	createPayee(String planId, PostPayeeWrapper data)	Create a payee Creates a new payee
okhttp3.Call	createPayeeAsync(String planId, PostPayeeWrapper data, ApiCallback<SavePayeeResponse> _callback)	Create a payee (asynchronously) Creates a new payee
okhttp3.Call	createPayeeCall(String planId, PostPayeeWrapper data, ApiCallback _callback)	Build call for createPayee
ApiResponse<SavePayeeResponse>	createPayeeWithHttpInfo(String planId, PostPayeeWrapper data)	Create a payee Creates a new payee
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
PayeeResponse	getPayeeById(String planId, String payeeId)	Get a payee Returns a single payee
okhttp3.Call	getPayeeByIdAsync(String planId, String payeeId, ApiCallback<PayeeResponse> _callback)	Get a payee (asynchronously) Returns a single payee
okhttp3.Call	getPayeeByIdCall(String planId, String payeeId, ApiCallback _callback)	Build call for getPayeeById
ApiResponse<PayeeResponse>	getPayeeByIdWithHttpInfo(String planId, String payeeId)	Get a payee Returns a single payee
PayeesResponse	getPayees(String planId, Long lastKnowledgeOfServer)	Get all payees Returns all payees
okhttp3.Call	getPayeesAsync(String planId, Long lastKnowledgeOfServer, ApiCallback<PayeesResponse> _callback)	Get all payees (asynchronously) Returns all payees
okhttp3.Call	getPayeesCall(String planId, Long lastKnowledgeOfServer, ApiCallback _callback)	Build call for getPayees
ApiResponse<PayeesResponse>	getPayeesWithHttpInfo(String planId, Long lastKnowledgeOfServer)	Get all payees Returns all payees
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
SavePayeeResponse	updatePayee(String planId, String payeeId, PatchPayeeWrapper data)	Update a payee Update a payee
okhttp3.Call	updatePayeeAsync(String planId, String payeeId, PatchPayeeWrapper data, ApiCallback<SavePayeeResponse> _callback)	Update a payee (asynchronously) Update a payee
okhttp3.Call	updatePayeeCall(String planId, String payeeId, PatchPayeeWrapper data, ApiCallback _callback)	Build call for updatePayee
ApiResponse<SavePayeeResponse>	updatePayeeWithHttpInfo(String planId, String payeeId, PatchPayeeWrapper data)	Update a payee Update a payee

Methods inherited from class java.lang.Object

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

Constructor Details

PayeesApi

public PayeesApi()

PayeesApi

public PayeesApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createPayeeCall

public okhttp3.Call createPayeeCall(@Nonnull
 String planId,
 @Nonnull
 PostPayeeWrapper data,
 ApiCallback _callback)
                             throws ApiException

Build call for createPayee

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

data - The payee to create (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
201	The payee was successfully created	-
400	The request could not be understood due to malformed syntax or validation error(s)	-

createPayee

public SavePayeeResponse createPayee(@Nonnull
 String planId,
 @Nonnull
 PostPayeeWrapper data)
                              throws ApiException

Create a payee Creates a new payee

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

data - The payee to create (required)

Returns:

SavePayeeResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
201	The payee was successfully created	-
400	The request could not be understood due to malformed syntax or validation error(s)	-

createPayeeWithHttpInfo

public ApiResponse<SavePayeeResponse> createPayeeWithHttpInfo(@Nonnull
 String planId,
 @Nonnull
 PostPayeeWrapper data)
                                                       throws ApiException

Create a payee Creates a new payee

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

data - The payee to create (required)

Returns:

ApiResponse<SavePayeeResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
201	The payee was successfully created	-
400	The request could not be understood due to malformed syntax or validation error(s)	-

createPayeeAsync

public okhttp3.Call createPayeeAsync(@Nonnull
 String planId,
 @Nonnull
 PostPayeeWrapper data,
 ApiCallback<SavePayeeResponse> _callback)
                              throws ApiException

Create a payee (asynchronously) Creates a new payee

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

data - The payee to create (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
201	The payee was successfully created	-
400	The request could not be understood due to malformed syntax or validation error(s)	-

getPayeeByIdCall

public okhttp3.Call getPayeeByIdCall(@Nonnull
 String planId,
 @Nonnull
 String payeeId,
 ApiCallback _callback)
                              throws ApiException

Build call for getPayeeById

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

payeeId - The id of the payee (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	The requested payee	-
404	The payee was not found	-

getPayeeById

public PayeeResponse getPayeeById(@Nonnull
 String planId,
 @Nonnull
 String payeeId)
                           throws ApiException

Get a payee Returns a single payee

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

payeeId - The id of the payee (required)

Returns:

PayeeResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	The requested payee	-
404	The payee was not found	-

getPayeeByIdWithHttpInfo

public ApiResponse<PayeeResponse> getPayeeByIdWithHttpInfo(@Nonnull
 String planId,
 @Nonnull
 String payeeId)
                                                    throws ApiException

Get a payee Returns a single payee

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

payeeId - The id of the payee (required)

Returns:

ApiResponse<PayeeResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	The requested payee	-
404	The payee was not found	-

getPayeeByIdAsync

public okhttp3.Call getPayeeByIdAsync(@Nonnull
 String planId,
 @Nonnull
 String payeeId,
 ApiCallback<PayeeResponse> _callback)
                               throws ApiException

Get a payee (asynchronously) Returns a single payee

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

payeeId - The id of the payee (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	The requested payee	-
404	The payee was not found	-

getPayeesCall

public okhttp3.Call getPayeesCall(@Nonnull
 String planId,
 @Nullable
 Long lastKnowledgeOfServer,
 ApiCallback _callback)
                           throws ApiException

Build call for getPayees

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	The requested list of payees	-
404	No payees were found	-

getPayees

public PayeesResponse getPayees(@Nonnull
 String planId,
 @Nullable
 Long lastKnowledgeOfServer)
                         throws ApiException

Get all payees Returns all payees

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)

Returns:

PayeesResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	The requested list of payees	-
404	No payees were found	-

getPayeesWithHttpInfo

public ApiResponse<PayeesResponse> getPayeesWithHttpInfo(@Nonnull
 String planId,
 @Nullable
 Long lastKnowledgeOfServer)
                                                  throws ApiException

Get all payees Returns all payees

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)

Returns:

ApiResponse<PayeesResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	The requested list of payees	-
404	No payees were found	-

getPayeesAsync

public okhttp3.Call getPayeesAsync(@Nonnull
 String planId,
 @Nullable
 Long lastKnowledgeOfServer,
 ApiCallback<PayeesResponse> _callback)
                            throws ApiException

Get all payees (asynchronously) Returns all payees

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

lastKnowledgeOfServer - The starting server knowledge. If provided, only entities that have changed since `last_knowledge_of_server` will be included. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	The requested list of payees	-
404	No payees were found	-

updatePayeeCall

public okhttp3.Call updatePayeeCall(@Nonnull
 String planId,
 @Nonnull
 String payeeId,
 @Nonnull
 PatchPayeeWrapper data,
 ApiCallback _callback)
                             throws ApiException

Build call for updatePayee

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

payeeId - The id of the payee (required)

data - The payee to update (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	The payee was successfully updated	-
400	The request could not be understood due to malformed syntax or validation error(s)	-

updatePayee

public SavePayeeResponse updatePayee(@Nonnull
 String planId,
 @Nonnull
 String payeeId,
 @Nonnull
 PatchPayeeWrapper data)
                              throws ApiException

Update a payee Update a payee

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

payeeId - The id of the payee (required)

data - The payee to update (required)

Returns:

SavePayeeResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	The payee was successfully updated	-
400	The request could not be understood due to malformed syntax or validation error(s)	-

updatePayeeWithHttpInfo

public ApiResponse<SavePayeeResponse> updatePayeeWithHttpInfo(@Nonnull
 String planId,
 @Nonnull
 String payeeId,
 @Nonnull
 PatchPayeeWrapper data)
                                                       throws ApiException

Update a payee Update a payee

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

payeeId - The id of the payee (required)

data - The payee to update (required)

Returns:

ApiResponse<SavePayeeResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Response Details

Status Code	Description	Response Headers
200	The payee was successfully updated	-
400	The request could not be understood due to malformed syntax or validation error(s)	-

updatePayeeAsync

public okhttp3.Call updatePayeeAsync(@Nonnull
 String planId,
 @Nonnull
 String payeeId,
 @Nonnull
 PatchPayeeWrapper data,
 ApiCallback<SavePayeeResponse> _callback)
                              throws ApiException

Update a payee (asynchronously) Update a payee

Parameters:

planId - The id of the plan. \"last-used\" can be used to specify the last used plan and \"default\" can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). (required)

payeeId - The id of the payee (required)

data - The payee to update (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	The payee was successfully updated	-
400	The request could not be understood due to malformed syntax or validation error(s)	-