ynab 2.6.0 → 2.8.0

package/README.md

@@ -1,7 +1,7 @@
 # YNAB API JavaScript Library
 
-[![Continuous Integration](https://github.com/ynab/ynab-sdk-js/actions/workflows/ci.yml/badge.svg)](https://github.com/ynab/ynab-sdk-js/actions/workflows/ci.yml)
-[![npm version](https://badge.fury.io/js/ynab.svg)](https://badge.fury.io/js/ynab)
+[![Build](https://github.com/ynab/ynab-sdk-js/actions/workflows/build-test.yml/badge.svg)](https://github.com/ynab/ynab-sdk-js/actions/workflows/build-test.yml)
+[![npm version](https://badge.fury.io/js/ynab.svg?icon=si%3Anpm)](https://badge.fury.io/js/ynab)
 
 Please read the [YNAB API documentation](https://api.ynab.com) for an overview of using the API and a complete list of available resources.
 
@@ -131,6 +131,7 @@ The following methods are available in this library.
 | **Categories**             | [categories.getCategories(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/CategoriesApi.d.ts)                                              | Returns all categories grouped by category group.     |
 |                            | [categories.getCategoryById(budget_id, category_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/CategoriesApi.d.ts)                               | Returns a single category                             |
 |                            | [categories.getMonthCategoryById(budget_id, month, category_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/CategoriesApi.d.ts)                   | Returns a single category for a specific budget month |
+|                            | [categories.updateCategory(budget_id, category_id, category)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/CategoriesApi.d.ts)    | Update an existing category                     |
 |                            | [categories.updateMonthCategory(budget_id, month, category_id, month_category)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/CategoriesApi.d.ts)    | Update an existing month category                     |
 | **Payees**                 | [payees.getPayees(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/PayeesApi.d.ts)                                                          | Returns all payees                                    |
 |                            | [payees.getPayeeById(budget_id, payee_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/PayeesApi.d.ts)                                             | Returns single payee                                  |
@@ -154,6 +155,8 @@ The following methods are available in this library.
 | **Scheduled Transactions** | [scheduled_transactions.getScheduledTransactions(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/ScheduledTransactionsApi.d.ts)            | Returns all scheduled transactions                    |
 |                            | [scheduled_transactions.getScheduledTransactionById(budget_id, scheduled_transaction_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/ScheduledTransactionsApi.d.ts) | Returns a single scheduled transaction          |
 |                            | [scheduled_transactions.createScheduledTransaction(budget_id, data)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/ScheduledTransactionsApi.d.ts)    | Creates a single scheduled transaction          |
+|                            | [scheduled_transactions.updateScheduledTransaction(budget_id, data)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/ScheduledTransactionsApi.d.ts)    | Updates a single scheduled transaction          |
+|                            | [scheduled_transactions.deleteScheduledTransaction(budget_id, scheduled_transaction_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/ScheduledTransactionsApi.d.ts)    | Deletes a single scheduled transaction          |
 
 ### Utilities
 
@@ -172,6 +175,10 @@ utils.convertFromISODateString(isoDateString: string): Date;
 utils.convertMilliUnitsToCurrencyAmount(milliunits: number, currencyDecimalDigits: number): number;
 ```
 
+## Versioning
+
+The version of this client is defined in the `package.json` file and follows [semantic versioning](https://semver.org/).  The version of this client is maintained independently and does not align with the the version of YNAB API itself (which is defined in the [OpenAPI spec](https://api.ynab.com/papi/open_api_spec.yaml)).  To determine which spec version of the YNAB API was used when generating this client you can refer to the "description" field in the `package.json` file.
+
 ## License
 
 Copyright (c) 2022 You Need A Budget, LLC

package/dist/apis/ScheduledTransactionsApi.d.ts

@@ -5,11 +5,15 @@
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)
  */
 import * as runtime from '../runtime';
-import type { PostScheduledTransactionWrapper, ScheduledTransactionResponse, ScheduledTransactionsResponse } from '../models/index';
+import type { PostScheduledTransactionWrapper, PutScheduledTransactionWrapper, ScheduledTransactionResponse, ScheduledTransactionsResponse } from '../models/index';
 export interface CreateScheduledTransactionRequest {
     budgetId: string;
     data: PostScheduledTransactionWrapper;
 }
+export interface DeleteScheduledTransactionRequest {
+    budgetId: string;
+    scheduledTransactionId: string;
+}
 export interface GetScheduledTransactionByIdRequest {
     budgetId: string;
     scheduledTransactionId: string;
@@ -18,20 +22,35 @@ export interface GetScheduledTransactionsRequest {
     budgetId: string;
     lastKnowledgeOfServer?: number;
 }
+export interface UpdateScheduledTransactionRequest {
+    budgetId: string;
+    scheduledTransactionId: string;
+    putScheduledTransactionWrapper: PutScheduledTransactionWrapper;
+}
 /**
  *
  */
 export declare class ScheduledTransactionsApi extends runtime.BaseAPI {
     /**
-     * Creates a single scheduled transaction.
+     * Creates a single scheduled transaction (a transaction with a future date).
      * Create a single scheduled transaction
      */
     createScheduledTransactionRaw(requestParameters: CreateScheduledTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScheduledTransactionResponse>>;
     /**
-     * Creates a single scheduled transaction.
+     * Creates a single scheduled transaction (a transaction with a future date).
      * Create a single scheduled transaction
      */
     createScheduledTransaction(budgetId: string, data: PostScheduledTransactionWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScheduledTransactionResponse>;
+    /**
+     * Deletes a scheduled transaction
+     * Deletes an existing scheduled transaction
+     */
+    deleteScheduledTransactionRaw(requestParameters: DeleteScheduledTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScheduledTransactionResponse>>;
+    /**
+     * Deletes a scheduled transaction
+     * Deletes an existing scheduled transaction
+     */
+    deleteScheduledTransaction(budgetId: string, scheduledTransactionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScheduledTransactionResponse>;
     /**
      * Returns a single scheduled transaction
      * Single scheduled transaction
@@ -52,4 +71,14 @@ export declare class ScheduledTransactionsApi extends runtime.BaseAPI {
      * List scheduled transactions
      */
     getScheduledTransactions(budgetId: string, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScheduledTransactionsResponse>;
+    /**
+     * Updates a single scheduled transaction
+     * Updates an existing scheduled transaction
+     */
+    updateScheduledTransactionRaw(requestParameters: UpdateScheduledTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScheduledTransactionResponse>>;
+    /**
+     * Updates a single scheduled transaction
+     * Updates an existing scheduled transaction
+     */
+    updateScheduledTransaction(budgetId: string, scheduledTransactionId: string, putScheduledTransactionWrapper: PutScheduledTransactionWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScheduledTransactionResponse>;
 }

package/dist/apis/ScheduledTransactionsApi.js

@@ -39,7 +39,7 @@ const index_1 = require("../models/index");
  */
 class ScheduledTransactionsApi extends runtime.BaseAPI {
     /**
-     * Creates a single scheduled transaction.
+     * Creates a single scheduled transaction (a transaction with a future date).
      * Create a single scheduled transaction
      */
     async createScheduledTransactionRaw(requestParameters, initOverrides) {
@@ -70,13 +70,50 @@ class ScheduledTransactionsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScheduledTransactionResponseFromJSON)(jsonValue));
     }
     /**
-     * Creates a single scheduled transaction.
+     * Creates a single scheduled transaction (a transaction with a future date).
      * Create a single scheduled transaction
      */
     async createScheduledTransaction(budgetId, data, initOverrides) {
         const response = await this.createScheduledTransactionRaw({ budgetId: budgetId, data: data }, initOverrides);
         return await response.value();
     }
+    /**
+     * Deletes a scheduled transaction
+     * Deletes an existing scheduled transaction
+     */
+    async deleteScheduledTransactionRaw(requestParameters, initOverrides) {
+        if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
+            throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling deleteScheduledTransaction.');
+        }
+        if (requestParameters.scheduledTransactionId === null || requestParameters.scheduledTransactionId === undefined) {
+            throw new runtime.RequiredError('scheduledTransactionId', 'Required parameter requestParameters.scheduledTransactionId was null or undefined when calling deleteScheduledTransaction.');
+        }
+        const queryParameters = {};
+        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}/scheduled_transactions`.replace(`{${"budget_id"}}`, encodeURIComponent(String(requestParameters.budgetId))).replace(`{${"scheduled_transaction_id"}}`, encodeURIComponent(String(requestParameters.scheduledTransactionId))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScheduledTransactionResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Deletes a scheduled transaction
+     * Deletes an existing scheduled transaction
+     */
+    async deleteScheduledTransaction(budgetId, scheduledTransactionId, initOverrides) {
+        const response = await this.deleteScheduledTransactionRaw({ budgetId: budgetId, scheduledTransactionId: scheduledTransactionId }, initOverrides);
+        return await response.value();
+    }
     /**
      * Returns a single scheduled transaction
      * Single scheduled transaction
@@ -151,5 +188,47 @@ class ScheduledTransactionsApi extends runtime.BaseAPI {
         const response = await this.getScheduledTransactionsRaw({ budgetId: budgetId, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
         return await response.value();
     }
+    /**
+     * Updates a single scheduled transaction
+     * Updates an existing scheduled transaction
+     */
+    async updateScheduledTransactionRaw(requestParameters, initOverrides) {
+        if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
+            throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling updateScheduledTransaction.');
+        }
+        if (requestParameters.scheduledTransactionId === null || requestParameters.scheduledTransactionId === undefined) {
+            throw new runtime.RequiredError('scheduledTransactionId', 'Required parameter requestParameters.scheduledTransactionId was null or undefined when calling updateScheduledTransaction.');
+        }
+        if (requestParameters.putScheduledTransactionWrapper === null || requestParameters.putScheduledTransactionWrapper === undefined) {
+            throw new runtime.RequiredError('putScheduledTransactionWrapper', 'Required parameter requestParameters.putScheduledTransactionWrapper was null or undefined when calling updateScheduledTransaction.');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Accept'] = 'application/json';
+        headerParameters['Content-Type'] = '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}/scheduled_transactions`.replace(`{${"budget_id"}}`, encodeURIComponent(String(requestParameters.budgetId))).replace(`{${"scheduled_transaction_id"}}`, encodeURIComponent(String(requestParameters.scheduledTransactionId))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.PutScheduledTransactionWrapperToJSON)(requestParameters.putScheduledTransactionWrapper),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScheduledTransactionResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Updates a single scheduled transaction
+     * Updates an existing scheduled transaction
+     */
+    async updateScheduledTransaction(budgetId, scheduledTransactionId, putScheduledTransactionWrapper, initOverrides) {
+        const response = await this.updateScheduledTransactionRaw({ budgetId: budgetId, scheduledTransactionId: scheduledTransactionId, putScheduledTransactionWrapper: putScheduledTransactionWrapper }, initOverrides);
+        return await response.value();
+    }
 }
 exports.ScheduledTransactionsApi = ScheduledTransactionsApi;