ynab 1.55.0 → 2.0.0-rc.0

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

@@ -0,0 +1,195 @@
+/**
+ * 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 { SubTransaction } from './SubTransaction';
+/**
+ *
+ * @export
+ * @interface TransactionDetail
+ */
+export interface TransactionDetail {
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    id: string;
+    /**
+     * The transaction date in ISO format (e.g. 2016-12-01)
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    date: string;
+    /**
+     * The transaction amount in milliunits format
+     * @type {number}
+     * @memberof TransactionDetail
+     */
+    amount: number;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    memo?: string | null;
+    /**
+     * The cleared status of the transaction
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    cleared: TransactionDetailClearedEnum;
+    /**
+     * Whether or not the transaction is approved
+     * @type {boolean}
+     * @memberof TransactionDetail
+     */
+    approved: boolean;
+    /**
+     * The transaction flag
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    flag_color?: TransactionDetailFlagColorEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    account_id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    payee_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    category_id?: string | null;
+    /**
+     * If a transfer transaction, the account to which it transfers
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    transfer_account_id?: string | null;
+    /**
+     * If a transfer transaction, the id of transaction on the other side of the transfer
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    transfer_transaction_id?: string | null;
+    /**
+     * If transaction is matched, the id of the matched transaction
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    matched_transaction_id?: string | null;
+    /**
+     * If the transaction was imported, this field is a unique (by account) import identifier.  If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'.  For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'.  If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    import_id?: string | null;
+    /**
+     * If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    import_payee_name?: string | null;
+    /**
+     * If the transaction was imported, the original payee name as it appeared on the statement
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    import_payee_name_original?: string | null;
+    /**
+     * If the transaction is a debt/loan account transaction, the type of transaction
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    debt_transaction_type?: TransactionDetailDebtTransactionTypeEnum;
+    /**
+     * Whether or not the transaction has been deleted.  Deleted transactions will only be included in delta requests.
+     * @type {boolean}
+     * @memberof TransactionDetail
+     */
+    deleted: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    account_name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    payee_name?: string | null;
+    /**
+     * The name of the category.  If a split transaction, this will be 'Split'.
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    category_name?: string | null;
+    /**
+     * If a split transaction, the subtransactions.
+     * @type {Array<SubTransaction>}
+     * @memberof TransactionDetail
+     */
+    subtransactions: Array<SubTransaction>;
+}
+/**
+ * @export
+ */
+export declare const TransactionDetailClearedEnum: {
+    readonly Cleared: "cleared";
+    readonly Uncleared: "uncleared";
+    readonly Reconciled: "reconciled";
+};
+export declare type TransactionDetailClearedEnum = typeof TransactionDetailClearedEnum[keyof typeof TransactionDetailClearedEnum];
+/**
+ * @export
+ */
+export declare const TransactionDetailFlagColorEnum: {
+    readonly Red: "red";
+    readonly Orange: "orange";
+    readonly Yellow: "yellow";
+    readonly Green: "green";
+    readonly Blue: "blue";
+    readonly Purple: "purple";
+    readonly Null: "null";
+};
+export declare type TransactionDetailFlagColorEnum = typeof TransactionDetailFlagColorEnum[keyof typeof TransactionDetailFlagColorEnum];
+/**
+ * @export
+ */
+export declare const TransactionDetailDebtTransactionTypeEnum: {
+    readonly Payment: "payment";
+    readonly Refund: "refund";
+    readonly Fee: "fee";
+    readonly Interest: "interest";
+    readonly Escrow: "escrow";
+    readonly BalancedAdjustment: "balancedAdjustment";
+    readonly Credit: "credit";
+    readonly Charge: "charge";
+    readonly Null: "null";
+};
+export declare type TransactionDetailDebtTransactionTypeEnum = typeof TransactionDetailDebtTransactionTypeEnum[keyof typeof TransactionDetailDebtTransactionTypeEnum];
+/**
+ * Check if a given object implements the TransactionDetail interface.
+ */
+export declare function instanceOfTransactionDetail(value: object): boolean;
+export declare function TransactionDetailFromJSON(json: any): TransactionDetail;
+export declare function TransactionDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionDetail;
+export declare function TransactionDetailToJSON(value?: TransactionDetail | null): any;

package/dist/esm/models/TransactionDetail.js

@@ -0,0 +1,129 @@
+/* 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 { SubTransactionFromJSON, SubTransactionToJSON, } from './SubTransaction';
+/**
+ * @export
+ */
+export var TransactionDetailClearedEnum = {
+    Cleared: 'cleared',
+    Uncleared: 'uncleared',
+    Reconciled: 'reconciled'
+};
+/**
+ * @export
+ */
+export var TransactionDetailFlagColorEnum = {
+    Red: 'red',
+    Orange: 'orange',
+    Yellow: 'yellow',
+    Green: 'green',
+    Blue: 'blue',
+    Purple: 'purple',
+    Null: 'null'
+};
+/**
+ * @export
+ */
+export var TransactionDetailDebtTransactionTypeEnum = {
+    Payment: 'payment',
+    Refund: 'refund',
+    Fee: 'fee',
+    Interest: 'interest',
+    Escrow: 'escrow',
+    BalancedAdjustment: 'balancedAdjustment',
+    Credit: 'credit',
+    Charge: 'charge',
+    Null: 'null'
+};
+/**
+ * Check if a given object implements the TransactionDetail interface.
+ */
+export function instanceOfTransactionDetail(value) {
+    var isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "date" in value;
+    isInstance = isInstance && "amount" in value;
+    isInstance = isInstance && "cleared" in value;
+    isInstance = isInstance && "approved" in value;
+    isInstance = isInstance && "account_id" in value;
+    isInstance = isInstance && "deleted" in value;
+    isInstance = isInstance && "account_name" in value;
+    isInstance = isInstance && "subtransactions" in value;
+    return isInstance;
+}
+export function TransactionDetailFromJSON(json) {
+    return TransactionDetailFromJSONTyped(json, false);
+}
+export function TransactionDetailFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'date': json['date'],
+        'amount': json['amount'],
+        'memo': !exists(json, 'memo') ? undefined : json['memo'],
+        'cleared': json['cleared'],
+        'approved': json['approved'],
+        'flag_color': !exists(json, 'flag_color') ? undefined : json['flag_color'],
+        'account_id': json['account_id'],
+        'payee_id': !exists(json, 'payee_id') ? undefined : json['payee_id'],
+        'category_id': !exists(json, 'category_id') ? undefined : json['category_id'],
+        'transfer_account_id': !exists(json, 'transfer_account_id') ? undefined : json['transfer_account_id'],
+        'transfer_transaction_id': !exists(json, 'transfer_transaction_id') ? undefined : json['transfer_transaction_id'],
+        'matched_transaction_id': !exists(json, 'matched_transaction_id') ? undefined : json['matched_transaction_id'],
+        'import_id': !exists(json, 'import_id') ? undefined : json['import_id'],
+        'import_payee_name': !exists(json, 'import_payee_name') ? undefined : json['import_payee_name'],
+        'import_payee_name_original': !exists(json, 'import_payee_name_original') ? undefined : json['import_payee_name_original'],
+        'debt_transaction_type': !exists(json, 'debt_transaction_type') ? undefined : json['debt_transaction_type'],
+        'deleted': json['deleted'],
+        'account_name': json['account_name'],
+        'payee_name': !exists(json, 'payee_name') ? undefined : json['payee_name'],
+        'category_name': !exists(json, 'category_name') ? undefined : json['category_name'],
+        'subtransactions': (json['subtransactions'].map(SubTransactionFromJSON)),
+    };
+}
+export function TransactionDetailToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'date': value.date,
+        'amount': value.amount,
+        'memo': value.memo,
+        'cleared': value.cleared,
+        'approved': value.approved,
+        'flag_color': value.flag_color,
+        'account_id': value.account_id,
+        'payee_id': value.payee_id,
+        'category_id': value.category_id,
+        'transfer_account_id': value.transfer_account_id,
+        'transfer_transaction_id': value.transfer_transaction_id,
+        'matched_transaction_id': value.matched_transaction_id,
+        'import_id': value.import_id,
+        'import_payee_name': value.import_payee_name,
+        'import_payee_name_original': value.import_payee_name_original,
+        'debt_transaction_type': value.debt_transaction_type,
+        'deleted': value.deleted,
+        'account_name': value.account_name,
+        'payee_name': value.payee_name,
+        'category_name': value.category_name,
+        'subtransactions': (value.subtransactions.map(SubTransactionToJSON)),
+    };
+}

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

@@ -0,0 +1,50 @@
+/**
+ * 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 { SubTransaction } from './SubTransaction';
+/**
+ *
+ * @export
+ * @interface TransactionDetailAllOf
+ */
+export interface TransactionDetailAllOf {
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionDetailAllOf
+     */
+    account_name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionDetailAllOf
+     */
+    payee_name?: string | null;
+    /**
+     * The name of the category.  If a split transaction, this will be 'Split'.
+     * @type {string}
+     * @memberof TransactionDetailAllOf
+     */
+    category_name?: string | null;
+    /**
+     * If a split transaction, the subtransactions.
+     * @type {Array<SubTransaction>}
+     * @memberof TransactionDetailAllOf
+     */
+    subtransactions: Array<SubTransaction>;
+}
+/**
+ * Check if a given object implements the TransactionDetailAllOf interface.
+ */
+export declare function instanceOfTransactionDetailAllOf(value: object): boolean;
+export declare function TransactionDetailAllOfFromJSON(json: any): TransactionDetailAllOf;
+export declare function TransactionDetailAllOfFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionDetailAllOf;
+export declare function TransactionDetailAllOfToJSON(value?: TransactionDetailAllOf | null): any;

package/dist/esm/models/TransactionDetailAllOf.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';
+import { SubTransactionFromJSON, SubTransactionToJSON, } from './SubTransaction';
+/**
+ * Check if a given object implements the TransactionDetailAllOf interface.
+ */
+export function instanceOfTransactionDetailAllOf(value) {
+    var isInstance = true;
+    isInstance = isInstance && "account_name" in value;
+    isInstance = isInstance && "subtransactions" in value;
+    return isInstance;
+}
+export function TransactionDetailAllOfFromJSON(json) {
+    return TransactionDetailAllOfFromJSONTyped(json, false);
+}
+export function TransactionDetailAllOfFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'account_name': json['account_name'],
+        'payee_name': !exists(json, 'payee_name') ? undefined : json['payee_name'],
+        'category_name': !exists(json, 'category_name') ? undefined : json['category_name'],
+        'subtransactions': (json['subtransactions'].map(SubTransactionFromJSON)),
+    };
+}
+export function TransactionDetailAllOfToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'account_name': value.account_name,
+        'payee_name': value.payee_name,
+        'category_name': value.category_name,
+        'subtransactions': (value.subtransactions.map(SubTransactionToJSON)),
+    };
+}

package/dist/esm/models/TransactionResponse.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 { TransactionResponseData } from './TransactionResponseData';
+/**
+ *
+ * @export
+ * @interface TransactionResponse
+ */
+export interface TransactionResponse {
+    /**
+     *
+     * @type {TransactionResponseData}
+     * @memberof TransactionResponse
+     */
+    data: TransactionResponseData;
+}
+/**
+ * Check if a given object implements the TransactionResponse interface.
+ */
+export declare function instanceOfTransactionResponse(value: object): boolean;
+export declare function TransactionResponseFromJSON(json: any): TransactionResponse;
+export declare function TransactionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionResponse;
+export declare function TransactionResponseToJSON(value?: TransactionResponse | null): any;

package/dist/esm/models/TransactionResponse.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 { TransactionResponseDataFromJSON, TransactionResponseDataToJSON, } from './TransactionResponseData';
+/**
+ * Check if a given object implements the TransactionResponse interface.
+ */
+export function instanceOfTransactionResponse(value) {
+    var isInstance = true;
+    isInstance = isInstance && "data" in value;
+    return isInstance;
+}
+export function TransactionResponseFromJSON(json) {
+    return TransactionResponseFromJSONTyped(json, false);
+}
+export function TransactionResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'data': TransactionResponseDataFromJSON(json['data']),
+    };
+}
+export function TransactionResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'data': TransactionResponseDataToJSON(value.data),
+    };
+}

package/dist/esm/models/TransactionResponseData.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 { TransactionDetail } from './TransactionDetail';
+/**
+ *
+ * @export
+ * @interface TransactionResponseData
+ */
+export interface TransactionResponseData {
+    /**
+     *
+     * @type {TransactionDetail}
+     * @memberof TransactionResponseData
+     */
+    transaction: TransactionDetail;
+}
+/**
+ * Check if a given object implements the TransactionResponseData interface.
+ */
+export declare function instanceOfTransactionResponseData(value: object): boolean;
+export declare function TransactionResponseDataFromJSON(json: any): TransactionResponseData;
+export declare function TransactionResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionResponseData;
+export declare function TransactionResponseDataToJSON(value?: TransactionResponseData | null): any;

package/dist/esm/models/TransactionResponseData.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 { TransactionDetailFromJSON, TransactionDetailToJSON, } from './TransactionDetail';
+/**
+ * Check if a given object implements the TransactionResponseData interface.
+ */
+export function instanceOfTransactionResponseData(value) {
+    var isInstance = true;
+    isInstance = isInstance && "transaction" in value;
+    return isInstance;
+}
+export function TransactionResponseDataFromJSON(json) {
+    return TransactionResponseDataFromJSONTyped(json, false);
+}
+export function TransactionResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'transaction': TransactionDetailFromJSON(json['transaction']),
+    };
+}
+export function TransactionResponseDataToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'transaction': TransactionDetailToJSON(value.transaction),
+    };
+}