ynab 3.1.0 → 4.1.0

package/dist/models/MoneyMovement.d.ts

@@ -21,49 +21,61 @@ export interface MoneyMovement {
      * @type {string}
      * @memberof MoneyMovement
      */
-    month?: string | null;
+    month?: string;
     /**
      * 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;
+    moved_at?: string;
     /**
      *
      * @type {string}
      * @memberof MoneyMovement
      */
-    note?: string | null;
+    note?: string;
     /**
      * The id of the money movement group this movement belongs to
      * @type {string}
      * @memberof MoneyMovement
      */
-    money_movement_group_id?: string | null;
+    money_movement_group_id?: string;
     /**
      * The id of the user who performed the money movement
      * @type {string}
      * @memberof MoneyMovement
      */
-    performed_by_user_id?: string | null;
+    performed_by_user_id?: string;
     /**
      * The id of the category the money was moved from
      * @type {string}
      * @memberof MoneyMovement
      */
-    from_category_id?: string | null;
+    from_category_id?: string;
     /**
      * The id of the category the money was moved to
      * @type {string}
      * @memberof MoneyMovement
      */
-    to_category_id?: string | null;
+    to_category_id?: string;
     /**
      * The amount of the money movement in milliunits format
      * @type {number}
      * @memberof MoneyMovement
      */
     amount: number;
+    /**
+     * The money movement amount formatted in the plan's currency format
+     * @type {string}
+     * @memberof MoneyMovement
+     */
+    amount_formatted?: string;
+    /**
+     * The money movement amount as a decimal currency amount
+     * @type {number}
+     * @memberof MoneyMovement
+     */
+    amount_currency?: number;
 }
 /**
  * Check if a given object implements the MoneyMovement interface.

package/dist/models/MoneyMovement.js

@@ -40,6 +40,8 @@ function MoneyMovementFromJSONTyped(json, ignoreDiscriminator) {
         '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'],
+        'amount_formatted': json['amount_formatted'] == null ? undefined : json['amount_formatted'],
+        'amount_currency': json['amount_currency'] == null ? undefined : json['amount_currency'],
     };
 }
 function MoneyMovementToJSON(json) {
@@ -59,5 +61,7 @@ function MoneyMovementToJSONTyped(value, ignoreDiscriminator = false) {
         'from_category_id': value['from_category_id'],
         'to_category_id': value['to_category_id'],
         'amount': value['amount'],
+        'amount_formatted': value['amount_formatted'],
+        'amount_currency': value['amount_currency'],
     };
 }

package/dist/models/MoneyMovementBase.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 MoneyMovementBase
+ */
+export interface MoneyMovementBase {
+    /**
+     *
+     * @type {string}
+     * @memberof MoneyMovementBase
+     */
+    id: string;
+    /**
+     * The month of the money movement in ISO format (e.g. 2024-01-01)
+     * @type {string}
+     * @memberof MoneyMovementBase
+     */
+    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 MoneyMovementBase
+     */
+    moved_at?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof MoneyMovementBase
+     */
+    note?: string | null;
+    /**
+     * The id of the money movement group this movement belongs to
+     * @type {string}
+     * @memberof MoneyMovementBase
+     */
+    money_movement_group_id?: string | null;
+    /**
+     * The id of the user who performed the money movement
+     * @type {string}
+     * @memberof MoneyMovementBase
+     */
+    performed_by_user_id?: string | null;
+    /**
+     * The id of the category the money was moved from
+     * @type {string}
+     * @memberof MoneyMovementBase
+     */
+    from_category_id?: string | null;
+    /**
+     * The id of the category the money was moved to
+     * @type {string}
+     * @memberof MoneyMovementBase
+     */
+    to_category_id?: string | null;
+    /**
+     * The amount of the money movement in milliunits format
+     * @type {number}
+     * @memberof MoneyMovementBase
+     */
+    amount: number;
+}
+/**
+ * Check if a given object implements the MoneyMovementBase interface.
+ */
+export declare function instanceOfMoneyMovementBase(value: object): value is MoneyMovementBase;
+export declare function MoneyMovementBaseFromJSON(json: any): MoneyMovementBase;
+export declare function MoneyMovementBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): MoneyMovementBase;
+export declare function MoneyMovementBaseToJSON(json: any): MoneyMovementBase;
+export declare function MoneyMovementBaseToJSONTyped(value?: MoneyMovementBase | null, ignoreDiscriminator?: boolean): any;

package/dist/models/MoneyMovementBase.js

@@ -0,0 +1,63 @@
+"use strict";
+/* 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)
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfMoneyMovementBase = instanceOfMoneyMovementBase;
+exports.MoneyMovementBaseFromJSON = MoneyMovementBaseFromJSON;
+exports.MoneyMovementBaseFromJSONTyped = MoneyMovementBaseFromJSONTyped;
+exports.MoneyMovementBaseToJSON = MoneyMovementBaseToJSON;
+exports.MoneyMovementBaseToJSONTyped = MoneyMovementBaseToJSONTyped;
+/**
+ * Check if a given object implements the MoneyMovementBase interface.
+ */
+function instanceOfMoneyMovementBase(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('amount' in value) || value['amount'] === undefined)
+        return false;
+    return true;
+}
+function MoneyMovementBaseFromJSON(json) {
+    return MoneyMovementBaseFromJSONTyped(json, false);
+}
+function MoneyMovementBaseFromJSONTyped(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'],
+    };
+}
+function MoneyMovementBaseToJSON(json) {
+    return MoneyMovementBaseToJSONTyped(json, false);
+}
+function MoneyMovementBaseToJSONTyped(value, 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/models/MonthDetail.d.ts

@@ -59,6 +59,54 @@ export interface MonthDetail {
      * @memberof MonthDetail
      */
     deleted: boolean;
+    /**
+     * The total income formatted in the plan's currency format
+     * @type {string}
+     * @memberof MonthDetail
+     */
+    income_formatted?: string;
+    /**
+     * The total income as a decimal currency amount
+     * @type {number}
+     * @memberof MonthDetail
+     */
+    income_currency?: number;
+    /**
+     * The total amount assigned formatted in the plan's currency format
+     * @type {string}
+     * @memberof MonthDetail
+     */
+    budgeted_formatted?: string;
+    /**
+     * The total amount assigned as a decimal currency amount
+     * @type {number}
+     * @memberof MonthDetail
+     */
+    budgeted_currency?: number;
+    /**
+     * The total activity amount formatted in the plan's currency format
+     * @type {string}
+     * @memberof MonthDetail
+     */
+    activity_formatted?: string;
+    /**
+     * The total activity amount as a decimal currency amount
+     * @type {number}
+     * @memberof MonthDetail
+     */
+    activity_currency?: number;
+    /**
+     * The available amount for 'Ready to Assign' formatted in the plan's currency format
+     * @type {string}
+     * @memberof MonthDetail
+     */
+    to_be_budgeted_formatted?: string;
+    /**
+     * The available amount for 'Ready to Assign' as a decimal currency amount
+     * @type {number}
+     * @memberof MonthDetail
+     */
+    to_be_budgeted_currency?: number;
     /**
      * The plan month categories.  Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified.
      * @type {Array<Category>}

package/dist/models/MonthDetail.js

@@ -50,6 +50,14 @@ function MonthDetailFromJSONTyped(json, ignoreDiscriminator) {
         'to_be_budgeted': json['to_be_budgeted'],
         'age_of_money': json['age_of_money'] == null ? undefined : json['age_of_money'],
         'deleted': json['deleted'],
+        'income_formatted': json['income_formatted'] == null ? undefined : json['income_formatted'],
+        'income_currency': json['income_currency'] == null ? undefined : json['income_currency'],
+        'budgeted_formatted': json['budgeted_formatted'] == null ? undefined : json['budgeted_formatted'],
+        'budgeted_currency': json['budgeted_currency'] == null ? undefined : json['budgeted_currency'],
+        'activity_formatted': json['activity_formatted'] == null ? undefined : json['activity_formatted'],
+        'activity_currency': json['activity_currency'] == null ? undefined : json['activity_currency'],
+        'to_be_budgeted_formatted': json['to_be_budgeted_formatted'] == null ? undefined : json['to_be_budgeted_formatted'],
+        'to_be_budgeted_currency': json['to_be_budgeted_currency'] == null ? undefined : json['to_be_budgeted_currency'],
         'categories': (json['categories'].map(Category_1.CategoryFromJSON)),
     };
 }
@@ -69,6 +77,14 @@ function MonthDetailToJSONTyped(value, ignoreDiscriminator = false) {
         'to_be_budgeted': value['to_be_budgeted'],
         'age_of_money': value['age_of_money'],
         'deleted': value['deleted'],
+        'income_formatted': value['income_formatted'],
+        'income_currency': value['income_currency'],
+        'budgeted_formatted': value['budgeted_formatted'],
+        'budgeted_currency': value['budgeted_currency'],
+        'activity_formatted': value['activity_formatted'],
+        'activity_currency': value['activity_currency'],
+        'to_be_budgeted_formatted': value['to_be_budgeted_formatted'],
+        'to_be_budgeted_currency': value['to_be_budgeted_currency'],
         'categories': (value['categories'].map(Category_1.CategoryToJSON)),
     };
 }

package/dist/models/MonthDetailBase.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 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 { CategoryBase } from './CategoryBase';
+/**
+ *
+ * @export
+ * @interface MonthDetailBase
+ */
+export interface MonthDetailBase {
+    /**
+     *
+     * @type {string}
+     * @memberof MonthDetailBase
+     */
+    month: string;
+    /**
+     *
+     * @type {string}
+     * @memberof MonthDetailBase
+     */
+    note?: string;
+    /**
+     * The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month
+     * @type {number}
+     * @memberof MonthDetailBase
+     */
+    income: number;
+    /**
+     * The total amount assigned (budgeted) in the month
+     * @type {number}
+     * @memberof MonthDetailBase
+     */
+    budgeted: number;
+    /**
+     * The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign'
+     * @type {number}
+     * @memberof MonthDetailBase
+     */
+    activity: number;
+    /**
+     * The available amount for 'Ready to Assign'
+     * @type {number}
+     * @memberof MonthDetailBase
+     */
+    to_be_budgeted: number;
+    /**
+     * The Age of Money as of the month
+     * @type {number}
+     * @memberof MonthDetailBase
+     */
+    age_of_money?: number;
+    /**
+     * Whether or not the month has been deleted.  Deleted months will only be included in delta requests.
+     * @type {boolean}
+     * @memberof MonthDetailBase
+     */
+    deleted: boolean;
+    /**
+     * The plan month categories.  Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified.
+     * @type {Array<CategoryBase>}
+     * @memberof MonthDetailBase
+     */
+    categories: Array<CategoryBase>;
+}
+/**
+ * Check if a given object implements the MonthDetailBase interface.
+ */
+export declare function instanceOfMonthDetailBase(value: object): value is MonthDetailBase;
+export declare function MonthDetailBaseFromJSON(json: any): MonthDetailBase;
+export declare function MonthDetailBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): MonthDetailBase;
+export declare function MonthDetailBaseToJSON(json: any): MonthDetailBase;
+export declare function MonthDetailBaseToJSONTyped(value?: MonthDetailBase | null, ignoreDiscriminator?: boolean): any;

package/dist/models/MonthDetailBase.js

@@ -0,0 +1,74 @@
+"use strict";
+/* 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)
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfMonthDetailBase = instanceOfMonthDetailBase;
+exports.MonthDetailBaseFromJSON = MonthDetailBaseFromJSON;
+exports.MonthDetailBaseFromJSONTyped = MonthDetailBaseFromJSONTyped;
+exports.MonthDetailBaseToJSON = MonthDetailBaseToJSON;
+exports.MonthDetailBaseToJSONTyped = MonthDetailBaseToJSONTyped;
+const CategoryBase_1 = require("./CategoryBase");
+/**
+ * Check if a given object implements the MonthDetailBase interface.
+ */
+function instanceOfMonthDetailBase(value) {
+    if (!('month' in value) || value['month'] === undefined)
+        return false;
+    if (!('income' in value) || value['income'] === undefined)
+        return false;
+    if (!('budgeted' in value) || value['budgeted'] === undefined)
+        return false;
+    if (!('activity' in value) || value['activity'] === undefined)
+        return false;
+    if (!('to_be_budgeted' in value) || value['to_be_budgeted'] === undefined)
+        return false;
+    if (!('deleted' in value) || value['deleted'] === undefined)
+        return false;
+    if (!('categories' in value) || value['categories'] === undefined)
+        return false;
+    return true;
+}
+function MonthDetailBaseFromJSON(json) {
+    return MonthDetailBaseFromJSONTyped(json, false);
+}
+function MonthDetailBaseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'month': json['month'],
+        'note': json['note'] == null ? undefined : json['note'],
+        'income': json['income'],
+        'budgeted': json['budgeted'],
+        'activity': json['activity'],
+        'to_be_budgeted': json['to_be_budgeted'],
+        'age_of_money': json['age_of_money'] == null ? undefined : json['age_of_money'],
+        'deleted': json['deleted'],
+        'categories': (json['categories'].map(CategoryBase_1.CategoryBaseFromJSON)),
+    };
+}
+function MonthDetailBaseToJSON(json) {
+    return MonthDetailBaseToJSONTyped(json, false);
+}
+function MonthDetailBaseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'month': value['month'],
+        'note': value['note'],
+        'income': value['income'],
+        'budgeted': value['budgeted'],
+        'activity': value['activity'],
+        'to_be_budgeted': value['to_be_budgeted'],
+        'age_of_money': value['age_of_money'],
+        'deleted': value['deleted'],
+        'categories': (value['categories'].map(CategoryBase_1.CategoryBaseToJSON)),
+    };
+}

package/dist/models/MonthSummary.d.ts

@@ -21,7 +21,7 @@ export interface MonthSummary {
      * @type {string}
      * @memberof MonthSummary
      */
-    note?: string | null;
+    note?: string;
     /**
      * The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month
      * @type {number}
@@ -51,13 +51,61 @@ export interface MonthSummary {
      * @type {number}
      * @memberof MonthSummary
      */
-    age_of_money?: number | null;
+    age_of_money?: number;
     /**
      * Whether or not the month has been deleted.  Deleted months will only be included in delta requests.
      * @type {boolean}
      * @memberof MonthSummary
      */
     deleted: boolean;
+    /**
+     * The total income formatted in the plan's currency format
+     * @type {string}
+     * @memberof MonthSummary
+     */
+    income_formatted?: string;
+    /**
+     * The total income as a decimal currency amount
+     * @type {number}
+     * @memberof MonthSummary
+     */
+    income_currency?: number;
+    /**
+     * The total amount assigned formatted in the plan's currency format
+     * @type {string}
+     * @memberof MonthSummary
+     */
+    budgeted_formatted?: string;
+    /**
+     * The total amount assigned as a decimal currency amount
+     * @type {number}
+     * @memberof MonthSummary
+     */
+    budgeted_currency?: number;
+    /**
+     * The total activity amount formatted in the plan's currency format
+     * @type {string}
+     * @memberof MonthSummary
+     */
+    activity_formatted?: string;
+    /**
+     * The total activity amount as a decimal currency amount
+     * @type {number}
+     * @memberof MonthSummary
+     */
+    activity_currency?: number;
+    /**
+     * The available amount for 'Ready to Assign' formatted in the plan's currency format
+     * @type {string}
+     * @memberof MonthSummary
+     */
+    to_be_budgeted_formatted?: string;
+    /**
+     * The available amount for 'Ready to Assign' as a decimal currency amount
+     * @type {number}
+     * @memberof MonthSummary
+     */
+    to_be_budgeted_currency?: number;
 }
 /**
  * Check if a given object implements the MonthSummary interface.

package/dist/models/MonthSummary.js

@@ -47,6 +47,14 @@ function MonthSummaryFromJSONTyped(json, ignoreDiscriminator) {
         'to_be_budgeted': json['to_be_budgeted'],
         'age_of_money': json['age_of_money'] == null ? undefined : json['age_of_money'],
         'deleted': json['deleted'],
+        'income_formatted': json['income_formatted'] == null ? undefined : json['income_formatted'],
+        'income_currency': json['income_currency'] == null ? undefined : json['income_currency'],
+        'budgeted_formatted': json['budgeted_formatted'] == null ? undefined : json['budgeted_formatted'],
+        'budgeted_currency': json['budgeted_currency'] == null ? undefined : json['budgeted_currency'],
+        'activity_formatted': json['activity_formatted'] == null ? undefined : json['activity_formatted'],
+        'activity_currency': json['activity_currency'] == null ? undefined : json['activity_currency'],
+        'to_be_budgeted_formatted': json['to_be_budgeted_formatted'] == null ? undefined : json['to_be_budgeted_formatted'],
+        'to_be_budgeted_currency': json['to_be_budgeted_currency'] == null ? undefined : json['to_be_budgeted_currency'],
     };
 }
 function MonthSummaryToJSON(json) {
@@ -65,5 +73,13 @@ function MonthSummaryToJSONTyped(value, ignoreDiscriminator = false) {
         'to_be_budgeted': value['to_be_budgeted'],
         'age_of_money': value['age_of_money'],
         'deleted': value['deleted'],
+        'income_formatted': value['income_formatted'],
+        'income_currency': value['income_currency'],
+        'budgeted_formatted': value['budgeted_formatted'],
+        'budgeted_currency': value['budgeted_currency'],
+        'activity_formatted': value['activity_formatted'],
+        'activity_currency': value['activity_currency'],
+        'to_be_budgeted_formatted': value['to_be_budgeted_formatted'],
+        'to_be_budgeted_currency': value['to_be_budgeted_currency'],
     };
 }

package/dist/models/MonthSummaryBase.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 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 MonthSummaryBase
+ */
+export interface MonthSummaryBase {
+    /**
+     *
+     * @type {string}
+     * @memberof MonthSummaryBase
+     */
+    month: string;
+    /**
+     *
+     * @type {string}
+     * @memberof MonthSummaryBase
+     */
+    note?: string | null;
+    /**
+     * The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month
+     * @type {number}
+     * @memberof MonthSummaryBase
+     */
+    income: number;
+    /**
+     * The total amount assigned (budgeted) in the month
+     * @type {number}
+     * @memberof MonthSummaryBase
+     */
+    budgeted: number;
+    /**
+     * The total amount of transactions in the month, excluding those categorized to 'Inflow: Ready to Assign'
+     * @type {number}
+     * @memberof MonthSummaryBase
+     */
+    activity: number;
+    /**
+     * The available amount for 'Ready to Assign'
+     * @type {number}
+     * @memberof MonthSummaryBase
+     */
+    to_be_budgeted: number;
+    /**
+     * The Age of Money as of the month
+     * @type {number}
+     * @memberof MonthSummaryBase
+     */
+    age_of_money?: number | null;
+    /**
+     * Whether or not the month has been deleted.  Deleted months will only be included in delta requests.
+     * @type {boolean}
+     * @memberof MonthSummaryBase
+     */
+    deleted: boolean;
+}
+/**
+ * Check if a given object implements the MonthSummaryBase interface.
+ */
+export declare function instanceOfMonthSummaryBase(value: object): value is MonthSummaryBase;
+export declare function MonthSummaryBaseFromJSON(json: any): MonthSummaryBase;
+export declare function MonthSummaryBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): MonthSummaryBase;
+export declare function MonthSummaryBaseToJSON(json: any): MonthSummaryBase;
+export declare function MonthSummaryBaseToJSONTyped(value?: MonthSummaryBase | null, ignoreDiscriminator?: boolean): any;