Package cm.xd.genapi.ynab.api

Class PayeeLocationsApi

java.lang.Object

cm.xd.genapi.ynab.api.PayeeLocationsApi

public class PayeeLocationsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
PayeeLocationsApi()
PayeeLocationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
PayeeLocationResponse	getPayeeLocationById(String planId, String payeeLocationId)	Get a payee location Returns a single payee location
okhttp3.Call	getPayeeLocationByIdAsync(String planId, String payeeLocationId, ApiCallback<PayeeLocationResponse> _callback)	Get a payee location (asynchronously) Returns a single payee location
okhttp3.Call	getPayeeLocationByIdCall(String planId, String payeeLocationId, ApiCallback _callback)	Build call for getPayeeLocationById
ApiResponse<PayeeLocationResponse>	getPayeeLocationByIdWithHttpInfo(String planId, String payeeLocationId)	Get a payee location Returns a single payee location
PayeeLocationsResponse	getPayeeLocations(String planId)	Get all payee locations Returns all payee locations
okhttp3.Call	getPayeeLocationsAsync(String planId, ApiCallback<PayeeLocationsResponse> _callback)	Get all payee locations (asynchronously) Returns all payee locations
PayeeLocationsResponse	getPayeeLocationsByPayee(String planId, String payeeId)	Get all locations for a payee Returns all payee locations for a specified payee
okhttp3.Call	getPayeeLocationsByPayeeAsync(String planId, String payeeId, ApiCallback<PayeeLocationsResponse> _callback)	Get all locations for a payee (asynchronously) Returns all payee locations for a specified payee
okhttp3.Call	getPayeeLocationsByPayeeCall(String planId, String payeeId, ApiCallback _callback)	Build call for getPayeeLocationsByPayee
ApiResponse<PayeeLocationsResponse>	getPayeeLocationsByPayeeWithHttpInfo(String planId, String payeeId)	Get all locations for a payee Returns all payee locations for a specified payee
okhttp3.Call	getPayeeLocationsCall(String planId, ApiCallback _callback)	Build call for getPayeeLocations
ApiResponse<PayeeLocationsResponse>	getPayeeLocationsWithHttpInfo(String planId)	Get all payee locations Returns all payee locations
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Details

PayeeLocationsApi

public PayeeLocationsApi()

PayeeLocationsApi

public PayeeLocationsApi(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)

getPayeeLocationByIdCall

public okhttp3.Call getPayeeLocationByIdCall(@Nonnull
 String planId,
 @Nonnull
 String payeeLocationId,
 ApiCallback _callback)
                                      throws ApiException

Build call for getPayeeLocationById

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)

payeeLocationId - id of payee location (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 location	-
404	The payee location was not found	-

getPayeeLocationById

public PayeeLocationResponse getPayeeLocationById(@Nonnull
 String planId,
 @Nonnull
 String payeeLocationId)
                                           throws ApiException

Get a payee location Returns a single payee location

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)

payeeLocationId - id of payee location (required)

Returns:

PayeeLocationResponse

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 location	-
404	The payee location was not found	-

getPayeeLocationByIdWithHttpInfo

public ApiResponse<PayeeLocationResponse> getPayeeLocationByIdWithHttpInfo(@Nonnull
 String planId,
 @Nonnull
 String payeeLocationId)
                                                                    throws ApiException

Get a payee location Returns a single payee location

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)

payeeLocationId - id of payee location (required)

Returns:

ApiResponse<PayeeLocationResponse>

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 location	-
404	The payee location was not found	-

getPayeeLocationByIdAsync

public okhttp3.Call getPayeeLocationByIdAsync(@Nonnull
 String planId,
 @Nonnull
 String payeeLocationId,
 ApiCallback<PayeeLocationResponse> _callback)
                                       throws ApiException

Get a payee location (asynchronously) Returns a single payee location

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)

payeeLocationId - id of payee location (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 location	-
404	The payee location was not found	-

getPayeeLocationsCall

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

Build call for getPayeeLocations

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)

_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 list of payee locations	-
404	No payees locations were found	-

getPayeeLocations

public PayeeLocationsResponse getPayeeLocations(@Nonnull
 String planId)
                                         throws ApiException

Get all payee locations Returns all payee locations

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)

Returns:

PayeeLocationsResponse

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 list of payee locations	-
404	No payees locations were found	-

getPayeeLocationsWithHttpInfo

public ApiResponse<PayeeLocationsResponse> getPayeeLocationsWithHttpInfo(@Nonnull
 String planId)
                                                                  throws ApiException

Get all payee locations Returns all payee locations

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)

Returns:

ApiResponse<PayeeLocationsResponse>

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 list of payee locations	-
404	No payees locations were found	-

getPayeeLocationsAsync

public okhttp3.Call getPayeeLocationsAsync(@Nonnull
 String planId,
 ApiCallback<PayeeLocationsResponse> _callback)
                                    throws ApiException

Get all payee locations (asynchronously) Returns all payee locations

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)

_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 list of payee locations	-
404	No payees locations were found	-

getPayeeLocationsByPayeeCall

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

Build call for getPayeeLocationsByPayee

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 - id of 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 list of requested payee locations	-
404	No payees locations were found	-

getPayeeLocationsByPayee

public PayeeLocationsResponse getPayeeLocationsByPayee(@Nonnull
 String planId,
 @Nonnull
 String payeeId)
                                                throws ApiException

Get all locations for a payee Returns all payee locations for a specified 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 - id of payee (required)

Returns:

PayeeLocationsResponse

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 list of requested payee locations	-
404	No payees locations were found	-

getPayeeLocationsByPayeeWithHttpInfo

public ApiResponse<PayeeLocationsResponse> getPayeeLocationsByPayeeWithHttpInfo(@Nonnull
 String planId,
 @Nonnull
 String payeeId)
                                                                         throws ApiException

Get all locations for a payee Returns all payee locations for a specified 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 - id of payee (required)

Returns:

ApiResponse<PayeeLocationsResponse>

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 list of requested payee locations	-
404	No payees locations were found	-

getPayeeLocationsByPayeeAsync

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

Get all locations for a payee (asynchronously) Returns all payee locations for a specified 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 - id of 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 list of requested payee locations	-
404	No payees locations were found	-