Package cm.xd.genapi.ynab.api

Class CategoriesApi

java.lang.Object
cm.xd.genapi.ynab.api.CategoriesApi
public class CategoriesApi extends Object

  • Constructor Details

    • CategoriesApi

      public CategoriesApi()

    • CategoriesApi

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

    • createCategoryCall

      public okhttp3.Call createCategoryCall(@Nonnull String planId, @Nonnull PostCategoryWrapper data, ApiCallback _callback) throws ApiException
      Build call for createCategory
      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 category 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 category was successfully created -
      400 The request could not be understood due to malformed syntax or validation error(s). -

    • createCategory

      public SaveCategoryResponse createCategory(@Nonnull String planId, @Nonnull PostCategoryWrapper data) throws ApiException
      Create a category Creates a new category
      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 category to create. (required)
      Returns:
      SaveCategoryResponse
      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 category was successfully created -
      400 The request could not be understood due to malformed syntax or validation error(s). -

    • createCategoryWithHttpInfo

      public ApiResponse<SaveCategoryResponse> createCategoryWithHttpInfo(@Nonnull String planId, @Nonnull PostCategoryWrapper data) throws ApiException
      Create a category Creates a new category
      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 category to create. (required)
      Returns:
      ApiResponse<SaveCategoryResponse>
      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 category was successfully created -
      400 The request could not be understood due to malformed syntax or validation error(s). -

    • createCategoryAsync

      public okhttp3.Call createCategoryAsync(@Nonnull String planId, @Nonnull PostCategoryWrapper data, ApiCallback<SaveCategoryResponse> _callback) throws ApiException
      Create a category (asynchronously) Creates a new category
      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 category 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 category was successfully created -
      400 The request could not be understood due to malformed syntax or validation error(s). -

    • createCategoryGroupCall

      public okhttp3.Call createCategoryGroupCall(@Nonnull String planId, @Nonnull PostCategoryGroupWrapper data, ApiCallback _callback) throws ApiException
      Build call for createCategoryGroup
      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 category group 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 category group was successfully created -
      400 The request could not be understood due to malformed syntax or validation error(s). -

    • createCategoryGroup

      public SaveCategoryGroupResponse createCategoryGroup(@Nonnull String planId, @Nonnull PostCategoryGroupWrapper data) throws ApiException
      Create a category group Creates a new category group
      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 category group to create. (required)
      Returns:
      SaveCategoryGroupResponse
      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 category group was successfully created -
      400 The request could not be understood due to malformed syntax or validation error(s). -

    • createCategoryGroupWithHttpInfo

      public ApiResponse<SaveCategoryGroupResponse> createCategoryGroupWithHttpInfo(@Nonnull String planId, @Nonnull PostCategoryGroupWrapper data) throws ApiException
      Create a category group Creates a new category group
      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 category group to create. (required)
      Returns:
      ApiResponse<SaveCategoryGroupResponse>
      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 category group was successfully created -
      400 The request could not be understood due to malformed syntax or validation error(s). -

    • createCategoryGroupAsync

      public okhttp3.Call createCategoryGroupAsync(@Nonnull String planId, @Nonnull PostCategoryGroupWrapper data, ApiCallback<SaveCategoryGroupResponse> _callback) throws ApiException
      Create a category group (asynchronously) Creates a new category group
      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 category group 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 category group was successfully created -
      400 The request could not be understood due to malformed syntax or validation error(s). -

    • getCategoriesCall

      public okhttp3.Call getCategoriesCall(@Nonnull String planId, @Nullable Long lastKnowledgeOfServer, ApiCallback _callback) throws ApiException
      Build call for getCategories
      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 categories grouped by category group -
      404 No categories were found -

    • getCategories

      public CategoriesResponse getCategories(@Nonnull String planId, @Nullable Long lastKnowledgeOfServer) throws ApiException
      Get all categories Returns all categories grouped by category group. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
      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:
      CategoriesResponse
      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 categories grouped by category group -
      404 No categories were found -

    • getCategoriesWithHttpInfo

      public ApiResponse<CategoriesResponse> getCategoriesWithHttpInfo(@Nonnull String planId, @Nullable Long lastKnowledgeOfServer) throws ApiException
      Get all categories Returns all categories grouped by category group. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
      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<CategoriesResponse>
      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 categories grouped by category group -
      404 No categories were found -

    • getCategoriesAsync

      public okhttp3.Call getCategoriesAsync(@Nonnull String planId, @Nullable Long lastKnowledgeOfServer, ApiCallback<CategoriesResponse> _callback) throws ApiException
      Get all categories (asynchronously) Returns all categories grouped by category group. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
      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 categories grouped by category group -
      404 No categories were found -

    • getCategoryByIdCall

      public okhttp3.Call getCategoryByIdCall(@Nonnull String planId, @Nonnull String categoryId, ApiCallback _callback) throws ApiException
      Build call for getCategoryById
      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)
      categoryId - The id of the category (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 category -
      404 The category was not found -

    • getCategoryById

      public CategoryResponse getCategoryById(@Nonnull String planId, @Nonnull String categoryId) throws ApiException
      Get a category Returns a single category. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
      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)
      categoryId - The id of the category (required)
      Returns:
      CategoryResponse
      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 category -
      404 The category was not found -

    • getCategoryByIdWithHttpInfo

      public ApiResponse<CategoryResponse> getCategoryByIdWithHttpInfo(@Nonnull String planId, @Nonnull String categoryId) throws ApiException
      Get a category Returns a single category. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
      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)
      categoryId - The id of the category (required)
      Returns:
      ApiResponse<CategoryResponse>
      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 category -
      404 The category was not found -

    • getCategoryByIdAsync

      public okhttp3.Call getCategoryByIdAsync(@Nonnull String planId, @Nonnull String categoryId, ApiCallback<CategoryResponse> _callback) throws ApiException
      Get a category (asynchronously) Returns a single category. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
      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)
      categoryId - The id of the category (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 category -
      404 The category was not found -

    • getMonthCategoryByIdCall

      public okhttp3.Call getMonthCategoryByIdCall(@Nonnull String planId, @Nonnull LocalDate month, @Nonnull String categoryId, ApiCallback _callback) throws ApiException
      Build call for getMonthCategoryById
      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)
      categoryId - The id of the category (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 month category -
      404 The month category was not was found -

    • getMonthCategoryById

      public CategoryResponse getMonthCategoryById(@Nonnull String planId, @Nonnull LocalDate month, @Nonnull String categoryId) throws ApiException
      Get a category for a specific plan month Returns a single category for a specific plan month. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
      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)
      categoryId - The id of the category (required)
      Returns:
      CategoryResponse
      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 month category -
      404 The month category was not was found -

    • getMonthCategoryByIdWithHttpInfo

      public ApiResponse<CategoryResponse> getMonthCategoryByIdWithHttpInfo(@Nonnull String planId, @Nonnull LocalDate month, @Nonnull String categoryId) throws ApiException
      Get a category for a specific plan month Returns a single category for a specific plan month. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
      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)
      categoryId - The id of the category (required)
      Returns:
      ApiResponse<CategoryResponse>
      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 month category -
      404 The month category was not was found -

    • getMonthCategoryByIdAsync

      public okhttp3.Call getMonthCategoryByIdAsync(@Nonnull String planId, @Nonnull LocalDate month, @Nonnull String categoryId, ApiCallback<CategoryResponse> _callback) throws ApiException
      Get a category for a specific plan month (asynchronously) Returns a single category for a specific plan month. Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
      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)
      categoryId - The id of the category (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 month category -
      404 The month category was not was found -

    • updateCategoryCall

      public okhttp3.Call updateCategoryCall(@Nonnull String planId, @Nonnull String categoryId, @Nonnull PatchCategoryWrapper data, ApiCallback _callback) throws ApiException
      Build call for updateCategory
      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)
      categoryId - The id of the category (required)
      data - The category 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 category was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateCategory

      public SaveCategoryResponse updateCategory(@Nonnull String planId, @Nonnull String categoryId, @Nonnull PatchCategoryWrapper data) throws ApiException
      Update a category Update a category
      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)
      categoryId - The id of the category (required)
      data - The category to update (required)
      Returns:
      SaveCategoryResponse
      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 category was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateCategoryWithHttpInfo

      public ApiResponse<SaveCategoryResponse> updateCategoryWithHttpInfo(@Nonnull String planId, @Nonnull String categoryId, @Nonnull PatchCategoryWrapper data) throws ApiException
      Update a category Update a category
      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)
      categoryId - The id of the category (required)
      data - The category to update (required)
      Returns:
      ApiResponse<SaveCategoryResponse>
      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 category was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateCategoryAsync

      public okhttp3.Call updateCategoryAsync(@Nonnull String planId, @Nonnull String categoryId, @Nonnull PatchCategoryWrapper data, ApiCallback<SaveCategoryResponse> _callback) throws ApiException
      Update a category (asynchronously) Update a category
      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)
      categoryId - The id of the category (required)
      data - The category 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 category was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateCategoryGroupCall

      public okhttp3.Call updateCategoryGroupCall(@Nonnull String planId, @Nonnull String categoryGroupId, @Nonnull PatchCategoryGroupWrapper data, ApiCallback _callback) throws ApiException
      Build call for updateCategoryGroup
      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)
      categoryGroupId - The id of the category group (required)
      data - The category group 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 category group was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateCategoryGroup

      public SaveCategoryGroupResponse updateCategoryGroup(@Nonnull String planId, @Nonnull String categoryGroupId, @Nonnull PatchCategoryGroupWrapper data) throws ApiException
      Update a category group Update a category group
      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)
      categoryGroupId - The id of the category group (required)
      data - The category group to update (required)
      Returns:
      SaveCategoryGroupResponse
      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 category group was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateCategoryGroupWithHttpInfo

      public ApiResponse<SaveCategoryGroupResponse> updateCategoryGroupWithHttpInfo(@Nonnull String planId, @Nonnull String categoryGroupId, @Nonnull PatchCategoryGroupWrapper data) throws ApiException
      Update a category group Update a category group
      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)
      categoryGroupId - The id of the category group (required)
      data - The category group to update (required)
      Returns:
      ApiResponse<SaveCategoryGroupResponse>
      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 category group was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateCategoryGroupAsync

      public okhttp3.Call updateCategoryGroupAsync(@Nonnull String planId, @Nonnull String categoryGroupId, @Nonnull PatchCategoryGroupWrapper data, ApiCallback<SaveCategoryGroupResponse> _callback) throws ApiException
      Update a category group (asynchronously) Update a category group
      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)
      categoryGroupId - The id of the category group (required)
      data - The category group 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 category group was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateMonthCategoryCall

      public okhttp3.Call updateMonthCategoryCall(@Nonnull String planId, @Nonnull LocalDate month, @Nonnull String categoryId, @Nonnull PatchMonthCategoryWrapper data, ApiCallback _callback) throws ApiException
      Build call for updateMonthCategory
      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)
      categoryId - The id of the category (required)
      data - The category to update. Only `budgeted` (assigned) amount can be updated and any other fields specified will be ignored. (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 month category was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateMonthCategory

      public SaveCategoryResponse updateMonthCategory(@Nonnull String planId, @Nonnull LocalDate month, @Nonnull String categoryId, @Nonnull PatchMonthCategoryWrapper data) throws ApiException
      Update a category for a specific month Update a category for a specific month. Only `budgeted` (assigned) amount can be updated.
      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)
      categoryId - The id of the category (required)
      data - The category to update. Only `budgeted` (assigned) amount can be updated and any other fields specified will be ignored. (required)
      Returns:
      SaveCategoryResponse
      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 month category was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateMonthCategoryWithHttpInfo

      public ApiResponse<SaveCategoryResponse> updateMonthCategoryWithHttpInfo(@Nonnull String planId, @Nonnull LocalDate month, @Nonnull String categoryId, @Nonnull PatchMonthCategoryWrapper data) throws ApiException
      Update a category for a specific month Update a category for a specific month. Only `budgeted` (assigned) amount can be updated.
      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)
      categoryId - The id of the category (required)
      data - The category to update. Only `budgeted` (assigned) amount can be updated and any other fields specified will be ignored. (required)
      Returns:
      ApiResponse<SaveCategoryResponse>
      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 month category was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateMonthCategoryAsync

      public okhttp3.Call updateMonthCategoryAsync(@Nonnull String planId, @Nonnull LocalDate month, @Nonnull String categoryId, @Nonnull PatchMonthCategoryWrapper data, ApiCallback<SaveCategoryResponse> _callback) throws ApiException
      Update a category for a specific month (asynchronously) Update a category for a specific month. Only `budgeted` (assigned) amount can be updated.
      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)
      categoryId - The id of the category (required)
      data - The category to update. Only `budgeted` (assigned) amount can be updated and any other fields specified will be ignored. (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 month category was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -