ynab 2.10.0 → 3.1.0

package/dist/esm/index.js

@@ -35,15 +35,15 @@ var api = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
-    Object.defineProperty(api.prototype, "budgets", {
+    Object.defineProperty(api.prototype, "plans", {
         /**
-         * /budgets endpoints interface
+         * /plans endpoints interface
          */
         get: function () {
-            if (!this._budgets) {
-                this._budgets = new apis.BudgetsApi(this._configuration);
+            if (!this._plans) {
+                this._plans = new apis.PlansApi(this._configuration);
             }
-            return this._budgets;
+            return this._plans;
         },
         enumerable: false,
         configurable: true

package/dist/esm/models/Account.d.ts

@@ -30,7 +30,7 @@ export interface Account {
      */
     type: AccountType;
     /**
-     * Whether this account is on budget or not
+     * Whether this account is "on budget" or not
      * @type {boolean}
      * @memberof Account
      */
@@ -48,7 +48,7 @@ export interface Account {
      */
     note?: string | null;
     /**
-     * The current balance of the account in milliunits format
+     * The current available balance of the account in milliunits format
      * @type {number}
      * @memberof Account
      */
@@ -90,7 +90,7 @@ export interface Account {
      */
     last_reconciled_at?: string | null;
     /**
-     * The original debt/loan account balance, specified in milliunits format.
+     * This field is deprecated and will always be null.
      * @type {number}
      * @memberof Account
      */
@@ -102,7 +102,7 @@ export interface Account {
      */
     debt_interest_rates?: {
         [key: string]: number;
-    } | null;
+    };
     /**
      *
      * @type {{ [key: string]: number; }}
@@ -110,7 +110,7 @@ export interface Account {
      */
     debt_minimum_payments?: {
         [key: string]: number;
-    } | null;
+    };
     /**
      *
      * @type {{ [key: string]: number; }}
@@ -118,7 +118,7 @@ export interface Account {
      */
     debt_escrow_amounts?: {
         [key: string]: number;
-    } | null;
+    };
     /**
      * Whether or not the account has been deleted.  Deleted accounts will only be included in delta requests.
      * @type {boolean}

package/dist/esm/models/Category.d.ts

@@ -53,7 +53,7 @@ export interface Category {
      */
     note?: string | null;
     /**
-     * Budgeted amount in milliunits format
+     * Assigned (budgeted) amount in milliunits format
      * @type {number}
      * @memberof Category
      */
@@ -65,14 +65,14 @@ export interface Category {
      */
     activity: number;
     /**
-     * Balance in milliunits format
+     * Available balance in milliunits format
      * @type {number}
      * @memberof Category
      */
     balance: number;
     /**
      * The type of goal, if the category has a goal (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')
-     * @type {string}
+     * @type {CategoryGoalTypeEnum}
      * @memberof Category
      */
     goal_type?: CategoryGoalTypeEnum | null;
@@ -113,11 +113,17 @@ export interface Category {
      */
     goal_target?: number | null;
     /**
-     * The original target month for the goal to be completed.  Only some goal types specify this date.
+     * DEPRECATED: No longer used.  Use `goal_target_date` instead.
      * @type {string}
      * @memberof Category
      */
     goal_target_month?: string | null;
+    /**
+     * The target date for the goal to be completed.  Only some goal types specify this date.
+     * @type {string}
+     * @memberof Category
+     */
+    goal_target_date?: string | null;
     /**
      * The percentage completion of the goal
      * @type {number}

package/dist/esm/models/Category.js

@@ -64,6 +64,7 @@ export function CategoryFromJSONTyped(json, ignoreDiscriminator) {
         'goal_creation_month': json['goal_creation_month'] == null ? undefined : json['goal_creation_month'],
         'goal_target': json['goal_target'] == null ? undefined : json['goal_target'],
         'goal_target_month': json['goal_target_month'] == null ? undefined : json['goal_target_month'],
+        'goal_target_date': json['goal_target_date'] == null ? undefined : json['goal_target_date'],
         'goal_percentage_complete': json['goal_percentage_complete'] == null ? undefined : json['goal_percentage_complete'],
         'goal_months_to_budget': json['goal_months_to_budget'] == null ? undefined : json['goal_months_to_budget'],
         'goal_under_funded': json['goal_under_funded'] == null ? undefined : json['goal_under_funded'],
@@ -100,6 +101,7 @@ export function CategoryToJSONTyped(value, ignoreDiscriminator) {
         'goal_creation_month': value['goal_creation_month'],
         'goal_target': value['goal_target'],
         'goal_target_month': value['goal_target_month'],
+        'goal_target_date': value['goal_target_date'],
         'goal_percentage_complete': value['goal_percentage_complete'],
         'goal_months_to_budget': value['goal_months_to_budget'],
         'goal_under_funded': value['goal_under_funded'],

package/dist/esm/models/CategoryGroupWithCategories.d.ts

@@ -36,7 +36,7 @@ export interface CategoryGroupWithCategories {
      */
     deleted: boolean;
     /**
-     * Category group categories.  Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).
+     * Category group categories.  Amounts (assigned, activity, available, etc.) are specific to the current plan month (UTC).
      * @type {Array<Category>}
      * @memberof CategoryGroupWithCategories
      */

package/dist/esm/models/CurrencyFormat.d.ts

@@ -5,7 +5,7 @@
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)
  */
 /**
- * The currency format setting for the budget.  In some cases the format will not be available and will be specified as null.
+ * The currency format setting for the plan.  In some cases the format will not be available and will be specified as null.
  * @export
  * @interface CurrencyFormat
  */

package/dist/esm/models/DateFormat.d.ts

@@ -5,7 +5,7 @@
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)
  */
 /**
- * The date format setting for the budget.  In some cases the format will not be available and will be specified as null.
+ * The date format setting for the plan.  In some cases the format will not be available and will be specified as null.
  * @export
  * @interface DateFormat
  */

package/dist/esm/models/ExistingCategory.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+/**
+ *
+ * @export
+ * @interface ExistingCategory
+ */
+export interface ExistingCategory {
+    /**
+     *
+     * @type {string}
+     * @memberof ExistingCategory
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ExistingCategory
+     */
+    note?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ExistingCategory
+     */
+    category_group_id?: string;
+    /**
+     * The goal target amount in milliunits format.  If value is specified and goal has not already been configured for category, a monthly 'Needed for Spending' goal will be created for the category with this target amount.
+     * @type {number}
+     * @memberof ExistingCategory
+     */
+    goal_target?: number;
+    /**
+     * The goal target date in ISO format (e.g. 2016-12-01).
+     * @type {string}
+     * @memberof ExistingCategory
+     */
+    goal_target_date?: string;
+}
+/**
+ * Check if a given object implements the ExistingCategory interface.
+ */
+export declare function instanceOfExistingCategory(value: object): value is ExistingCategory;
+export declare function ExistingCategoryFromJSON(json: any): ExistingCategory;
+export declare function ExistingCategoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExistingCategory;
+export declare function ExistingCategoryToJSON(json: any): ExistingCategory;
+export declare function ExistingCategoryToJSONTyped(value?: ExistingCategory | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ExistingCategory.js

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+/**
+ * Check if a given object implements the ExistingCategory interface.
+ */
+export function instanceOfExistingCategory(value) {
+    return true;
+}
+export function ExistingCategoryFromJSON(json) {
+    return ExistingCategoryFromJSONTyped(json, false);
+}
+export function ExistingCategoryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+        'note': json['note'] == null ? undefined : json['note'],
+        'category_group_id': json['category_group_id'] == null ? undefined : json['category_group_id'],
+        'goal_target': json['goal_target'] == null ? undefined : json['goal_target'],
+        'goal_target_date': json['goal_target_date'] == null ? undefined : json['goal_target_date'],
+    };
+}
+export function ExistingCategoryToJSON(json) {
+    return ExistingCategoryToJSONTyped(json, false);
+}
+export function ExistingCategoryToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'note': value['note'],
+        'category_group_id': value['category_group_id'],
+        'goal_target': value['goal_target'],
+        'goal_target_date': value['goal_target_date'],
+    };
+}

package/dist/esm/models/ExistingTransaction.d.ts

@@ -36,25 +36,25 @@ export interface ExistingTransaction {
      * @type {string}
      * @memberof ExistingTransaction
      */
-    payee_id?: string | null;
+    payee_id?: string;
     /**
      * The payee name.  If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee.
      * @type {string}
      * @memberof ExistingTransaction
      */
-    payee_name?: string | null;
+    payee_name?: string;
     /**
      * The category for the transaction.  To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object.  If an existing transaction is a split, the `category_id` cannot be changed.  Credit Card Payment categories are not permitted and will be ignored if supplied.
      * @type {string}
      * @memberof ExistingTransaction
      */
-    category_id?: string | null;
+    category_id?: string;
     /**
      *
      * @type {string}
      * @memberof ExistingTransaction
      */
-    memo?: string | null;
+    memo?: string;
     /**
      *
      * @type {TransactionClearedStatus}

package/dist/esm/models/HybridTransaction.d.ts

@@ -35,7 +35,7 @@ export interface HybridTransaction {
      * @type {string}
      * @memberof HybridTransaction
      */
-    memo?: string | null;
+    memo?: string;
     /**
      *
      * @type {TransactionClearedStatus}
@@ -59,7 +59,7 @@ export interface HybridTransaction {
      * @type {string}
      * @memberof HybridTransaction
      */
-    flag_name?: string | null;
+    flag_name?: string;
     /**
      *
      * @type {string}
@@ -71,52 +71,52 @@ export interface HybridTransaction {
      * @type {string}
      * @memberof HybridTransaction
      */
-    payee_id?: string | null;
+    payee_id?: string;
     /**
      *
      * @type {string}
      * @memberof HybridTransaction
      */
-    category_id?: string | null;
+    category_id?: string;
     /**
      * If a transfer transaction, the account to which it transfers
      * @type {string}
      * @memberof HybridTransaction
      */
-    transfer_account_id?: string | null;
+    transfer_account_id?: string;
     /**
      * If a transfer transaction, the id of transaction on the other side of the transfer
      * @type {string}
      * @memberof HybridTransaction
      */
-    transfer_transaction_id?: string | null;
+    transfer_transaction_id?: string;
     /**
      * If transaction is matched, the id of the matched transaction
      * @type {string}
      * @memberof HybridTransaction
      */
-    matched_transaction_id?: string | null;
+    matched_transaction_id?: string;
     /**
      * If the transaction was imported, this field is a unique (by account) import identifier.  If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'.  For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'.  If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
      * @type {string}
      * @memberof HybridTransaction
      */
-    import_id?: string | null;
+    import_id?: string;
     /**
      * If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules
      * @type {string}
      * @memberof HybridTransaction
      */
-    import_payee_name?: string | null;
+    import_payee_name?: string;
     /**
      * If the transaction was imported, the original payee name as it appeared on the statement
      * @type {string}
      * @memberof HybridTransaction
      */
-    import_payee_name_original?: string | null;
+    import_payee_name_original?: string;
     /**
      * If the transaction is a debt/loan account transaction, the type of transaction
-     * @type {string}
+     * @type {HybridTransactionDebtTransactionTypeEnum}
      * @memberof HybridTransaction
      */
     debt_transaction_type?: HybridTransactionDebtTransactionTypeEnum | null;
@@ -128,7 +128,7 @@ export interface HybridTransaction {
     deleted: boolean;
     /**
      * Whether the hybrid transaction represents a regular transaction or a subtransaction
-     * @type {string}
+     * @type {HybridTransactionTypeEnum}
      * @memberof HybridTransaction
      */
     type: HybridTransactionTypeEnum;

package/dist/esm/models/MoneyMovement.d.ts

@@ -0,0 +1,75 @@
+/**
+ * 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
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+/**
+ *
+ * @export
+ * @interface MoneyMovement
+ */
+export interface MoneyMovement {
+    /**
+     *
+     * @type {string}
+     * @memberof MoneyMovement
+     */
+    id: string;
+    /**
+     * The month of the money movement in ISO format (e.g. 2024-01-01)
+     * @type {string}
+     * @memberof MoneyMovement
+     */
+    month?: string | null;
+    /**
+     * The date/time the money movement was processed on the server in ISO format (e.g. 2024-01-01T12:00:00Z)
+     * @type {string}
+     * @memberof MoneyMovement
+     */
+    moved_at?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof MoneyMovement
+     */
+    note?: string | null;
+    /**
+     * The id of the money movement group this movement belongs to
+     * @type {string}
+     * @memberof MoneyMovement
+     */
+    money_movement_group_id?: string | null;
+    /**
+     * The id of the user who performed the money movement
+     * @type {string}
+     * @memberof MoneyMovement
+     */
+    performed_by_user_id?: string | null;
+    /**
+     * The id of the category the money was moved from
+     * @type {string}
+     * @memberof MoneyMovement
+     */
+    from_category_id?: string | null;
+    /**
+     * The id of the category the money was moved to
+     * @type {string}
+     * @memberof MoneyMovement
+     */
+    to_category_id?: string | null;
+    /**
+     * The amount of the money movement in milliunits format
+     * @type {number}
+     * @memberof MoneyMovement
+     */
+    amount: number;
+}
+/**
+ * Check if a given object implements the MoneyMovement interface.
+ */
+export declare function instanceOfMoneyMovement(value: object): value is MoneyMovement;
+export declare function MoneyMovementFromJSON(json: any): MoneyMovement;
+export declare function MoneyMovementFromJSONTyped(json: any, ignoreDiscriminator: boolean): MoneyMovement;
+export declare function MoneyMovementToJSON(json: any): MoneyMovement;
+export declare function MoneyMovementToJSONTyped(value?: MoneyMovement | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/MoneyMovement.js

@@ -0,0 +1,57 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+/**
+ * Check if a given object implements the MoneyMovement interface.
+ */
+export function instanceOfMoneyMovement(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('amount' in value) || value['amount'] === undefined)
+        return false;
+    return true;
+}
+export function MoneyMovementFromJSON(json) {
+    return MoneyMovementFromJSONTyped(json, false);
+}
+export function MoneyMovementFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'month': json['month'] == null ? undefined : json['month'],
+        'moved_at': json['moved_at'] == null ? undefined : json['moved_at'],
+        'note': json['note'] == null ? undefined : json['note'],
+        'money_movement_group_id': json['money_movement_group_id'] == null ? undefined : json['money_movement_group_id'],
+        'performed_by_user_id': json['performed_by_user_id'] == null ? undefined : json['performed_by_user_id'],
+        'from_category_id': json['from_category_id'] == null ? undefined : json['from_category_id'],
+        'to_category_id': json['to_category_id'] == null ? undefined : json['to_category_id'],
+        'amount': json['amount'],
+    };
+}
+export function MoneyMovementToJSON(json) {
+    return MoneyMovementToJSONTyped(json, false);
+}
+export function MoneyMovementToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'month': value['month'],
+        'moved_at': value['moved_at'],
+        'note': value['note'],
+        'money_movement_group_id': value['money_movement_group_id'],
+        'performed_by_user_id': value['performed_by_user_id'],
+        'from_category_id': value['from_category_id'],
+        'to_category_id': value['to_category_id'],
+        'amount': value['amount'],
+    };
+}

package/dist/esm/models/MoneyMovementGroup.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+/**
+ *
+ * @export
+ * @interface MoneyMovementGroup
+ */
+export interface MoneyMovementGroup {
+    /**
+     *
+     * @type {string}
+     * @memberof MoneyMovementGroup
+     */
+    id: string;
+    /**
+     * When the money movement group was created
+     * @type {string}
+     * @memberof MoneyMovementGroup
+     */
+    group_created_at: string;
+    /**
+     * The month of the money movement group in ISO format (e.g. 2024-01-01)
+     * @type {string}
+     * @memberof MoneyMovementGroup
+     */
+    month: string;
+    /**
+     *
+     * @type {string}
+     * @memberof MoneyMovementGroup
+     */
+    note?: string | null;
+    /**
+     * The id of the user who performed the money movement group
+     * @type {string}
+     * @memberof MoneyMovementGroup
+     */
+    performed_by_user_id?: string | null;
+}
+/**
+ * Check if a given object implements the MoneyMovementGroup interface.
+ */
+export declare function instanceOfMoneyMovementGroup(value: object): value is MoneyMovementGroup;
+export declare function MoneyMovementGroupFromJSON(json: any): MoneyMovementGroup;
+export declare function MoneyMovementGroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): MoneyMovementGroup;
+export declare function MoneyMovementGroupToJSON(json: any): MoneyMovementGroup;
+export declare function MoneyMovementGroupToJSONTyped(value?: MoneyMovementGroup | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/MoneyMovementGroup.js

@@ -0,0 +1,51 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+/**
+ * Check if a given object implements the MoneyMovementGroup interface.
+ */
+export function instanceOfMoneyMovementGroup(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('group_created_at' in value) || value['group_created_at'] === undefined)
+        return false;
+    if (!('month' in value) || value['month'] === undefined)
+        return false;
+    return true;
+}
+export function MoneyMovementGroupFromJSON(json) {
+    return MoneyMovementGroupFromJSONTyped(json, false);
+}
+export function MoneyMovementGroupFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'group_created_at': json['group_created_at'],
+        'month': json['month'],
+        'note': json['note'] == null ? undefined : json['note'],
+        'performed_by_user_id': json['performed_by_user_id'] == null ? undefined : json['performed_by_user_id'],
+    };
+}
+export function MoneyMovementGroupToJSON(json) {
+    return MoneyMovementGroupToJSONTyped(json, false);
+}
+export function MoneyMovementGroupToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'group_created_at': value['group_created_at'],
+        'month': value['month'],
+        'note': value['note'],
+        'performed_by_user_id': value['performed_by_user_id'],
+    };
+}

package/dist/esm/models/MoneyMovementGroupsResponse.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+import type { MoneyMovementGroupsResponseData } from './MoneyMovementGroupsResponseData';
+/**
+ *
+ * @export
+ * @interface MoneyMovementGroupsResponse
+ */
+export interface MoneyMovementGroupsResponse {
+    /**
+     *
+     * @type {MoneyMovementGroupsResponseData}
+     * @memberof MoneyMovementGroupsResponse
+     */
+    data: MoneyMovementGroupsResponseData;
+}
+/**
+ * Check if a given object implements the MoneyMovementGroupsResponse interface.
+ */
+export declare function instanceOfMoneyMovementGroupsResponse(value: object): value is MoneyMovementGroupsResponse;
+export declare function MoneyMovementGroupsResponseFromJSON(json: any): MoneyMovementGroupsResponse;
+export declare function MoneyMovementGroupsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): MoneyMovementGroupsResponse;
+export declare function MoneyMovementGroupsResponseToJSON(json: any): MoneyMovementGroupsResponse;
+export declare function MoneyMovementGroupsResponseToJSONTyped(value?: MoneyMovementGroupsResponse | null, ignoreDiscriminator?: boolean): any;