ynab 4.1.0 → 4.5.0

package/README.md

@@ -139,6 +139,7 @@ The following methods are available in this library.
 |                            | [categories.updateCategoryGroup(plan_id, category_group_id, data)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/CategoriesApi.d.ts)               | Update a category group                               |
 | **Payees**                 | [payees.getPayees(plan_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/PayeesApi.d.ts)                                                          | Returns all payees                                    |
 |                            | [payees.getPayeeById(plan_id, payee_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/PayeesApi.d.ts)                                             | Returns a single payee                                |
+|                            | [payees.createPayee(plan_id, data)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/PayeesApi.d.ts)                                                  | Creates a new payee                                   |
 |                            | [payees.updatePayee(plan_id, payee_id, data)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/PayeesApi.d.ts)                                        | Update a payee                                        |
 | **Payee Locations**        | [payee_locations.getPayeeLocations(plan_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/PayeeLocationsApi.d.ts)                                 | Returns all payee locations                           |
 |                            | [payee_locations.getPayeeLocationById(plan_id, payee_location_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/PayeeLocationsApi.d.ts)           | Returns a single payee location                       |

package/dist/apis/CustomTransactionsApi.js

@@ -30,7 +30,7 @@ class CustomTransactionsApi extends TransactionsApi_1.TransactionsApi {
      * @memberof TransactionsApi
      */
     getTransactionsByType(budgetId, type, lastKnowledgeOfServer, options) {
-        return this.getTransactions(budgetId, undefined, type, lastKnowledgeOfServer, options);
+        return this.getTransactions(budgetId, undefined, undefined, type, lastKnowledgeOfServer, options);
     }
     /**
      * Creates multiple transactions. Provide a body containing a 'transactions' array, multiple transactions will be created.

package/dist/apis/TransactionsApi.d.ts

@@ -21,6 +21,7 @@ export interface GetTransactionByIdRequest {
 export interface GetTransactionsRequest {
     planId: string;
     sinceDate?: string;
+    untilDate?: string;
     type?: GetTransactionsTypeEnum;
     lastKnowledgeOfServer?: number;
 }
@@ -28,6 +29,7 @@ export interface GetTransactionsByAccountRequest {
     planId: string;
     accountId: string;
     sinceDate?: string;
+    untilDate?: string;
     type?: GetTransactionsByAccountTypeEnum;
     lastKnowledgeOfServer?: number;
 }
@@ -35,6 +37,7 @@ export interface GetTransactionsByCategoryRequest {
     planId: string;
     categoryId: string;
     sinceDate?: string;
+    untilDate?: string;
     type?: GetTransactionsByCategoryTypeEnum;
     lastKnowledgeOfServer?: number;
 }
@@ -42,6 +45,7 @@ export interface GetTransactionsByMonthRequest {
     planId: string;
     month: string;
     sinceDate?: string;
+    untilDate?: string;
     type?: GetTransactionsByMonthTypeEnum;
     lastKnowledgeOfServer?: number;
 }
@@ -49,6 +53,7 @@ export interface GetTransactionsByPayeeRequest {
     planId: string;
     payeeId: string;
     sinceDate?: string;
+    untilDate?: string;
     type?: GetTransactionsByPayeeTypeEnum;
     lastKnowledgeOfServer?: number;
 }
@@ -100,54 +105,54 @@ export declare class TransactionsApi extends runtime.BaseAPI {
     getTransactionById(planId: string, transactionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionResponse>;
     /**
      * Returns plan transactions, excluding any pending transactions
-     * Get all transactions
+     * Get transactions
      */
     getTransactionsRaw(requestParameters: GetTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionsResponse>>;
     /**
      * Returns plan transactions, excluding any pending transactions
-     * Get all transactions
+     * Get transactions
      */
-    getTransactions(planId: string, sinceDate?: string, type?: GetTransactionsTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
+    getTransactions(planId: string, sinceDate?: string, untilDate?: string, type?: GetTransactionsTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
     /**
      * Returns all transactions for a specified account, excluding any pending transactions
-     * Get all account transactions
+     * Get account transactions
      */
     getTransactionsByAccountRaw(requestParameters: GetTransactionsByAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionsResponse>>;
     /**
      * Returns all transactions for a specified account, excluding any pending transactions
-     * Get all account transactions
+     * Get account transactions
      */
-    getTransactionsByAccount(planId: string, accountId: string, sinceDate?: string, type?: GetTransactionsByAccountTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
+    getTransactionsByAccount(planId: string, accountId: string, sinceDate?: string, untilDate?: string, type?: GetTransactionsByAccountTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
     /**
      * Returns all transactions for a specified category, excluding any pending transactions
-     * Get all category transactions
+     * Get category transactions
      */
     getTransactionsByCategoryRaw(requestParameters: GetTransactionsByCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HybridTransactionsResponse>>;
     /**
      * Returns all transactions for a specified category, excluding any pending transactions
-     * Get all category transactions
+     * Get category transactions
      */
-    getTransactionsByCategory(planId: string, categoryId: string, sinceDate?: string, type?: GetTransactionsByCategoryTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
+    getTransactionsByCategory(planId: string, categoryId: string, sinceDate?: string, untilDate?: string, type?: GetTransactionsByCategoryTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
     /**
      * Returns all transactions for a specified month, excluding any pending transactions
-     * Get all plan month transactions
+     * Get plan month transactions
      */
     getTransactionsByMonthRaw(requestParameters: GetTransactionsByMonthRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionsResponse>>;
     /**
      * Returns all transactions for a specified month, excluding any pending transactions
-     * Get all plan month transactions
+     * Get plan month transactions
      */
-    getTransactionsByMonth(planId: string, month: string, sinceDate?: string, type?: GetTransactionsByMonthTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
+    getTransactionsByMonth(planId: string, month: string, sinceDate?: string, untilDate?: string, type?: GetTransactionsByMonthTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
     /**
      * Returns all transactions for a specified payee, excluding any pending transactions
-     * Get all payee transactions
+     * Get payee transactions
      */
     getTransactionsByPayeeRaw(requestParameters: GetTransactionsByPayeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HybridTransactionsResponse>>;
     /**
      * Returns all transactions for a specified payee, excluding any pending transactions
-     * Get all payee transactions
+     * Get payee transactions
      */
-    getTransactionsByPayee(planId: string, payeeId: string, sinceDate?: string, type?: GetTransactionsByPayeeTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
+    getTransactionsByPayee(planId: string, payeeId: string, sinceDate?: string, untilDate?: string, type?: GetTransactionsByPayeeTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
     /**
      * 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

package/dist/apis/TransactionsApi.js

@@ -163,7 +163,7 @@ class TransactionsApi extends runtime.BaseAPI {
     }
     /**
      * Returns plan transactions, excluding any pending transactions
-     * Get all transactions
+     * Get transactions
      */
     async getTransactionsRaw(requestParameters, initOverrides) {
         if (requestParameters.planId === null || requestParameters.planId === undefined) {
@@ -173,6 +173,9 @@ class TransactionsApi extends runtime.BaseAPI {
         if (requestParameters.sinceDate !== undefined) {
             queryParameters['since_date'] = requestParameters.sinceDate;
         }
+        if (requestParameters.untilDate !== undefined) {
+            queryParameters['until_date'] = requestParameters.untilDate;
+        }
         if (requestParameters.type !== undefined) {
             queryParameters['type'] = requestParameters.type;
         }
@@ -198,15 +201,15 @@ class TransactionsApi extends runtime.BaseAPI {
     }
     /**
      * Returns plan transactions, excluding any pending transactions
-     * Get all transactions
+     * Get transactions
      */
-    async getTransactions(planId, sinceDate, type, lastKnowledgeOfServer, initOverrides) {
-        const response = await this.getTransactionsRaw({ planId: planId, sinceDate: sinceDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
+    async getTransactions(planId, sinceDate, untilDate, type, lastKnowledgeOfServer, initOverrides) {
+        const response = await this.getTransactionsRaw({ planId: planId, sinceDate: sinceDate, untilDate: untilDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
         return await response.value();
     }
     /**
      * Returns all transactions for a specified account, excluding any pending transactions
-     * Get all account transactions
+     * Get account transactions
      */
     async getTransactionsByAccountRaw(requestParameters, initOverrides) {
         if (requestParameters.planId === null || requestParameters.planId === undefined) {
@@ -219,6 +222,9 @@ class TransactionsApi extends runtime.BaseAPI {
         if (requestParameters.sinceDate !== undefined) {
             queryParameters['since_date'] = requestParameters.sinceDate;
         }
+        if (requestParameters.untilDate !== undefined) {
+            queryParameters['until_date'] = requestParameters.untilDate;
+        }
         if (requestParameters.type !== undefined) {
             queryParameters['type'] = requestParameters.type;
         }
@@ -244,15 +250,15 @@ class TransactionsApi extends runtime.BaseAPI {
     }
     /**
      * Returns all transactions for a specified account, excluding any pending transactions
-     * Get all account transactions
+     * Get account transactions
      */
-    async getTransactionsByAccount(planId, accountId, sinceDate, type, lastKnowledgeOfServer, initOverrides) {
-        const response = await this.getTransactionsByAccountRaw({ planId: planId, accountId: accountId, sinceDate: sinceDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
+    async getTransactionsByAccount(planId, accountId, sinceDate, untilDate, type, lastKnowledgeOfServer, initOverrides) {
+        const response = await this.getTransactionsByAccountRaw({ planId: planId, accountId: accountId, sinceDate: sinceDate, untilDate: untilDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
         return await response.value();
     }
     /**
      * Returns all transactions for a specified category, excluding any pending transactions
-     * Get all category transactions
+     * Get category transactions
      */
     async getTransactionsByCategoryRaw(requestParameters, initOverrides) {
         if (requestParameters.planId === null || requestParameters.planId === undefined) {
@@ -265,6 +271,9 @@ class TransactionsApi extends runtime.BaseAPI {
         if (requestParameters.sinceDate !== undefined) {
             queryParameters['since_date'] = requestParameters.sinceDate;
         }
+        if (requestParameters.untilDate !== undefined) {
+            queryParameters['until_date'] = requestParameters.untilDate;
+        }
         if (requestParameters.type !== undefined) {
             queryParameters['type'] = requestParameters.type;
         }
@@ -290,15 +299,15 @@ class TransactionsApi extends runtime.BaseAPI {
     }
     /**
      * Returns all transactions for a specified category, excluding any pending transactions
-     * Get all category transactions
+     * Get category transactions
      */
-    async getTransactionsByCategory(planId, categoryId, sinceDate, type, lastKnowledgeOfServer, initOverrides) {
-        const response = await this.getTransactionsByCategoryRaw({ planId: planId, categoryId: categoryId, sinceDate: sinceDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
+    async getTransactionsByCategory(planId, categoryId, sinceDate, untilDate, type, lastKnowledgeOfServer, initOverrides) {
+        const response = await this.getTransactionsByCategoryRaw({ planId: planId, categoryId: categoryId, sinceDate: sinceDate, untilDate: untilDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
         return await response.value();
     }
     /**
      * Returns all transactions for a specified month, excluding any pending transactions
-     * Get all plan month transactions
+     * Get plan month transactions
      */
     async getTransactionsByMonthRaw(requestParameters, initOverrides) {
         if (requestParameters.planId === null || requestParameters.planId === undefined) {
@@ -311,6 +320,9 @@ class TransactionsApi extends runtime.BaseAPI {
         if (requestParameters.sinceDate !== undefined) {
             queryParameters['since_date'] = requestParameters.sinceDate;
         }
+        if (requestParameters.untilDate !== undefined) {
+            queryParameters['until_date'] = requestParameters.untilDate;
+        }
         if (requestParameters.type !== undefined) {
             queryParameters['type'] = requestParameters.type;
         }
@@ -336,15 +348,15 @@ class TransactionsApi extends runtime.BaseAPI {
     }
     /**
      * Returns all transactions for a specified month, excluding any pending transactions
-     * Get all plan month transactions
+     * Get plan month transactions
      */
-    async getTransactionsByMonth(planId, month, sinceDate, type, lastKnowledgeOfServer, initOverrides) {
-        const response = await this.getTransactionsByMonthRaw({ planId: planId, month: month, sinceDate: sinceDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
+    async getTransactionsByMonth(planId, month, sinceDate, untilDate, type, lastKnowledgeOfServer, initOverrides) {
+        const response = await this.getTransactionsByMonthRaw({ planId: planId, month: month, sinceDate: sinceDate, untilDate: untilDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
         return await response.value();
     }
     /**
      * Returns all transactions for a specified payee, excluding any pending transactions
-     * Get all payee transactions
+     * Get payee transactions
      */
     async getTransactionsByPayeeRaw(requestParameters, initOverrides) {
         if (requestParameters.planId === null || requestParameters.planId === undefined) {
@@ -357,6 +369,9 @@ class TransactionsApi extends runtime.BaseAPI {
         if (requestParameters.sinceDate !== undefined) {
             queryParameters['since_date'] = requestParameters.sinceDate;
         }
+        if (requestParameters.untilDate !== undefined) {
+            queryParameters['until_date'] = requestParameters.untilDate;
+        }
         if (requestParameters.type !== undefined) {
             queryParameters['type'] = requestParameters.type;
         }
@@ -382,10 +397,10 @@ class TransactionsApi extends runtime.BaseAPI {
     }
     /**
      * Returns all transactions for a specified payee, excluding any pending transactions
-     * Get all payee transactions
+     * Get payee transactions
      */
-    async getTransactionsByPayee(planId, payeeId, sinceDate, type, lastKnowledgeOfServer, initOverrides) {
-        const response = await this.getTransactionsByPayeeRaw({ planId: planId, payeeId: payeeId, sinceDate: sinceDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
+    async getTransactionsByPayee(planId, payeeId, sinceDate, untilDate, type, lastKnowledgeOfServer, initOverrides) {
+        const response = await this.getTransactionsByPayeeRaw({ planId: planId, payeeId: payeeId, sinceDate: sinceDate, untilDate: untilDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
         return await response.value();
     }
     /**