ynab 2.9.0 → 3.1.0

package/dist/esm/apis/AccountsApi.d.ts

@@ -7,15 +7,15 @@
 import * as runtime from '../runtime';
 import type { AccountResponse, AccountsResponse, PostAccountWrapper } from '../models/index';
 export interface CreateAccountRequest {
-    budgetId: string;
+    planId: string;
     data: PostAccountWrapper;
 }
 export interface GetAccountByIdRequest {
-    budgetId: string;
+    planId: string;
     accountId: string;
 }
 export interface GetAccountsRequest {
-    budgetId: string;
+    planId: string;
     lastKnowledgeOfServer?: number;
 }
 /**
@@ -24,32 +24,32 @@ export interface GetAccountsRequest {
 export declare class AccountsApi extends runtime.BaseAPI {
     /**
      * Creates a new account
-     * Create a new account
+     * Create an account
      */
     createAccountRaw(requestParameters: CreateAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountResponse>>;
     /**
      * Creates a new account
-     * Create a new account
+     * Create an account
      */
-    createAccount(budgetId: string, data: PostAccountWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountResponse>;
+    createAccount(planId: string, data: PostAccountWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountResponse>;
     /**
      * Returns a single account
-     * Single account
+     * Get an account
      */
     getAccountByIdRaw(requestParameters: GetAccountByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountResponse>>;
     /**
      * Returns a single account
-     * Single account
+     * Get an account
      */
-    getAccountById(budgetId: string, accountId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountResponse>;
+    getAccountById(planId: string, accountId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountResponse>;
     /**
      * Returns all accounts
-     * Account list
+     * Get all accounts
      */
     getAccountsRaw(requestParameters: GetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountsResponse>>;
     /**
      * Returns all accounts
-     * Account list
+     * Get all accounts
      */
-    getAccounts(budgetId: string, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountsResponse>;
+    getAccounts(planId: string, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountsResponse>;
 }

package/dist/esm/apis/AccountsApi.js

@@ -31,8 +31,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
@@ -69,7 +69,7 @@ var AccountsApi = /** @class */ (function (_super) {
     }
     /**
      * Creates a new account
-     * Create a new account
+     * Create an account
      */
     AccountsApi.prototype.createAccountRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -77,8 +77,8 @@ var AccountsApi = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
-                            throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling createAccount.');
+                        if (requestParameters.planId === null || requestParameters.planId === undefined) {
+                            throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling createAccount.');
                         }
                         if (requestParameters.data === null || requestParameters.data === undefined) {
                             throw new runtime.RequiredError('data', 'Required parameter requestParameters.data was null or undefined when calling createAccount.');
@@ -97,7 +97,7 @@ var AccountsApi = /** @class */ (function (_super) {
                         }
                         _a.label = 2;
                     case 2: return [4 /*yield*/, this.request({
-                            path: "/budgets/{budget_id}/accounts".replace("{".concat("budget_id", "}"), encodeURIComponent(String(requestParameters.budgetId))),
+                            path: "/budgets/{plan_id}/accounts".replace("{".concat("plan_id", "}"), encodeURIComponent(String(requestParameters.planId))),
                             method: 'POST',
                             headers: headerParameters,
                             query: queryParameters,
@@ -112,14 +112,14 @@ var AccountsApi = /** @class */ (function (_super) {
     };
     /**
      * Creates a new account
-     * Create a new account
+     * Create an account
      */
-    AccountsApi.prototype.createAccount = function (budgetId, data, initOverrides) {
+    AccountsApi.prototype.createAccount = function (planId, data, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.createAccountRaw({ budgetId: budgetId, data: data }, initOverrides)];
+                    case 0: return [4 /*yield*/, this.createAccountRaw({ planId: planId, data: data }, initOverrides)];
                     case 1:
                         response = _a.sent();
                         return [4 /*yield*/, response.value()];
@@ -130,7 +130,7 @@ var AccountsApi = /** @class */ (function (_super) {
     };
     /**
      * Returns a single account
-     * Single account
+     * Get an account
      */
     AccountsApi.prototype.getAccountByIdRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -138,8 +138,8 @@ var AccountsApi = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
-                            throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling getAccountById.');
+                        if (requestParameters.planId === null || requestParameters.planId === undefined) {
+                            throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling getAccountById.');
                         }
                         if (requestParameters.accountId === null || requestParameters.accountId === undefined) {
                             throw new runtime.RequiredError('accountId', 'Required parameter requestParameters.accountId was null or undefined when calling getAccountById.');
@@ -157,7 +157,7 @@ var AccountsApi = /** @class */ (function (_super) {
                         }
                         _a.label = 2;
                     case 2: return [4 /*yield*/, this.request({
-                            path: "/budgets/{budget_id}/accounts/{account_id}".replace("{".concat("budget_id", "}"), encodeURIComponent(String(requestParameters.budgetId))).replace("{".concat("account_id", "}"), encodeURIComponent(String(requestParameters.accountId))),
+                            path: "/budgets/{plan_id}/accounts/{account_id}".replace("{".concat("plan_id", "}"), encodeURIComponent(String(requestParameters.planId))).replace("{".concat("account_id", "}"), encodeURIComponent(String(requestParameters.accountId))),
                             method: 'GET',
                             headers: headerParameters,
                             query: queryParameters,
@@ -171,14 +171,14 @@ var AccountsApi = /** @class */ (function (_super) {
     };
     /**
      * Returns a single account
-     * Single account
+     * Get an account
      */
-    AccountsApi.prototype.getAccountById = function (budgetId, accountId, initOverrides) {
+    AccountsApi.prototype.getAccountById = function (planId, accountId, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getAccountByIdRaw({ budgetId: budgetId, accountId: accountId }, initOverrides)];
+                    case 0: return [4 /*yield*/, this.getAccountByIdRaw({ planId: planId, accountId: accountId }, initOverrides)];
                     case 1:
                         response = _a.sent();
                         return [4 /*yield*/, response.value()];
@@ -189,7 +189,7 @@ var AccountsApi = /** @class */ (function (_super) {
     };
     /**
      * Returns all accounts
-     * Account list
+     * Get all accounts
      */
     AccountsApi.prototype.getAccountsRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -197,8 +197,8 @@ var AccountsApi = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
-                            throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling getAccounts.');
+                        if (requestParameters.planId === null || requestParameters.planId === undefined) {
+                            throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling getAccounts.');
                         }
                         queryParameters = {};
                         if (requestParameters.lastKnowledgeOfServer !== undefined) {
@@ -216,7 +216,7 @@ var AccountsApi = /** @class */ (function (_super) {
                         }
                         _a.label = 2;
                     case 2: return [4 /*yield*/, this.request({
-                            path: "/budgets/{budget_id}/accounts".replace("{".concat("budget_id", "}"), encodeURIComponent(String(requestParameters.budgetId))),
+                            path: "/budgets/{plan_id}/accounts".replace("{".concat("plan_id", "}"), encodeURIComponent(String(requestParameters.planId))),
                             method: 'GET',
                             headers: headerParameters,
                             query: queryParameters,
@@ -230,14 +230,14 @@ var AccountsApi = /** @class */ (function (_super) {
     };
     /**
      * Returns all accounts
-     * Account list
+     * Get all accounts
      */
-    AccountsApi.prototype.getAccounts = function (budgetId, lastKnowledgeOfServer, initOverrides) {
+    AccountsApi.prototype.getAccounts = function (planId, lastKnowledgeOfServer, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getAccountsRaw({ budgetId: budgetId, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides)];
+                    case 0: return [4 /*yield*/, this.getAccountsRaw({ planId: planId, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides)];
                     case 1:
                         response = _a.sent();
                         return [4 /*yield*/, response.value()];

package/dist/esm/apis/CategoriesApi.d.ts

@@ -5,27 +5,40 @@
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)
  */
 import * as runtime from '../runtime';
-import type { CategoriesResponse, CategoryResponse, PatchCategoryWrapper, PatchMonthCategoryWrapper, SaveCategoryResponse } from '../models/index';
+import type { CategoriesResponse, CategoryResponse, PatchCategoryGroupWrapper, PatchCategoryWrapper, PatchMonthCategoryWrapper, PostCategoryGroupWrapper, PostCategoryWrapper, SaveCategoryGroupResponse, SaveCategoryResponse } from '../models/index';
+export interface CreateCategoryRequest {
+    planId: string;
+    data: PostCategoryWrapper;
+}
+export interface CreateCategoryGroupRequest {
+    planId: string;
+    data: PostCategoryGroupWrapper;
+}
 export interface GetCategoriesRequest {
-    budgetId: string;
+    planId: string;
     lastKnowledgeOfServer?: number;
 }
 export interface GetCategoryByIdRequest {
-    budgetId: string;
+    planId: string;
     categoryId: string;
 }
 export interface GetMonthCategoryByIdRequest {
-    budgetId: string;
+    planId: string;
     month: string;
     categoryId: string;
 }
 export interface UpdateCategoryRequest {
-    budgetId: string;
+    planId: string;
     categoryId: string;
     data: PatchCategoryWrapper;
 }
+export interface UpdateCategoryGroupRequest {
+    planId: string;
+    categoryGroupId: string;
+    data: PatchCategoryGroupWrapper;
+}
 export interface UpdateMonthCategoryRequest {
-    budgetId: string;
+    planId: string;
     month: string;
     categoryId: string;
     data: PatchMonthCategoryWrapper;
@@ -35,35 +48,55 @@ export interface UpdateMonthCategoryRequest {
  */
 export declare class CategoriesApi extends runtime.BaseAPI {
     /**
-     * Returns all categories grouped by category group.  Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
-     * List categories
+     * Creates a new category
+     * Create a category
+     */
+    createCategoryRaw(requestParameters: CreateCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SaveCategoryResponse>>;
+    /**
+     * Creates a new category
+     * Create a category
+     */
+    createCategory(planId: string, data: PostCategoryWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SaveCategoryResponse>;
+    /**
+     * Creates a new category group
+     * Create a category group
+     */
+    createCategoryGroupRaw(requestParameters: CreateCategoryGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SaveCategoryGroupResponse>>;
+    /**
+     * Creates a new category group
+     * Create a category group
+     */
+    createCategoryGroup(planId: string, data: PostCategoryGroupWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SaveCategoryGroupResponse>;
+    /**
+     * Returns all categories grouped by category group.  Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
+     * Get all categories
      */
     getCategoriesRaw(requestParameters: GetCategoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CategoriesResponse>>;
     /**
-     * Returns all categories grouped by category group.  Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
-     * List categories
+     * Returns all categories grouped by category group.  Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
+     * Get all categories
      */
-    getCategories(budgetId: string, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CategoriesResponse>;
+    getCategories(planId: string, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CategoriesResponse>;
     /**
-     * Returns a single category.  Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
-     * Single category
+     * Returns a single category.  Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
+     * Get a category
      */
     getCategoryByIdRaw(requestParameters: GetCategoryByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CategoryResponse>>;
     /**
-     * Returns a single category.  Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
-     * Single category
+     * Returns a single category.  Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
+     * Get a category
      */
-    getCategoryById(budgetId: string, categoryId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CategoryResponse>;
+    getCategoryById(planId: string, categoryId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CategoryResponse>;
     /**
-     * Returns a single category for a specific budget month.  Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
-     * Single category for a specific budget month
+     * Returns a single category for a specific plan month.  Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
+     * Get a category for a specific plan month
      */
     getMonthCategoryByIdRaw(requestParameters: GetMonthCategoryByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CategoryResponse>>;
     /**
-     * Returns a single category for a specific budget month.  Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
-     * Single category for a specific budget month
+     * Returns a single category for a specific plan month.  Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
+     * Get a category for a specific plan month
      */
-    getMonthCategoryById(budgetId: string, month: string, categoryId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CategoryResponse>;
+    getMonthCategoryById(planId: string, month: string, categoryId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CategoryResponse>;
     /**
      * Update a category
      * Update a category
@@ -73,15 +106,25 @@ export declare class CategoriesApi extends runtime.BaseAPI {
      * Update a category
      * Update a category
      */
-    updateCategory(budgetId: string, categoryId: string, data: PatchCategoryWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SaveCategoryResponse>;
+    updateCategory(planId: string, categoryId: string, data: PatchCategoryWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SaveCategoryResponse>;
+    /**
+     * Update a category group
+     * Update a category group
+     */
+    updateCategoryGroupRaw(requestParameters: UpdateCategoryGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SaveCategoryGroupResponse>>;
+    /**
+     * Update a category group
+     * Update a category group
+     */
+    updateCategoryGroup(planId: string, categoryGroupId: string, data: PatchCategoryGroupWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SaveCategoryGroupResponse>;
     /**
-     * Update a category for a specific month.  Only `budgeted` amount can be updated.
+     * Update a category for a specific month.  Only `budgeted` (assigned) amount can be updated.
      * Update a category for a specific month
      */
     updateMonthCategoryRaw(requestParameters: UpdateMonthCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SaveCategoryResponse>>;
     /**
-     * Update a category for a specific month.  Only `budgeted` amount can be updated.
+     * Update a category for a specific month.  Only `budgeted` (assigned) amount can be updated.
      * Update a category for a specific month
      */
-    updateMonthCategory(budgetId: string, month: string, categoryId: string, data: PatchMonthCategoryWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SaveCategoryResponse>;
+    updateMonthCategory(planId: string, month: string, categoryId: string, data: PatchMonthCategoryWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SaveCategoryResponse>;
 }