Package cm.xd.genapi.ynab.api

Class MonthsApi

java.lang.Object

cm.xd.genapi.ynab.api.MonthsApi

public class MonthsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
MonthsApi()
MonthsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
MonthDetailResponse	getPlanMonth(String planId, LocalDate month)	Get a plan month Returns a single plan month
okhttp3.Call	getPlanMonthAsync(String planId, LocalDate month, ApiCallback<MonthDetailResponse> _callback)	Get a plan month (asynchronously) Returns a single plan month
okhttp3.Call	getPlanMonthCall(String planId, LocalDate month, ApiCallback _callback)	Build call for getPlanMonth
MonthSummariesResponse	getPlanMonths(String planId, Long lastKnowledgeOfServer)	Get all plan months Returns all plan months
okhttp3.Call	getPlanMonthsAsync(String planId, Long lastKnowledgeOfServer, ApiCallback<MonthSummariesResponse> _callback)	Get all plan months (asynchronously) Returns all plan months
okhttp3.Call	getPlanMonthsCall(String planId, Long lastKnowledgeOfServer, ApiCallback _callback)	Build call for getPlanMonths
ApiResponse<MonthSummariesResponse>	getPlanMonthsWithHttpInfo(String planId, Long lastKnowledgeOfServer)	Get all plan months Returns all plan months
ApiResponse<MonthDetailResponse>	getPlanMonthWithHttpInfo(String planId, LocalDate month)	Get a plan month Returns a single plan month
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

MonthsApi

public MonthsApi()

MonthsApi

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

getPlanMonthCall

public okhttp3.Call getPlanMonthCall(@Nonnull
 String planId,
 @Nonnull
 LocalDate month,
 ApiCallback _callback)
                              throws ApiException

Build call for getPlanMonth

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)

month - The plan month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) (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 plan month detail	-
404	The plan month was not found	-

getPlanMonth

public MonthDetailResponse getPlanMonth(@Nonnull
 String planId,
 @Nonnull
 LocalDate month)
                                 throws ApiException

Get a plan month Returns a single plan month

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)

month - The plan month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) (required)

Returns:

MonthDetailResponse

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 plan month detail	-
404	The plan month was not found	-

getPlanMonthWithHttpInfo

public ApiResponse<MonthDetailResponse> getPlanMonthWithHttpInfo(@Nonnull
 String planId,
 @Nonnull
 LocalDate month)
                                                          throws ApiException

Get a plan month Returns a single plan month

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)

month - The plan month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) (required)

Returns:

ApiResponse<MonthDetailResponse>

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 plan month detail	-
404	The plan month was not found	-

getPlanMonthAsync

public okhttp3.Call getPlanMonthAsync(@Nonnull
 String planId,
 @Nonnull
 LocalDate month,
 ApiCallback<MonthDetailResponse> _callback)
                               throws ApiException

Get a plan month (asynchronously) Returns a single plan month

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)

month - The plan month in ISO format (e.g. 2016-12-01) (\"current\" can also be used to specify the current calendar month (UTC)) (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 plan month detail	-
404	The plan month was not found	-

getPlanMonthsCall

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

Build call for getPlanMonths

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 list of plan months	-
404	No plan months were found	-

getPlanMonths

public MonthSummariesResponse getPlanMonths(@Nonnull
 String planId,
 @Nullable
 Long lastKnowledgeOfServer)
                                     throws ApiException

Get all plan months Returns all plan months

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:

MonthSummariesResponse

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 plan months	-
404	No plan months were found	-

getPlanMonthsWithHttpInfo

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

Get all plan months Returns all plan months

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<MonthSummariesResponse>

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 plan months	-
404	No plan months were found	-

getPlanMonthsAsync

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

Get all plan months (asynchronously) Returns all plan months

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 list of plan months	-
404	No plan months were found	-