ynab 4.0.0 → 4.1.0

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

@@ -5,7 +5,11 @@
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)
  */
 import * as runtime from '../runtime';
-import type { PatchPayeeWrapper, PayeeResponse, PayeesResponse, SavePayeeResponse } from '../models/index';
+import type { PatchPayeeWrapper, PayeeResponse, PayeesResponse, PostPayeeWrapper, SavePayeeResponse } from '../models/index';
+export interface CreatePayeeRequest {
+    planId: string;
+    data: PostPayeeWrapper;
+}
 export interface GetPayeeByIdRequest {
     planId: string;
     payeeId: string;
@@ -23,6 +27,16 @@ export interface UpdatePayeeRequest {
  *
  */
 export declare class PayeesApi extends runtime.BaseAPI {
+    /**
+     * Creates a new payee
+     * Create a payee
+     */
+    createPayeeRaw(requestParameters: CreatePayeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SavePayeeResponse>>;
+    /**
+     * Creates a new payee
+     * Create a payee
+     */
+    createPayee(planId: string, data: PostPayeeWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SavePayeeResponse>;
     /**
      * Returns a single payee
      * Get a payee

package/dist/esm/apis/PayeesApi.js

@@ -58,7 +58,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 import * as runtime from '../runtime';
-import { PatchPayeeWrapperToJSON, PayeeResponseFromJSON, PayeesResponseFromJSON, SavePayeeResponseFromJSON, } from '../models/index';
+import { PatchPayeeWrapperToJSON, PayeeResponseFromJSON, PayeesResponseFromJSON, PostPayeeWrapperToJSON, SavePayeeResponseFromJSON, } from '../models/index';
 /**
  *
  */
@@ -67,6 +67,67 @@ var PayeesApi = /** @class */ (function (_super) {
     function PayeesApi() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Creates a new payee
+     * Create a payee
+     */
+    PayeesApi.prototype.createPayeeRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, token, tokenString, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters.planId === null || requestParameters.planId === undefined) {
+                            throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling createPayee.');
+                        }
+                        if (requestParameters.data === null || requestParameters.data === undefined) {
+                            throw new runtime.RequiredError('data', 'Required parameter requestParameters.data was null or undefined when calling createPayee.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Accept'] = 'application/json';
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        token = this.configuration.accessToken;
+                        return [4 /*yield*/, token("bearer", [])];
+                    case 1:
+                        tokenString = _a.sent();
+                        if (tokenString) {
+                            headerParameters["Authorization"] = "Bearer ".concat(tokenString);
+                        }
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/plans/{plan_id}/payees".replace("{".concat("plan_id", "}"), encodeURIComponent(String(requestParameters.planId))),
+                            method: 'POST',
+                            headers: headerParameters,
+                            query: queryParameters,
+                            body: PostPayeeWrapperToJSON(requestParameters.data),
+                        }, initOverrides)];
+                    case 3:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return SavePayeeResponseFromJSON(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Creates a new payee
+     * Create a payee
+     */
+    PayeesApi.prototype.createPayee = 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.createPayeeRaw({ planId: planId, data: data }, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Returns a single payee
      * Get a payee

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

@@ -46,7 +46,7 @@ export interface Account {
      * @type {string}
      * @memberof Account
      */
-    note?: string | null;
+    note?: string;
     /**
      * The current available balance of the account in milliunits format
      * @type {number}
@@ -70,7 +70,7 @@ export interface Account {
      * @type {string}
      * @memberof Account
      */
-    transfer_payee_id: string | null;
+    transfer_payee_id: string;
     /**
      * Whether or not the account is linked to a financial institution for automatic transaction import.
      * @type {boolean}
@@ -88,13 +88,13 @@ export interface Account {
      * @type {string}
      * @memberof Account
      */
-    last_reconciled_at?: string | null;
+    last_reconciled_at?: string;
     /**
      * This field is deprecated and will always be null.
      * @type {number}
      * @memberof Account
      */
-    debt_original_balance?: number | null;
+    debt_original_balance?: number;
     /**
      *
      * @type {{ [key: string]: number; }}
@@ -125,6 +125,42 @@ export interface Account {
      * @memberof Account
      */
     deleted: boolean;
+    /**
+     * The current available balance of the account formatted in the plan's currency format
+     * @type {string}
+     * @memberof Account
+     */
+    balance_formatted?: string;
+    /**
+     * The current available balance of the account as a decimal currency amount
+     * @type {number}
+     * @memberof Account
+     */
+    balance_currency?: number;
+    /**
+     * The current cleared balance of the account formatted in the plan's currency format
+     * @type {string}
+     * @memberof Account
+     */
+    cleared_balance_formatted?: string;
+    /**
+     * The current cleared balance of the account as a decimal currency amount
+     * @type {number}
+     * @memberof Account
+     */
+    cleared_balance_currency?: number;
+    /**
+     * The current uncleared balance of the account formatted in the plan's currency format
+     * @type {string}
+     * @memberof Account
+     */
+    uncleared_balance_formatted?: string;
+    /**
+     * The current uncleared balance of the account as a decimal currency amount
+     * @type {number}
+     * @memberof Account
+     */
+    uncleared_balance_currency?: number;
 }
 /**
  * Check if a given object implements the Account interface.

package/dist/esm/models/Account.js

@@ -59,6 +59,12 @@ export function AccountFromJSONTyped(json, ignoreDiscriminator) {
         'debt_minimum_payments': json['debt_minimum_payments'] == null ? undefined : json['debt_minimum_payments'],
         'debt_escrow_amounts': json['debt_escrow_amounts'] == null ? undefined : json['debt_escrow_amounts'],
         'deleted': json['deleted'],
+        'balance_formatted': json['balance_formatted'] == null ? undefined : json['balance_formatted'],
+        'balance_currency': json['balance_currency'] == null ? undefined : json['balance_currency'],
+        'cleared_balance_formatted': json['cleared_balance_formatted'] == null ? undefined : json['cleared_balance_formatted'],
+        'cleared_balance_currency': json['cleared_balance_currency'] == null ? undefined : json['cleared_balance_currency'],
+        'uncleared_balance_formatted': json['uncleared_balance_formatted'] == null ? undefined : json['uncleared_balance_formatted'],
+        'uncleared_balance_currency': json['uncleared_balance_currency'] == null ? undefined : json['uncleared_balance_currency'],
     };
 }
 export function AccountToJSON(json) {
@@ -88,5 +94,11 @@ export function AccountToJSONTyped(value, ignoreDiscriminator) {
         'debt_minimum_payments': value['debt_minimum_payments'],
         'debt_escrow_amounts': value['debt_escrow_amounts'],
         'deleted': value['deleted'],
+        'balance_formatted': value['balance_formatted'],
+        'balance_currency': value['balance_currency'],
+        'cleared_balance_formatted': value['cleared_balance_formatted'],
+        'cleared_balance_currency': value['cleared_balance_currency'],
+        'uncleared_balance_formatted': value['uncleared_balance_formatted'],
+        'uncleared_balance_currency': value['uncleared_balance_currency'],
     };
 }

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

@@ -0,0 +1,136 @@
+/**
+ * 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 { AccountType } from './AccountType';
+/**
+ *
+ * @export
+ * @interface AccountBase
+ */
+export interface AccountBase {
+    /**
+     *
+     * @type {string}
+     * @memberof AccountBase
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AccountBase
+     */
+    name: string;
+    /**
+     *
+     * @type {AccountType}
+     * @memberof AccountBase
+     */
+    type: AccountType;
+    /**
+     * Whether this account is "on budget" or not
+     * @type {boolean}
+     * @memberof AccountBase
+     */
+    on_budget: boolean;
+    /**
+     * Whether this account is closed or not
+     * @type {boolean}
+     * @memberof AccountBase
+     */
+    closed: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof AccountBase
+     */
+    note?: string | null;
+    /**
+     * The current available balance of the account in milliunits format
+     * @type {number}
+     * @memberof AccountBase
+     */
+    balance: number;
+    /**
+     * The current cleared balance of the account in milliunits format
+     * @type {number}
+     * @memberof AccountBase
+     */
+    cleared_balance: number;
+    /**
+     * The current uncleared balance of the account in milliunits format
+     * @type {number}
+     * @memberof AccountBase
+     */
+    uncleared_balance: number;
+    /**
+     * The payee id which should be used when transferring to this account
+     * @type {string}
+     * @memberof AccountBase
+     */
+    transfer_payee_id: string | null;
+    /**
+     * Whether or not the account is linked to a financial institution for automatic transaction import.
+     * @type {boolean}
+     * @memberof AccountBase
+     */
+    direct_import_linked?: boolean;
+    /**
+     * If an account linked to a financial institution (direct_import_linked=true) and the linked connection is not in a healthy state, this will be true.
+     * @type {boolean}
+     * @memberof AccountBase
+     */
+    direct_import_in_error?: boolean;
+    /**
+     * A date/time specifying when the account was last reconciled.
+     * @type {string}
+     * @memberof AccountBase
+     */
+    last_reconciled_at?: string | null;
+    /**
+     * This field is deprecated and will always be null.
+     * @type {number}
+     * @memberof AccountBase
+     */
+    debt_original_balance?: number | null;
+    /**
+     *
+     * @type {{ [key: string]: number; }}
+     * @memberof AccountBase
+     */
+    debt_interest_rates?: {
+        [key: string]: number;
+    };
+    /**
+     *
+     * @type {{ [key: string]: number; }}
+     * @memberof AccountBase
+     */
+    debt_minimum_payments?: {
+        [key: string]: number;
+    };
+    /**
+     *
+     * @type {{ [key: string]: number; }}
+     * @memberof AccountBase
+     */
+    debt_escrow_amounts?: {
+        [key: string]: number;
+    };
+    /**
+     * Whether or not the account has been deleted.  Deleted accounts will only be included in delta requests.
+     * @type {boolean}
+     * @memberof AccountBase
+     */
+    deleted: boolean;
+}
+/**
+ * Check if a given object implements the AccountBase interface.
+ */
+export declare function instanceOfAccountBase(value: object): value is AccountBase;
+export declare function AccountBaseFromJSON(json: any): AccountBase;
+export declare function AccountBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountBase;
+export declare function AccountBaseToJSON(json: any): AccountBase;
+export declare function AccountBaseToJSONTyped(value?: AccountBase | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AccountBase.js

@@ -0,0 +1,92 @@
+/* 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 { AccountTypeFromJSON, AccountTypeToJSON, } from './AccountType';
+/**
+ * Check if a given object implements the AccountBase interface.
+ */
+export function instanceOfAccountBase(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('on_budget' in value) || value['on_budget'] === undefined)
+        return false;
+    if (!('closed' in value) || value['closed'] === undefined)
+        return false;
+    if (!('balance' in value) || value['balance'] === undefined)
+        return false;
+    if (!('cleared_balance' in value) || value['cleared_balance'] === undefined)
+        return false;
+    if (!('uncleared_balance' in value) || value['uncleared_balance'] === undefined)
+        return false;
+    if (!('transfer_payee_id' in value) || value['transfer_payee_id'] === undefined)
+        return false;
+    if (!('deleted' in value) || value['deleted'] === undefined)
+        return false;
+    return true;
+}
+export function AccountBaseFromJSON(json) {
+    return AccountBaseFromJSONTyped(json, false);
+}
+export function AccountBaseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'type': AccountTypeFromJSON(json['type']),
+        'on_budget': json['on_budget'],
+        'closed': json['closed'],
+        'note': json['note'] == null ? undefined : json['note'],
+        'balance': json['balance'],
+        'cleared_balance': json['cleared_balance'],
+        'uncleared_balance': json['uncleared_balance'],
+        'transfer_payee_id': json['transfer_payee_id'],
+        'direct_import_linked': json['direct_import_linked'] == null ? undefined : json['direct_import_linked'],
+        'direct_import_in_error': json['direct_import_in_error'] == null ? undefined : json['direct_import_in_error'],
+        'last_reconciled_at': json['last_reconciled_at'] == null ? undefined : json['last_reconciled_at'],
+        'debt_original_balance': json['debt_original_balance'] == null ? undefined : json['debt_original_balance'],
+        'debt_interest_rates': json['debt_interest_rates'] == null ? undefined : json['debt_interest_rates'],
+        'debt_minimum_payments': json['debt_minimum_payments'] == null ? undefined : json['debt_minimum_payments'],
+        'debt_escrow_amounts': json['debt_escrow_amounts'] == null ? undefined : json['debt_escrow_amounts'],
+        'deleted': json['deleted'],
+    };
+}
+export function AccountBaseToJSON(json) {
+    return AccountBaseToJSONTyped(json, false);
+}
+export function AccountBaseToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'type': AccountTypeToJSON(value['type']),
+        'on_budget': value['on_budget'],
+        'closed': value['closed'],
+        'note': value['note'],
+        'balance': value['balance'],
+        'cleared_balance': value['cleared_balance'],
+        'uncleared_balance': value['uncleared_balance'],
+        'transfer_payee_id': value['transfer_payee_id'],
+        'direct_import_linked': value['direct_import_linked'],
+        'direct_import_in_error': value['direct_import_in_error'],
+        'last_reconciled_at': value['last_reconciled_at'],
+        'debt_original_balance': value['debt_original_balance'],
+        'debt_interest_rates': value['debt_interest_rates'],
+        'debt_minimum_payments': value['debt_minimum_payments'],
+        'debt_escrow_amounts': value['debt_escrow_amounts'],
+        'deleted': value['deleted'],
+    };
+}

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

@@ -45,13 +45,13 @@ export interface Category {
      * @type {string}
      * @memberof Category
      */
-    original_category_group_id?: string | null;
+    original_category_group_id?: string;
     /**
      *
      * @type {string}
      * @memberof Category
      */
-    note?: string | null;
+    note?: string;
     /**
      * Assigned (budgeted) amount in milliunits format
      * @type {number}
@@ -81,91 +81,175 @@ export interface Category {
      * @type {boolean}
      * @memberof Category
      */
-    goal_needs_whole_amount?: boolean | null;
+    goal_needs_whole_amount?: boolean;
     /**
      * A day offset modifier for the goal's due date. When goal_cadence is 2 (Weekly), this value specifies which day of the week the goal is due (0 = Sunday, 6 = Saturday). Otherwise, this value specifies which day of the month the goal is due (1 = 1st, 31 = 31st, null = Last day of Month).
      * @type {number}
      * @memberof Category
      */
-    goal_day?: number | null;
+    goal_day?: number;
     /**
      * The goal cadence. Value in range 0-14. There are two subsets of these values which behave differently. For values 0, 1, 2, and 13, the goal's due date repeats every goal_cadence * goal_cadence_frequency, where 0 = None, 1 = Monthly, 2 = Weekly, and 13 = Yearly. For example, goal_cadence 1 with goal_cadence_frequency 2 means the goal is due every other month. For values 3-12 and 14, goal_cadence_frequency is ignored and the goal's due date repeats every goal_cadence, where 3 = Every 2 Months, 4 = Every 3 Months, ..., 12 = Every 11 Months, and 14 = Every 2 Years.
      * @type {number}
      * @memberof Category
      */
-    goal_cadence?: number | null;
+    goal_cadence?: number;
     /**
      * The goal cadence frequency. When goal_cadence is 0, 1, 2, or 13, a goal's due date repeats every goal_cadence * goal_cadence_frequency. For example, goal_cadence 1 with goal_cadence_frequency 2 means the goal is due every other month.  When goal_cadence is 3-12 or 14, goal_cadence_frequency is ignored.
      * @type {number}
      * @memberof Category
      */
-    goal_cadence_frequency?: number | null;
+    goal_cadence_frequency?: number;
     /**
      * The month a goal was created
      * @type {string}
      * @memberof Category
      */
-    goal_creation_month?: string | null;
+    goal_creation_month?: string;
     /**
      * The goal target amount in milliunits
      * @type {number}
      * @memberof Category
      */
-    goal_target?: number | null;
+    goal_target?: number;
     /**
      * DEPRECATED: No longer used.  Use `goal_target_date` instead.
      * @type {string}
      * @memberof Category
      */
-    goal_target_month?: string | null;
+    goal_target_month?: string;
     /**
      * 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;
+    goal_target_date?: string;
     /**
      * The percentage completion of the goal
      * @type {number}
      * @memberof Category
      */
-    goal_percentage_complete?: number | null;
+    goal_percentage_complete?: number;
     /**
      * The number of months, including the current month, left in the current goal period.
      * @type {number}
      * @memberof Category
      */
-    goal_months_to_budget?: number | null;
+    goal_months_to_budget?: number;
     /**
      * The amount of funding still needed in the current month to stay on track towards completing the goal within the current goal period. This amount will generally correspond to the 'Underfunded' amount in the web and mobile clients except when viewing a category with a Needed for Spending Goal in a future month.  The web and mobile clients will ignore any funding from a prior goal period when viewing category with a Needed for Spending Goal in a future month.
      * @type {number}
      * @memberof Category
      */
-    goal_under_funded?: number | null;
+    goal_under_funded?: number;
     /**
      * The total amount funded towards the goal within the current goal period.
      * @type {number}
      * @memberof Category
      */
-    goal_overall_funded?: number | null;
+    goal_overall_funded?: number;
     /**
      * The amount of funding still needed to complete the goal within the current goal period.
      * @type {number}
      * @memberof Category
      */
-    goal_overall_left?: number | null;
+    goal_overall_left?: number;
     /**
      * The date/time the goal was snoozed.  If the goal is not snoozed, this will be null.
      * @type {string}
      * @memberof Category
      */
-    goal_snoozed_at?: string | null;
+    goal_snoozed_at?: string;
     /**
      * Whether or not the category has been deleted.  Deleted categories will only be included in delta requests.
      * @type {boolean}
      * @memberof Category
      */
     deleted: boolean;
+    /**
+     * Available balance of the category formatted in the plan's currency format
+     * @type {string}
+     * @memberof Category
+     */
+    balance_formatted?: string;
+    /**
+     * Available balance of the category as a decimal currency amount
+     * @type {number}
+     * @memberof Category
+     */
+    balance_currency?: number;
+    /**
+     * Activity of the category formatted in the plan's currency format
+     * @type {string}
+     * @memberof Category
+     */
+    activity_formatted?: string;
+    /**
+     * Activity of the category as a decimal currency amount
+     * @type {number}
+     * @memberof Category
+     */
+    activity_currency?: number;
+    /**
+     * Assigned (budgeted) amount of the category formatted in the plan's currency format
+     * @type {string}
+     * @memberof Category
+     */
+    budgeted_formatted?: string;
+    /**
+     * Assigned (budgeted) amount of the category as a decimal currency amount
+     * @type {number}
+     * @memberof Category
+     */
+    budgeted_currency?: number;
+    /**
+     * The goal target amount formatted in the plan's currency format
+     * @type {string}
+     * @memberof Category
+     */
+    goal_target_formatted?: string | null;
+    /**
+     * The goal target amount as a decimal currency amount
+     * @type {number}
+     * @memberof Category
+     */
+    goal_target_currency?: number | null;
+    /**
+     * The goal underfunded amount formatted in the plan's currency format
+     * @type {string}
+     * @memberof Category
+     */
+    goal_under_funded_formatted?: string | null;
+    /**
+     * The goal underfunded amount as a decimal currency amount
+     * @type {number}
+     * @memberof Category
+     */
+    goal_under_funded_currency?: number | null;
+    /**
+     * The total amount funded towards the goal formatted in the plan's currency format
+     * @type {string}
+     * @memberof Category
+     */
+    goal_overall_funded_formatted?: string | null;
+    /**
+     * The total amount funded towards the goal as a decimal currency amount
+     * @type {number}
+     * @memberof Category
+     */
+    goal_overall_funded_currency?: number | null;
+    /**
+     * The amount of funding still needed to complete the goal formatted in the plan's currency format
+     * @type {string}
+     * @memberof Category
+     */
+    goal_overall_left_formatted?: string | null;
+    /**
+     * The amount of funding still needed to complete the goal as a decimal currency amount
+     * @type {number}
+     * @memberof Category
+     */
+    goal_overall_left_currency?: number | null;
 }
 /**
  * @export