ynab 4.0.0 → 4.4.0

package/dist/esm/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/esm/models/MonthDetail.js

@@ -43,6 +43,14 @@ export 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(CategoryFromJSON)),
     };
 }
@@ -63,6 +71,14 @@ export function MonthDetailToJSONTyped(value, ignoreDiscriminator) {
         '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(CategoryToJSON)),
     };
 }

package/dist/esm/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/esm/models/MonthDetailBase.js

@@ -0,0 +1,68 @@
+/* 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)
+ */
+import { CategoryBaseFromJSON, CategoryBaseToJSON, } from './CategoryBase';
+/**
+ * Check if a given object implements the MonthDetailBase interface.
+ */
+export 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;
+}
+export function MonthDetailBaseFromJSON(json) {
+    return MonthDetailBaseFromJSONTyped(json, false);
+}
+export 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(CategoryBaseFromJSON)),
+    };
+}
+export function MonthDetailBaseToJSON(json) {
+    return MonthDetailBaseToJSONTyped(json, false);
+}
+export function MonthDetailBaseToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { 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(CategoryBaseToJSON)),
+    };
+}

package/dist/esm/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/esm/models/MonthSummary.js

@@ -40,6 +40,14 @@ export 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'],
     };
 }
 export function MonthSummaryToJSON(json) {
@@ -59,5 +67,13 @@ export function MonthSummaryToJSONTyped(value, ignoreDiscriminator) {
         '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/esm/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;

package/dist/esm/models/MonthSummaryBase.js

@@ -0,0 +1,63 @@
+/* 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 MonthSummaryBase interface.
+ */
+export function instanceOfMonthSummaryBase(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;
+    return true;
+}
+export function MonthSummaryBaseFromJSON(json) {
+    return MonthSummaryBaseFromJSONTyped(json, false);
+}
+export function MonthSummaryBaseFromJSONTyped(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'],
+    };
+}
+export function MonthSummaryBaseToJSON(json) {
+    return MonthSummaryBaseToJSONTyped(json, false);
+}
+export function MonthSummaryBaseToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { 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'],
+    };
+}

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

@@ -29,7 +29,7 @@ export interface NewCategory {
      */
     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.
+     * The goal target amount in milliunits format.  If value is specified and goal has not already been configured for category, a monthly goal will be created for the category with this target amount.  If goal_type is not specified, it will default to 'NEED' or 'MF' for Credit Card Payment categories.
      * @type {number}
      * @memberof NewCategory
      */
@@ -40,6 +40,12 @@ export interface NewCategory {
      * @memberof NewCategory
      */
     goal_target_date?: string;
+    /**
+     * Whether the goal requires the full target amount each period. Only supported for 'NEED' goals. When true, the goal is configured as 'Set aside another...'. When false, the goal is configured as 'Refill up to...'.
+     * @type {boolean}
+     * @memberof NewCategory
+     */
+    goal_needs_whole_amount?: boolean;
 }
 /**
  * Check if a given object implements the NewCategory interface.

package/dist/esm/models/NewCategory.js

@@ -25,6 +25,7 @@ export function NewCategoryFromJSONTyped(json, ignoreDiscriminator) {
         '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'],
+        'goal_needs_whole_amount': json['goal_needs_whole_amount'] == null ? undefined : json['goal_needs_whole_amount'],
     };
 }
 export function NewCategoryToJSON(json) {
@@ -41,5 +42,6 @@ export function NewCategoryToJSONTyped(value, ignoreDiscriminator) {
         'category_group_id': value['category_group_id'],
         'goal_target': value['goal_target'],
         'goal_target_date': value['goal_target_date'],
+        'goal_needs_whole_amount': value['goal_needs_whole_amount'],
     };
 }

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

@@ -4,17 +4,17 @@
  *
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)
  */
+import type { MonthDetailBase } from './MonthDetailBase';
 import type { PayeeLocation } from './PayeeLocation';
-import type { Account } from './Account';
-import type { ScheduledTransactionSummary } from './ScheduledTransactionSummary';
-import type { Category } from './Category';
+import type { CategoryBase } from './CategoryBase';
 import type { CurrencyFormat } from './CurrencyFormat';
 import type { DateFormat } from './DateFormat';
-import type { SubTransaction } from './SubTransaction';
-import type { MonthDetail } from './MonthDetail';
+import type { SubTransactionBase } from './SubTransactionBase';
+import type { ScheduledSubTransactionBase } from './ScheduledSubTransactionBase';
+import type { ScheduledTransactionSummaryBase } from './ScheduledTransactionSummaryBase';
+import type { TransactionSummaryBase } from './TransactionSummaryBase';
 import type { Payee } from './Payee';
-import type { ScheduledSubTransaction } from './ScheduledSubTransaction';
-import type { TransactionSummary } from './TransactionSummary';
+import type { AccountBase } from './AccountBase';
 import type { CategoryGroup } from './CategoryGroup';
 /**
  *
@@ -66,10 +66,10 @@ export interface PlanDetail {
     currency_format?: CurrencyFormat;
     /**
      *
-     * @type {Array<Account>}
+     * @type {Array<AccountBase>}
      * @memberof PlanDetail
      */
-    accounts?: Array<Account>;
+    accounts?: Array<AccountBase>;
     /**
      *
      * @type {Array<Payee>}
@@ -90,40 +90,40 @@ export interface PlanDetail {
     category_groups?: Array<CategoryGroup>;
     /**
      *
-     * @type {Array<Category>}
+     * @type {Array<CategoryBase>}
      * @memberof PlanDetail
      */
-    categories?: Array<Category>;
+    categories?: Array<CategoryBase>;
     /**
      *
-     * @type {Array<MonthDetail>}
+     * @type {Array<MonthDetailBase>}
      * @memberof PlanDetail
      */
-    months?: Array<MonthDetail>;
+    months?: Array<MonthDetailBase>;
     /**
      *
-     * @type {Array<TransactionSummary>}
+     * @type {Array<TransactionSummaryBase>}
      * @memberof PlanDetail
      */
-    transactions?: Array<TransactionSummary>;
+    transactions?: Array<TransactionSummaryBase>;
     /**
      *
-     * @type {Array<SubTransaction>}
+     * @type {Array<SubTransactionBase>}
      * @memberof PlanDetail
      */
-    subtransactions?: Array<SubTransaction>;
+    subtransactions?: Array<SubTransactionBase>;
     /**
      *
-     * @type {Array<ScheduledTransactionSummary>}
+     * @type {Array<ScheduledTransactionSummaryBase>}
      * @memberof PlanDetail
      */
-    scheduled_transactions?: Array<ScheduledTransactionSummary>;
+    scheduled_transactions?: Array<ScheduledTransactionSummaryBase>;
     /**
      *
-     * @type {Array<ScheduledSubTransaction>}
+     * @type {Array<ScheduledSubTransactionBase>}
      * @memberof PlanDetail
      */
-    scheduled_subtransactions?: Array<ScheduledSubTransaction>;
+    scheduled_subtransactions?: Array<ScheduledSubTransactionBase>;
 }
 /**
  * Check if a given object implements the PlanDetail interface.