ynab 2.2.0 → 2.4.0

package/dist/apis/TransactionsApi.js

@@ -5,15 +5,10 @@
  * YNAB API Endpoints
  * Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
  *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetTransactionsByPayeeTypeEnum = exports.GetTransactionsByCategoryTypeEnum = exports.GetTransactionsByAccountTypeEnum = exports.GetTransactionsTypeEnum = exports.TransactionsApi = void 0;
+exports.GetTransactionsByPayeeTypeEnum = exports.GetTransactionsByMonthTypeEnum = exports.GetTransactionsByCategoryTypeEnum = exports.GetTransactionsByAccountTypeEnum = exports.GetTransactionsTypeEnum = exports.TransactionsApi = void 0;
 const runtime = require("../runtime");
 const index_1 = require("../models/index");
 /**
@@ -21,7 +16,7 @@ const index_1 = require("../models/index");
  */
 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 cannot be created on this endpoint.
+     * 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
      */
     async createTransactionRaw(requestParameters, initOverrides) {
@@ -52,7 +47,7 @@ class TransactionsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SaveTransactionsResponseFromJSON)(jsonValue));
     }
     /**
-     * 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 cannot be created on this endpoint.
+     * 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
      */
     async createTransaction(budgetId, data, initOverrides) {
@@ -134,7 +129,7 @@ class TransactionsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Returns budget transactions
+     * Returns budget transactions, excluding any pending transactions
      * List transactions
      */
     async getTransactionsRaw(requestParameters, initOverrides) {
@@ -169,7 +164,7 @@ class TransactionsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TransactionsResponseFromJSON)(jsonValue));
     }
     /**
-     * Returns budget transactions
+     * Returns budget transactions, excluding any pending transactions
      * List transactions
      */
     async getTransactions(budgetId, sinceDate, type, lastKnowledgeOfServer, initOverrides) {
@@ -177,7 +172,7 @@ class TransactionsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Returns all transactions for a specified account
+     * Returns all transactions for a specified account, excluding any pending transactions
      * List account transactions
      */
     async getTransactionsByAccountRaw(requestParameters, initOverrides) {
@@ -215,7 +210,7 @@ class TransactionsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TransactionsResponseFromJSON)(jsonValue));
     }
     /**
-     * Returns all transactions for a specified account
+     * Returns all transactions for a specified account, excluding any pending transactions
      * List account transactions
      */
     async getTransactionsByAccount(budgetId, accountId, sinceDate, type, lastKnowledgeOfServer, initOverrides) {
@@ -224,7 +219,7 @@ class TransactionsApi extends runtime.BaseAPI {
     }
     /**
      * Returns all transactions for a specified category
-     * List category transactions
+     * List category transactions, excluding any pending transactions
      */
     async getTransactionsByCategoryRaw(requestParameters, initOverrides) {
         if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
@@ -262,15 +257,61 @@ class TransactionsApi extends runtime.BaseAPI {
     }
     /**
      * Returns all transactions for a specified category
-     * List category transactions
+     * List category transactions, excluding any pending transactions
      */
     async getTransactionsByCategory(budgetId, categoryId, sinceDate, type, lastKnowledgeOfServer, initOverrides) {
         const response = await this.getTransactionsByCategoryRaw({ budgetId: budgetId, categoryId: categoryId, sinceDate: sinceDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
         return await response.value();
     }
+    /**
+     * Returns all transactions for a specified month
+     * List transactions in month, excluding any pending transactions
+     */
+    async getTransactionsByMonthRaw(requestParameters, initOverrides) {
+        if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
+            throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling getTransactionsByMonth.');
+        }
+        if (requestParameters.month === null || requestParameters.month === undefined) {
+            throw new runtime.RequiredError('month', 'Required parameter requestParameters.month was null or undefined when calling getTransactionsByMonth.');
+        }
+        const queryParameters = {};
+        if (requestParameters.sinceDate !== undefined) {
+            queryParameters['since_date'] = requestParameters.sinceDate;
+        }
+        if (requestParameters.type !== undefined) {
+            queryParameters['type'] = requestParameters.type;
+        }
+        if (requestParameters.lastKnowledgeOfServer !== undefined) {
+            queryParameters['last_knowledge_of_server'] = requestParameters.lastKnowledgeOfServer;
+        }
+        const headerParameters = {};
+        headerParameters['Accept'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/budgets/{budget_id}/months/{month}/transactions`.replace(`{${"budget_id"}}`, encodeURIComponent(String(requestParameters.budgetId))).replace(`{${"month"}}`, encodeURIComponent(String(requestParameters.month))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.HybridTransactionsResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Returns all transactions for a specified month
+     * List transactions in month, excluding any pending transactions
+     */
+    async getTransactionsByMonth(budgetId, month, sinceDate, type, lastKnowledgeOfServer, initOverrides) {
+        const response = await this.getTransactionsByMonthRaw({ budgetId: budgetId, month: month, sinceDate: sinceDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
+        return await response.value();
+    }
     /**
      * Returns all transactions for a specified payee
-     * List payee transactions
+     * List payee transactions, excluding any pending transactions
      */
     async getTransactionsByPayeeRaw(requestParameters, initOverrides) {
         if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
@@ -308,7 +349,7 @@ class TransactionsApi extends runtime.BaseAPI {
     }
     /**
      * Returns all transactions for a specified payee
-     * List payee transactions
+     * List payee transactions, excluding any pending transactions
      */
     async getTransactionsByPayee(budgetId, payeeId, sinceDate, type, lastKnowledgeOfServer, initOverrides) {
         const response = await this.getTransactionsByPayeeRaw({ budgetId: budgetId, payeeId: payeeId, sinceDate: sinceDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
@@ -452,6 +493,13 @@ exports.GetTransactionsByCategoryTypeEnum = {
     Uncategorized: 'uncategorized',
     Unapproved: 'unapproved'
 };
+/**
+ * @export
+ */
+exports.GetTransactionsByMonthTypeEnum = {
+    Uncategorized: 'uncategorized',
+    Unapproved: 'unapproved'
+};
 /**
  * @export
  */

package/dist/apis/UserApi.d.ts

@@ -2,12 +2,7 @@
  * YNAB API Endpoints
  * Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
  *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
  */
 import * as runtime from '../runtime';
 import type { UserResponse } from '../models/index';

package/dist/apis/UserApi.js

@@ -5,12 +5,7 @@
  * YNAB API Endpoints
  * Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
  *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserApi = void 0;