ynab 2.10.0 → 3.1.0

package/dist/apis/TransactionsApi.d.ts

@@ -7,61 +7,61 @@
 import * as runtime from '../runtime';
 import type { HybridTransactionsResponse, PatchTransactionsWrapper, PostTransactionsWrapper, PutTransactionWrapper, SaveTransactionsResponse, TransactionResponse, TransactionsImportResponse, TransactionsResponse } from '../models/index';
 export interface CreateTransactionRequest {
-    budgetId: string;
+    planId: string;
     data: PostTransactionsWrapper;
 }
 export interface DeleteTransactionRequest {
-    budgetId: string;
+    planId: string;
     transactionId: string;
 }
 export interface GetTransactionByIdRequest {
-    budgetId: string;
+    planId: string;
     transactionId: string;
 }
 export interface GetTransactionsRequest {
-    budgetId: string;
+    planId: string;
     sinceDate?: string;
     type?: GetTransactionsTypeEnum;
     lastKnowledgeOfServer?: number;
 }
 export interface GetTransactionsByAccountRequest {
-    budgetId: string;
+    planId: string;
     accountId: string;
     sinceDate?: string;
     type?: GetTransactionsByAccountTypeEnum;
     lastKnowledgeOfServer?: number;
 }
 export interface GetTransactionsByCategoryRequest {
-    budgetId: string;
+    planId: string;
     categoryId: string;
     sinceDate?: string;
     type?: GetTransactionsByCategoryTypeEnum;
     lastKnowledgeOfServer?: number;
 }
 export interface GetTransactionsByMonthRequest {
-    budgetId: string;
+    planId: string;
     month: string;
     sinceDate?: string;
     type?: GetTransactionsByMonthTypeEnum;
     lastKnowledgeOfServer?: number;
 }
 export interface GetTransactionsByPayeeRequest {
-    budgetId: string;
+    planId: string;
     payeeId: string;
     sinceDate?: string;
     type?: GetTransactionsByPayeeTypeEnum;
     lastKnowledgeOfServer?: number;
 }
 export interface ImportTransactionsRequest {
-    budgetId: string;
+    planId: string;
 }
 export interface UpdateTransactionRequest {
-    budgetId: string;
+    planId: string;
     transactionId: string;
     data: PutTransactionWrapper;
 }
 export interface UpdateTransactionsRequest {
-    budgetId: string;
+    planId: string;
     data: PatchTransactionsWrapper;
 }
 /**
@@ -77,97 +77,97 @@ export declare class TransactionsApi extends runtime.BaseAPI {
      * Creates a single transaction or multiple transactions.  If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created.  Scheduled transactions (transactions with a future date) cannot be created on this endpoint.
      * Create a single transaction or multiple transactions
      */
-    createTransaction(budgetId: string, data: PostTransactionsWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SaveTransactionsResponse>;
+    createTransaction(planId: string, data: PostTransactionsWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SaveTransactionsResponse>;
     /**
      * Deletes a transaction
-     * Deletes an existing transaction
+     * Delete a transaction
      */
     deleteTransactionRaw(requestParameters: DeleteTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionResponse>>;
     /**
      * Deletes a transaction
-     * Deletes an existing transaction
+     * Delete a transaction
      */
-    deleteTransaction(budgetId: string, transactionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionResponse>;
+    deleteTransaction(planId: string, transactionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionResponse>;
     /**
      * Returns a single transaction
-     * Single transaction
+     * Get a transaction
      */
     getTransactionByIdRaw(requestParameters: GetTransactionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionResponse>>;
     /**
      * Returns a single transaction
-     * Single transaction
+     * Get a transaction
      */
-    getTransactionById(budgetId: string, transactionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionResponse>;
+    getTransactionById(planId: string, transactionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionResponse>;
     /**
-     * Returns budget transactions, excluding any pending transactions
-     * List transactions
+     * Returns plan transactions, excluding any pending transactions
+     * Get all transactions
      */
     getTransactionsRaw(requestParameters: GetTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionsResponse>>;
     /**
-     * Returns budget transactions, excluding any pending transactions
-     * List transactions
+     * Returns plan transactions, excluding any pending transactions
+     * Get all transactions
      */
-    getTransactions(budgetId: string, sinceDate?: string, type?: GetTransactionsTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
+    getTransactions(planId: string, sinceDate?: string, type?: GetTransactionsTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
     /**
      * Returns all transactions for a specified account, excluding any pending transactions
-     * List account transactions
+     * Get all account transactions
      */
     getTransactionsByAccountRaw(requestParameters: GetTransactionsByAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionsResponse>>;
     /**
      * Returns all transactions for a specified account, excluding any pending transactions
-     * List account transactions
+     * Get all account transactions
      */
-    getTransactionsByAccount(budgetId: string, accountId: string, sinceDate?: string, type?: GetTransactionsByAccountTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
+    getTransactionsByAccount(planId: string, accountId: string, sinceDate?: string, type?: GetTransactionsByAccountTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
     /**
-     * Returns all transactions for a specified category
-     * List category transactions, excluding any pending transactions
+     * Returns all transactions for a specified category, excluding any pending transactions
+     * Get all category transactions
      */
     getTransactionsByCategoryRaw(requestParameters: GetTransactionsByCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HybridTransactionsResponse>>;
     /**
-     * Returns all transactions for a specified category
-     * List category transactions, excluding any pending transactions
+     * Returns all transactions for a specified category, excluding any pending transactions
+     * Get all category transactions
      */
-    getTransactionsByCategory(budgetId: string, categoryId: string, sinceDate?: string, type?: GetTransactionsByCategoryTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
+    getTransactionsByCategory(planId: string, categoryId: string, sinceDate?: string, type?: GetTransactionsByCategoryTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
     /**
-     * Returns all transactions for a specified month
-     * List transactions in month, excluding any pending transactions
+     * Returns all transactions for a specified month, excluding any pending transactions
+     * Get all plan month transactions
      */
-    getTransactionsByMonthRaw(requestParameters: GetTransactionsByMonthRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HybridTransactionsResponse>>;
+    getTransactionsByMonthRaw(requestParameters: GetTransactionsByMonthRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionsResponse>>;
     /**
-     * Returns all transactions for a specified month
-     * List transactions in month, excluding any pending transactions
+     * Returns all transactions for a specified month, excluding any pending transactions
+     * Get all plan month transactions
      */
-    getTransactionsByMonth(budgetId: string, month: string, sinceDate?: string, type?: GetTransactionsByMonthTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
+    getTransactionsByMonth(planId: string, month: string, sinceDate?: string, type?: GetTransactionsByMonthTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
     /**
-     * Returns all transactions for a specified payee
-     * List payee transactions, excluding any pending transactions
+     * Returns all transactions for a specified payee, excluding any pending transactions
+     * Get all payee transactions
      */
     getTransactionsByPayeeRaw(requestParameters: GetTransactionsByPayeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HybridTransactionsResponse>>;
     /**
-     * Returns all transactions for a specified payee
-     * List payee transactions, excluding any pending transactions
+     * Returns all transactions for a specified payee, excluding any pending transactions
+     * Get all payee transactions
      */
-    getTransactionsByPayee(budgetId: string, payeeId: string, sinceDate?: string, type?: GetTransactionsByPayeeTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
+    getTransactionsByPayee(planId: string, payeeId: string, sinceDate?: string, type?: GetTransactionsByPayeeTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
     /**
-     * Imports available transactions on all linked accounts for the given budget.  Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import.  Sending a request to this endpoint is the equivalent of clicking \"Import\" on each account in the web application or tapping the \"New Transactions\" banner in the mobile applications.  The response for this endpoint contains the transaction ids that have been imported.
+     * Imports available transactions on all linked accounts for the given plan.  Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import.  Sending a request to this endpoint is the equivalent of clicking \"Import\" on each account in the web application or tapping the \"New Transactions\" banner in the mobile applications.  The response for this endpoint contains the transaction ids that have been imported.
      * Import transactions
      */
     importTransactionsRaw(requestParameters: ImportTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionsImportResponse>>;
     /**
-     * Imports available transactions on all linked accounts for the given budget.  Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import.  Sending a request to this endpoint is the equivalent of clicking \"Import\" on each account in the web application or tapping the \"New Transactions\" banner in the mobile applications.  The response for this endpoint contains the transaction ids that have been imported.
+     * Imports available transactions on all linked accounts for the given plan.  Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import.  Sending a request to this endpoint is the equivalent of clicking \"Import\" on each account in the web application or tapping the \"New Transactions\" banner in the mobile applications.  The response for this endpoint contains the transaction ids that have been imported.
      * Import transactions
      */
-    importTransactions(budgetId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsImportResponse>;
+    importTransactions(planId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsImportResponse>;
     /**
      * Updates a single transaction
-     * Updates an existing transaction
+     * Update a transaction
      */
     updateTransactionRaw(requestParameters: UpdateTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionResponse>>;
     /**
      * Updates a single transaction
-     * Updates an existing transaction
+     * Update a transaction
      */
-    updateTransaction(budgetId: string, transactionId: string, data: PutTransactionWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionResponse>;
+    updateTransaction(planId: string, transactionId: string, data: PutTransactionWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionResponse>;
     /**
      * Updates multiple transactions, by `id` or `import_id`.
      * Update multiple transactions
@@ -177,7 +177,7 @@ export declare class TransactionsApi extends runtime.BaseAPI {
      * Updates multiple transactions, by `id` or `import_id`.
      * Update multiple transactions
      */
-    updateTransactions(budgetId: string, data: PatchTransactionsWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SaveTransactionsResponse>;
+    updateTransactions(planId: string, data: PatchTransactionsWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SaveTransactionsResponse>;
 }
 /**
  * @export