ynab 2.0.0-rc.1 → 2.2.0

package/README.md

@@ -9,7 +9,7 @@ This client is generated using the [OpenAPI Generator](https://openapi-generator
 
 ## Installation
 
-First, install the module with npm (or yarn):
+First, install the module with npm:
 
 ```shell
 npm install ynab
@@ -118,7 +118,7 @@ folder for example usage scenarios.
 
 ## Methods
 
-The following methods are available in this library. For more details on parameters and usage, the [TypeScript declaration file](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) can be referenced.
+The following methods are available in this library.
 
 |                            | Method                                                                                                                                                         | Description                                           |
 |----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|

package/dist/apis/CategoriesApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CategoriesResponse, CategoryResponse, PatchMonthCategoryWrapper, SaveCategoryResponse } from '../models/index';
+import type { CategoriesResponse, CategoryResponse, PatchCategoryWrapper, PatchMonthCategoryWrapper, SaveCategoryResponse } from '../models/index';
 export interface GetCategoriesRequest {
     budgetId: string;
     lastKnowledgeOfServer?: number;
@@ -24,6 +24,11 @@ export interface GetMonthCategoryByIdRequest {
     month: string;
     categoryId: string;
 }
+export interface UpdateCategoryRequest {
+    budgetId: string;
+    categoryId: string;
+    data: PatchCategoryWrapper;
+}
 export interface UpdateMonthCategoryRequest {
     budgetId: string;
     month: string;
@@ -64,6 +69,16 @@ export declare class CategoriesApi extends runtime.BaseAPI {
      * Single category for a specific budget month
      */
     getMonthCategoryById(budgetId: string, month: string, categoryId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CategoryResponse>;
+    /**
+     * Update a category
+     * Update a category
+     */
+    updateCategoryRaw(requestParameters: UpdateCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SaveCategoryResponse>>;
+    /**
+     * Update a category
+     * Update a category
+     */
+    updateCategory(budgetId: string, categoryId: string, data: PatchCategoryWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SaveCategoryResponse>;
     /**
      * Update a category for a specific month.  Only `budgeted` amount can be updated.
      * Update a category for a specific month

package/dist/apis/CategoriesApi.js

@@ -134,6 +134,48 @@ class CategoriesApi extends runtime.BaseAPI {
         const response = await this.getMonthCategoryByIdRaw({ budgetId: budgetId, month: month, categoryId: categoryId }, initOverrides);
         return await response.value();
     }
+    /**
+     * Update a category
+     * Update a category
+     */
+    async updateCategoryRaw(requestParameters, initOverrides) {
+        if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
+            throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling updateCategory.');
+        }
+        if (requestParameters.categoryId === null || requestParameters.categoryId === undefined) {
+            throw new runtime.RequiredError('categoryId', 'Required parameter requestParameters.categoryId was null or undefined when calling updateCategory.');
+        }
+        if (requestParameters.data === null || requestParameters.data === undefined) {
+            throw new runtime.RequiredError('data', 'Required parameter requestParameters.data was null or undefined when calling updateCategory.');
+        }
+        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}/categories/{category_id}`.replace(`{${"budget_id"}}`, encodeURIComponent(String(requestParameters.budgetId))).replace(`{${"category_id"}}`, encodeURIComponent(String(requestParameters.categoryId))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.PatchCategoryWrapperToJSON)(requestParameters.data),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SaveCategoryResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Update a category
+     * Update a category
+     */
+    async updateCategory(budgetId, categoryId, data, initOverrides) {
+        const response = await this.updateCategoryRaw({ budgetId: budgetId, categoryId: categoryId, data: data }, initOverrides);
+        return await response.value();
+    }
     /**
      * Update a category for a specific month.  Only `budgeted` amount can be updated.
      * Update a category for a specific month

package/dist/apis/CustomTransactionsApi.d.ts

@@ -25,7 +25,7 @@ export declare class CustomTransactionsApi extends TransactionsApi {
      * @throws {RequiredError}
      * @memberof TransactionsApi
      */
-    getTransactionsByType(budgetId: string, type: "uncategorized" | "unapproved", lastKnowledgeOfServer?: number, options?: any): Promise<import("..").TransactionsResponse>;
+    getTransactionsByType(budgetId: string, type: "uncategorized" | "unapproved" | undefined, lastKnowledgeOfServer?: number, options?: any): Promise<import("..").TransactionsResponse>;
     /**
      * Creates multiple transactions. Provide a body containing a 'transactions' array, multiple transactions will be created.
      * @summary Create a single transaction or multiple transactions

package/dist/apis/TransactionsApi.d.ts

@@ -174,7 +174,7 @@ export declare const GetTransactionsTypeEnum: {
     readonly Uncategorized: "uncategorized";
     readonly Unapproved: "unapproved";
 };
-export declare type GetTransactionsTypeEnum = typeof GetTransactionsTypeEnum[keyof typeof GetTransactionsTypeEnum];
+export type GetTransactionsTypeEnum = typeof GetTransactionsTypeEnum[keyof typeof GetTransactionsTypeEnum];
 /**
  * @export
  */
@@ -182,7 +182,7 @@ export declare const GetTransactionsByAccountTypeEnum: {
     readonly Uncategorized: "uncategorized";
     readonly Unapproved: "unapproved";
 };
-export declare type GetTransactionsByAccountTypeEnum = typeof GetTransactionsByAccountTypeEnum[keyof typeof GetTransactionsByAccountTypeEnum];
+export type GetTransactionsByAccountTypeEnum = typeof GetTransactionsByAccountTypeEnum[keyof typeof GetTransactionsByAccountTypeEnum];
 /**
  * @export
  */
@@ -190,7 +190,7 @@ export declare const GetTransactionsByCategoryTypeEnum: {
     readonly Uncategorized: "uncategorized";
     readonly Unapproved: "unapproved";
 };
-export declare type GetTransactionsByCategoryTypeEnum = typeof GetTransactionsByCategoryTypeEnum[keyof typeof GetTransactionsByCategoryTypeEnum];
+export type GetTransactionsByCategoryTypeEnum = typeof GetTransactionsByCategoryTypeEnum[keyof typeof GetTransactionsByCategoryTypeEnum];
 /**
  * @export
  */
@@ -198,4 +198,4 @@ export declare const GetTransactionsByPayeeTypeEnum: {
     readonly Uncategorized: "uncategorized";
     readonly Unapproved: "unapproved";
 };
-export declare type GetTransactionsByPayeeTypeEnum = typeof GetTransactionsByPayeeTypeEnum[keyof typeof GetTransactionsByPayeeTypeEnum];
+export type GetTransactionsByPayeeTypeEnum = typeof GetTransactionsByPayeeTypeEnum[keyof typeof GetTransactionsByPayeeTypeEnum];

package/dist/apis/index.d.ts

@@ -1,7 +1,6 @@
 export * from './AccountsApi';
 export * from './BudgetsApi';
 export * from './CategoriesApi';
-export * from './DeprecatedApi';
 export * from './MonthsApi';
 export * from './PayeeLocationsApi';
 export * from './PayeesApi';

package/dist/apis/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -15,7 +19,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AccountsApi"), exports);
 __exportStar(require("./BudgetsApi"), exports);
 __exportStar(require("./CategoriesApi"), exports);
-__exportStar(require("./DeprecatedApi"), exports);
 __exportStar(require("./MonthsApi"), exports);
 __exportStar(require("./PayeeLocationsApi"), exports);
 __exportStar(require("./PayeesApi"), exports);