ynab 1.55.0 → 2.0.0-rc.0

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

@@ -0,0 +1,32 @@
+/**
+ * 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { SaveCategoryResponseData } from './SaveCategoryResponseData';
+/**
+ *
+ * @export
+ * @interface SaveCategoryResponse
+ */
+export interface SaveCategoryResponse {
+    /**
+     *
+     * @type {SaveCategoryResponseData}
+     * @memberof SaveCategoryResponse
+     */
+    data: SaveCategoryResponseData;
+}
+/**
+ * Check if a given object implements the SaveCategoryResponse interface.
+ */
+export declare function instanceOfSaveCategoryResponse(value: object): boolean;
+export declare function SaveCategoryResponseFromJSON(json: any): SaveCategoryResponse;
+export declare function SaveCategoryResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SaveCategoryResponse;
+export declare function SaveCategoryResponseToJSON(value?: SaveCategoryResponse | null): any;

package/dist/esm/models/SaveCategoryResponse.js

@@ -0,0 +1,44 @@
+/* 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { SaveCategoryResponseDataFromJSON, SaveCategoryResponseDataToJSON, } from './SaveCategoryResponseData';
+/**
+ * Check if a given object implements the SaveCategoryResponse interface.
+ */
+export function instanceOfSaveCategoryResponse(value) {
+    var isInstance = true;
+    isInstance = isInstance && "data" in value;
+    return isInstance;
+}
+export function SaveCategoryResponseFromJSON(json) {
+    return SaveCategoryResponseFromJSONTyped(json, false);
+}
+export function SaveCategoryResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'data': SaveCategoryResponseDataFromJSON(json['data']),
+    };
+}
+export function SaveCategoryResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'data': SaveCategoryResponseDataToJSON(value.data),
+    };
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Category } from './Category';
+/**
+ *
+ * @export
+ * @interface SaveCategoryResponseData
+ */
+export interface SaveCategoryResponseData {
+    /**
+     *
+     * @type {Category}
+     * @memberof SaveCategoryResponseData
+     */
+    category: Category;
+    /**
+     * The knowledge of the server
+     * @type {number}
+     * @memberof SaveCategoryResponseData
+     */
+    server_knowledge: number;
+}
+/**
+ * Check if a given object implements the SaveCategoryResponseData interface.
+ */
+export declare function instanceOfSaveCategoryResponseData(value: object): boolean;
+export declare function SaveCategoryResponseDataFromJSON(json: any): SaveCategoryResponseData;
+export declare function SaveCategoryResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SaveCategoryResponseData;
+export declare function SaveCategoryResponseDataToJSON(value?: SaveCategoryResponseData | null): any;

package/dist/esm/models/SaveCategoryResponseData.js

@@ -0,0 +1,47 @@
+/* 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { CategoryFromJSON, CategoryToJSON, } from './Category';
+/**
+ * Check if a given object implements the SaveCategoryResponseData interface.
+ */
+export function instanceOfSaveCategoryResponseData(value) {
+    var isInstance = true;
+    isInstance = isInstance && "category" in value;
+    isInstance = isInstance && "server_knowledge" in value;
+    return isInstance;
+}
+export function SaveCategoryResponseDataFromJSON(json) {
+    return SaveCategoryResponseDataFromJSONTyped(json, false);
+}
+export function SaveCategoryResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'category': CategoryFromJSON(json['category']),
+        'server_knowledge': json['server_knowledge'],
+    };
+}
+export function SaveCategoryResponseDataToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'category': CategoryToJSON(value.category),
+        'server_knowledge': value.server_knowledge,
+    };
+}

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

@@ -0,0 +1,31 @@
+/**
+ * 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SaveMonthCategory
+ */
+export interface SaveMonthCategory {
+    /**
+     * Budgeted amount in milliunits format
+     * @type {number}
+     * @memberof SaveMonthCategory
+     */
+    budgeted: number;
+}
+/**
+ * Check if a given object implements the SaveMonthCategory interface.
+ */
+export declare function instanceOfSaveMonthCategory(value: object): boolean;
+export declare function SaveMonthCategoryFromJSON(json: any): SaveMonthCategory;
+export declare function SaveMonthCategoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): SaveMonthCategory;
+export declare function SaveMonthCategoryToJSON(value?: SaveMonthCategory | null): any;

package/dist/esm/models/SaveMonthCategory.js

@@ -0,0 +1,43 @@
+/* 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the SaveMonthCategory interface.
+ */
+export function instanceOfSaveMonthCategory(value) {
+    var isInstance = true;
+    isInstance = isInstance && "budgeted" in value;
+    return isInstance;
+}
+export function SaveMonthCategoryFromJSON(json) {
+    return SaveMonthCategoryFromJSONTyped(json, false);
+}
+export function SaveMonthCategoryFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'budgeted': json['budgeted'],
+    };
+}
+export function SaveMonthCategoryToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'budgeted': value.budgeted,
+    };
+}

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

@@ -0,0 +1,55 @@
+/**
+ * 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SaveSubTransaction
+ */
+export interface SaveSubTransaction {
+    /**
+     * The subtransaction amount in milliunits format.
+     * @type {number}
+     * @memberof SaveSubTransaction
+     */
+    amount: number;
+    /**
+     * The payee for the subtransaction.
+     * @type {string}
+     * @memberof SaveSubTransaction
+     */
+    payee_id?: string | null;
+    /**
+     * 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 on parent transaction) or (2) a payee with the same name or (3) creation of a new payee.
+     * @type {string}
+     * @memberof SaveSubTransaction
+     */
+    payee_name?: string | null;
+    /**
+     * The category for the subtransaction.  Credit Card Payment categories are not permitted and will be ignored if supplied.
+     * @type {string}
+     * @memberof SaveSubTransaction
+     */
+    category_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SaveSubTransaction
+     */
+    memo?: string | null;
+}
+/**
+ * Check if a given object implements the SaveSubTransaction interface.
+ */
+export declare function instanceOfSaveSubTransaction(value: object): boolean;
+export declare function SaveSubTransactionFromJSON(json: any): SaveSubTransaction;
+export declare function SaveSubTransactionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SaveSubTransaction;
+export declare function SaveSubTransactionToJSON(value?: SaveSubTransaction | null): any;

package/dist/esm/models/SaveSubTransaction.js

@@ -0,0 +1,52 @@
+/* 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { exists } from '../runtime';
+/**
+ * Check if a given object implements the SaveSubTransaction interface.
+ */
+export function instanceOfSaveSubTransaction(value) {
+    var isInstance = true;
+    isInstance = isInstance && "amount" in value;
+    return isInstance;
+}
+export function SaveSubTransactionFromJSON(json) {
+    return SaveSubTransactionFromJSONTyped(json, false);
+}
+export function SaveSubTransactionFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'amount': json['amount'],
+        'payee_id': !exists(json, 'payee_id') ? undefined : json['payee_id'],
+        'payee_name': !exists(json, 'payee_name') ? undefined : json['payee_name'],
+        'category_id': !exists(json, 'category_id') ? undefined : json['category_id'],
+        'memo': !exists(json, 'memo') ? undefined : json['memo'],
+    };
+}
+export function SaveSubTransactionToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'amount': value.amount,
+        'payee_id': value.payee_id,
+        'payee_name': value.payee_name,
+        'category_id': value.category_id,
+        'memo': value.memo,
+    };
+}

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

@@ -0,0 +1,120 @@
+/**
+ * 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { SaveSubTransaction } from './SaveSubTransaction';
+/**
+ *
+ * @export
+ * @interface SaveTransaction
+ */
+export interface SaveTransaction {
+    /**
+     *
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    account_id?: string;
+    /**
+     * The transaction date in ISO format (e.g. 2016-12-01).  Future dates (scheduled transactions) are not permitted.  Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    date?: string;
+    /**
+     * The transaction amount in milliunits format.  Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
+     * @type {number}
+     * @memberof SaveTransaction
+     */
+    amount?: number;
+    /**
+     * The payee for the transaction.  To create a transfer between two accounts, use the account transfer payee pointing to the target account.  Account transfer payees are specified as `tranfer_payee_id` on the account resource.
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    payee_id?: string | null;
+    /**
+     * 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 SaveTransaction
+     */
+    payee_name?: string | null;
+    /**
+     * 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 SaveTransaction
+     */
+    category_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    memo?: string | null;
+    /**
+     * The cleared status of the transaction
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    cleared?: SaveTransactionClearedEnum;
+    /**
+     * Whether or not the transaction is approved.  If not supplied, transaction will be unapproved by default.
+     * @type {boolean}
+     * @memberof SaveTransaction
+     */
+    approved?: boolean;
+    /**
+     * The transaction flag
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    flag_color?: SaveTransactionFlagColorEnum;
+    /**
+     * If specified, the new transaction will be assigned this `import_id` and considered "imported".  We will also attempt to match this imported transaction to an existing "user-entered" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in 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'.  Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a "user-entered" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
+     * @type {string}
+     * @memberof SaveTransaction
+     */
+    import_id?: string | null;
+    /**
+     * An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
+     * @type {Array<SaveSubTransaction>}
+     * @memberof SaveTransaction
+     */
+    subtransactions?: Array<SaveSubTransaction>;
+}
+/**
+ * @export
+ */
+export declare const SaveTransactionClearedEnum: {
+    readonly Cleared: "cleared";
+    readonly Uncleared: "uncleared";
+    readonly Reconciled: "reconciled";
+};
+export declare type SaveTransactionClearedEnum = typeof SaveTransactionClearedEnum[keyof typeof SaveTransactionClearedEnum];
+/**
+ * @export
+ */
+export declare const SaveTransactionFlagColorEnum: {
+    readonly Red: "red";
+    readonly Orange: "orange";
+    readonly Yellow: "yellow";
+    readonly Green: "green";
+    readonly Blue: "blue";
+    readonly Purple: "purple";
+    readonly Null: "null";
+};
+export declare type SaveTransactionFlagColorEnum = typeof SaveTransactionFlagColorEnum[keyof typeof SaveTransactionFlagColorEnum];
+/**
+ * Check if a given object implements the SaveTransaction interface.
+ */
+export declare function instanceOfSaveTransaction(value: object): boolean;
+export declare function SaveTransactionFromJSON(json: any): SaveTransaction;
+export declare function SaveTransactionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SaveTransaction;
+export declare function SaveTransactionToJSON(value?: SaveTransaction | null): any;

package/dist/esm/models/SaveTransaction.js

@@ -0,0 +1,86 @@
+/* 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
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { exists } from '../runtime';
+import { SaveSubTransactionFromJSON, SaveSubTransactionToJSON, } from './SaveSubTransaction';
+/**
+ * @export
+ */
+export var SaveTransactionClearedEnum = {
+    Cleared: 'cleared',
+    Uncleared: 'uncleared',
+    Reconciled: 'reconciled'
+};
+/**
+ * @export
+ */
+export var SaveTransactionFlagColorEnum = {
+    Red: 'red',
+    Orange: 'orange',
+    Yellow: 'yellow',
+    Green: 'green',
+    Blue: 'blue',
+    Purple: 'purple',
+    Null: 'null'
+};
+/**
+ * Check if a given object implements the SaveTransaction interface.
+ */
+export function instanceOfSaveTransaction(value) {
+    var isInstance = true;
+    return isInstance;
+}
+export function SaveTransactionFromJSON(json) {
+    return SaveTransactionFromJSONTyped(json, false);
+}
+export function SaveTransactionFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'account_id': !exists(json, 'account_id') ? undefined : json['account_id'],
+        'date': !exists(json, 'date') ? undefined : json['date'],
+        'amount': !exists(json, 'amount') ? undefined : json['amount'],
+        'payee_id': !exists(json, 'payee_id') ? undefined : json['payee_id'],
+        'payee_name': !exists(json, 'payee_name') ? undefined : json['payee_name'],
+        'category_id': !exists(json, 'category_id') ? undefined : json['category_id'],
+        'memo': !exists(json, 'memo') ? undefined : json['memo'],
+        'cleared': !exists(json, 'cleared') ? undefined : json['cleared'],
+        'approved': !exists(json, 'approved') ? undefined : json['approved'],
+        'flag_color': !exists(json, 'flag_color') ? undefined : json['flag_color'],
+        'import_id': !exists(json, 'import_id') ? undefined : json['import_id'],
+        'subtransactions': !exists(json, 'subtransactions') ? undefined : (json['subtransactions'].map(SaveSubTransactionFromJSON)),
+    };
+}
+export function SaveTransactionToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'account_id': value.account_id,
+        'date': value.date,
+        'amount': value.amount,
+        'payee_id': value.payee_id,
+        'payee_name': value.payee_name,
+        'category_id': value.category_id,
+        'memo': value.memo,
+        'cleared': value.cleared,
+        'approved': value.approved,
+        'flag_color': value.flag_color,
+        'import_id': value.import_id,
+        'subtransactions': value.subtransactions === undefined ? undefined : (value.subtransactions.map(SaveSubTransactionToJSON)),
+    };
+}