Package cm.xd.genapi.ynab.api

Class ScheduledTransactionsApi

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

  • Constructor Details

    • ScheduledTransactionsApi

      public ScheduledTransactionsApi()

    • ScheduledTransactionsApi

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

    • createScheduledTransactionCall

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

    • createScheduledTransaction

      public ScheduledTransactionResponse createScheduledTransaction(@Nonnull String planId, @Nonnull PostScheduledTransactionWrapper data) throws ApiException
      Create a scheduled transaction Creates a single scheduled transaction (a transaction with a future date).
      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 scheduled transaction to create (required)
      Returns:
      ScheduledTransactionResponse
      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 scheduled transaction was successfully created -
      400 The request could not be understood due to malformed syntax or validation error(s). -

    • createScheduledTransactionWithHttpInfo

      public ApiResponse<ScheduledTransactionResponse> createScheduledTransactionWithHttpInfo(@Nonnull String planId, @Nonnull PostScheduledTransactionWrapper data) throws ApiException
      Create a scheduled transaction Creates a single scheduled transaction (a transaction with a future date).
      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 scheduled transaction to create (required)
      Returns:
      ApiResponse<ScheduledTransactionResponse>
      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 scheduled transaction was successfully created -
      400 The request could not be understood due to malformed syntax or validation error(s). -

    • createScheduledTransactionAsync

      public okhttp3.Call createScheduledTransactionAsync(@Nonnull String planId, @Nonnull PostScheduledTransactionWrapper data, ApiCallback<ScheduledTransactionResponse> _callback) throws ApiException
      Create a scheduled transaction (asynchronously) Creates a single scheduled transaction (a transaction with a future date).
      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 scheduled transaction 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 scheduled transaction was successfully created -
      400 The request could not be understood due to malformed syntax or validation error(s). -

    • deleteScheduledTransactionCall

      public okhttp3.Call deleteScheduledTransactionCall(@Nonnull String planId, @Nonnull String scheduledTransactionId, ApiCallback _callback) throws ApiException
      Build call for deleteScheduledTransaction
      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)
      scheduledTransactionId - The id of the scheduled transaction (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 scheduled transaction was successfully deleted -
      404 The scheduled transaction was not found -

    • deleteScheduledTransaction

      public ScheduledTransactionResponse deleteScheduledTransaction(@Nonnull String planId, @Nonnull String scheduledTransactionId) throws ApiException
      Delete a scheduled transaction Deletes a scheduled transaction
      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)
      scheduledTransactionId - The id of the scheduled transaction (required)
      Returns:
      ScheduledTransactionResponse
      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 scheduled transaction was successfully deleted -
      404 The scheduled transaction was not found -

    • deleteScheduledTransactionWithHttpInfo

      public ApiResponse<ScheduledTransactionResponse> deleteScheduledTransactionWithHttpInfo(@Nonnull String planId, @Nonnull String scheduledTransactionId) throws ApiException
      Delete a scheduled transaction Deletes a scheduled transaction
      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)
      scheduledTransactionId - The id of the scheduled transaction (required)
      Returns:
      ApiResponse<ScheduledTransactionResponse>
      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 scheduled transaction was successfully deleted -
      404 The scheduled transaction was not found -

    • deleteScheduledTransactionAsync

      public okhttp3.Call deleteScheduledTransactionAsync(@Nonnull String planId, @Nonnull String scheduledTransactionId, ApiCallback<ScheduledTransactionResponse> _callback) throws ApiException
      Delete a scheduled transaction (asynchronously) Deletes a scheduled transaction
      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)
      scheduledTransactionId - The id of the scheduled transaction (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 scheduled transaction was successfully deleted -
      404 The scheduled transaction was not found -

    • getScheduledTransactionByIdCall

      public okhttp3.Call getScheduledTransactionByIdCall(@Nonnull String planId, @Nonnull String scheduledTransactionId, ApiCallback _callback) throws ApiException
      Build call for getScheduledTransactionById
      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)
      scheduledTransactionId - The id of the scheduled transaction (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 Scheduled Transaction -
      404 The scheduled transaction was not found -

    • getScheduledTransactionById

      public ScheduledTransactionResponse getScheduledTransactionById(@Nonnull String planId, @Nonnull String scheduledTransactionId) throws ApiException
      Get a scheduled transaction Returns a single scheduled transaction
      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)
      scheduledTransactionId - The id of the scheduled transaction (required)
      Returns:
      ScheduledTransactionResponse
      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 Scheduled Transaction -
      404 The scheduled transaction was not found -

    • getScheduledTransactionByIdWithHttpInfo

      public ApiResponse<ScheduledTransactionResponse> getScheduledTransactionByIdWithHttpInfo(@Nonnull String planId, @Nonnull String scheduledTransactionId) throws ApiException
      Get a scheduled transaction Returns a single scheduled transaction
      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)
      scheduledTransactionId - The id of the scheduled transaction (required)
      Returns:
      ApiResponse<ScheduledTransactionResponse>
      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 Scheduled Transaction -
      404 The scheduled transaction was not found -

    • getScheduledTransactionByIdAsync

      public okhttp3.Call getScheduledTransactionByIdAsync(@Nonnull String planId, @Nonnull String scheduledTransactionId, ApiCallback<ScheduledTransactionResponse> _callback) throws ApiException
      Get a scheduled transaction (asynchronously) Returns a single scheduled transaction
      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)
      scheduledTransactionId - The id of the scheduled transaction (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 Scheduled Transaction -
      404 The scheduled transaction was not found -

    • getScheduledTransactionsCall

      public okhttp3.Call getScheduledTransactionsCall(@Nonnull String planId, @Nullable Long lastKnowledgeOfServer, ApiCallback _callback) throws ApiException
      Build call for getScheduledTransactions
      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 requested scheduled transactions -
      404 No scheduled transactions were found -

    • getScheduledTransactions

      public ScheduledTransactionsResponse getScheduledTransactions(@Nonnull String planId, @Nullable Long lastKnowledgeOfServer) throws ApiException
      Get all scheduled transactions Returns all scheduled transactions
      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:
      ScheduledTransactionsResponse
      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 scheduled transactions -
      404 No scheduled transactions were found -

    • getScheduledTransactionsWithHttpInfo

      public ApiResponse<ScheduledTransactionsResponse> getScheduledTransactionsWithHttpInfo(@Nonnull String planId, @Nullable Long lastKnowledgeOfServer) throws ApiException
      Get all scheduled transactions Returns all scheduled transactions
      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<ScheduledTransactionsResponse>
      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 scheduled transactions -
      404 No scheduled transactions were found -

    • getScheduledTransactionsAsync

      public okhttp3.Call getScheduledTransactionsAsync(@Nonnull String planId, @Nullable Long lastKnowledgeOfServer, ApiCallback<ScheduledTransactionsResponse> _callback) throws ApiException
      Get all scheduled transactions (asynchronously) Returns all scheduled transactions
      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 requested scheduled transactions -
      404 No scheduled transactions were found -

    • updateScheduledTransactionCall

      public okhttp3.Call updateScheduledTransactionCall(@Nonnull String planId, @Nonnull String scheduledTransactionId, @Nonnull PutScheduledTransactionWrapper putScheduledTransactionWrapper, ApiCallback _callback) throws ApiException
      Build call for updateScheduledTransaction
      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)
      scheduledTransactionId - The id of the scheduled transaction (required)
      putScheduledTransactionWrapper - The scheduled transaction 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 scheduled transaction was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateScheduledTransaction

      public ScheduledTransactionResponse updateScheduledTransaction(@Nonnull String planId, @Nonnull String scheduledTransactionId, @Nonnull PutScheduledTransactionWrapper putScheduledTransactionWrapper) throws ApiException
      Update a scheduled transaction Updates a single scheduled transaction
      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)
      scheduledTransactionId - The id of the scheduled transaction (required)
      putScheduledTransactionWrapper - The scheduled transaction to update (required)
      Returns:
      ScheduledTransactionResponse
      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 scheduled transaction was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateScheduledTransactionWithHttpInfo

      public ApiResponse<ScheduledTransactionResponse> updateScheduledTransactionWithHttpInfo(@Nonnull String planId, @Nonnull String scheduledTransactionId, @Nonnull PutScheduledTransactionWrapper putScheduledTransactionWrapper) throws ApiException
      Update a scheduled transaction Updates a single scheduled transaction
      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)
      scheduledTransactionId - The id of the scheduled transaction (required)
      putScheduledTransactionWrapper - The scheduled transaction to update (required)
      Returns:
      ApiResponse<ScheduledTransactionResponse>
      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 scheduled transaction was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -

    • updateScheduledTransactionAsync

      public okhttp3.Call updateScheduledTransactionAsync(@Nonnull String planId, @Nonnull String scheduledTransactionId, @Nonnull PutScheduledTransactionWrapper putScheduledTransactionWrapper, ApiCallback<ScheduledTransactionResponse> _callback) throws ApiException
      Update a scheduled transaction (asynchronously) Updates a single scheduled transaction
      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)
      scheduledTransactionId - The id of the scheduled transaction (required)
      putScheduledTransactionWrapper - The scheduled transaction 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 scheduled transaction was successfully updated -
      400 The request could not be understood due to malformed syntax or validation error(s) -