Package cm.xd.genapi.ynab.api

Class PlansApi

java.lang.Object

cm.xd.genapi.ynab.api.PlansApi

public class PlansApi
extends Object

Constructor Summary

Constructors

Constructor	Description
PlansApi()
PlansApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
PlanDetailResponse	getPlanById(String planId, Long lastKnowledgeOfServer)	Get a plan Returns a single plan with all related entities.
okhttp3.Call	getPlanByIdAsync(String planId, Long lastKnowledgeOfServer, ApiCallback<PlanDetailResponse> _callback)	Get a plan (asynchronously) Returns a single plan with all related entities.
okhttp3.Call	getPlanByIdCall(String planId, Long lastKnowledgeOfServer, ApiCallback _callback)	Build call for getPlanById
ApiResponse<PlanDetailResponse>	getPlanByIdWithHttpInfo(String planId, Long lastKnowledgeOfServer)	Get a plan Returns a single plan with all related entities.
PlanSummaryResponse	getPlans(Boolean includeAccounts)	Get all plans Returns plans list with summary information
okhttp3.Call	getPlansAsync(Boolean includeAccounts, ApiCallback<PlanSummaryResponse> _callback)	Get all plans (asynchronously) Returns plans list with summary information
okhttp3.Call	getPlansCall(Boolean includeAccounts, ApiCallback _callback)	Build call for getPlans
PlanSettingsResponse	getPlanSettingsById(String planId)	Get plan settings Returns settings for a plan
okhttp3.Call	getPlanSettingsByIdAsync(String planId, ApiCallback<PlanSettingsResponse> _callback)	Get plan settings (asynchronously) Returns settings for a plan
okhttp3.Call	getPlanSettingsByIdCall(String planId, ApiCallback _callback)	Build call for getPlanSettingsById
ApiResponse<PlanSettingsResponse>	getPlanSettingsByIdWithHttpInfo(String planId)	Get plan settings Returns settings for a plan
ApiResponse<PlanSummaryResponse>	getPlansWithHttpInfo(Boolean includeAccounts)	Get all plans Returns plans list with summary information
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

PlansApi

public PlansApi()

PlansApi

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

getPlanByIdCall

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

Build call for getPlanById

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

getPlanById

public PlanDetailResponse getPlanById(@Nonnull
 String planId,
 @Nullable
 Long lastKnowledgeOfServer)
                               throws ApiException

Get a plan Returns a single plan with all related entities. This resource is effectively a full plan export.

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:

PlanDetailResponse

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

getPlanByIdWithHttpInfo

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

Get a plan Returns a single plan with all related entities. This resource is effectively a full plan export.

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

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

getPlanByIdAsync

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

Get a plan (asynchronously) Returns a single plan with all related entities. This resource is effectively a full plan export.

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

getPlanSettingsByIdCall

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

Build call for getPlanSettingsById

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 requested plan settings	-
404	The specified plan was not found	-

getPlanSettingsById

public PlanSettingsResponse getPlanSettingsById(@Nonnull
 String planId)
                                         throws ApiException

Get plan settings Returns settings for a plan

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:

PlanSettingsResponse

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 plan settings	-
404	The specified plan was not found	-

getPlanSettingsByIdWithHttpInfo

public ApiResponse<PlanSettingsResponse> getPlanSettingsByIdWithHttpInfo(@Nonnull
 String planId)
                                                                  throws ApiException

Get plan settings Returns settings for a plan

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

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 plan settings	-
404	The specified plan was not found	-

getPlanSettingsByIdAsync

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

Get plan settings (asynchronously) Returns settings for a plan

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 requested plan settings	-
404	The specified plan was not found	-

getPlansCall

public okhttp3.Call getPlansCall(@Nullable
 Boolean includeAccounts,
 ApiCallback _callback)
                          throws ApiException

Build call for getPlans

Parameters:

includeAccounts - Whether to include the list of plan accounts (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 plans	-
404	No plans were found	-

getPlans

public PlanSummaryResponse getPlans(@Nullable
 Boolean includeAccounts)
                             throws ApiException

Get all plans Returns plans list with summary information

Parameters:

includeAccounts - Whether to include the list of plan accounts (optional)

Returns:

PlanSummaryResponse

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

getPlansWithHttpInfo

public ApiResponse<PlanSummaryResponse> getPlansWithHttpInfo(@Nullable
 Boolean includeAccounts)
                                                      throws ApiException

Get all plans Returns plans list with summary information

Parameters:

includeAccounts - Whether to include the list of plan accounts (optional)

Returns:

ApiResponse<PlanSummaryResponse>

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

getPlansAsync

public okhttp3.Call getPlansAsync(@Nullable
 Boolean includeAccounts,
 ApiCallback<PlanSummaryResponse> _callback)
                           throws ApiException

Get all plans (asynchronously) Returns plans list with summary information

Parameters:

includeAccounts - Whether to include the list of plan accounts (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 plans	-
404	No plans were found	-