ynab 1.55.0 → 2.0.0-rc.0

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

@@ -0,0 +1,208 @@
+/**
+ * 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 HybridTransaction
+ */
+export interface HybridTransaction {
+    /**
+     *
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    id: string;
+    /**
+     * The transaction date in ISO format (e.g. 2016-12-01)
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    date: string;
+    /**
+     * The transaction amount in milliunits format
+     * @type {number}
+     * @memberof HybridTransaction
+     */
+    amount: number;
+    /**
+     *
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    memo?: string | null;
+    /**
+     * The cleared status of the transaction
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    cleared: HybridTransactionClearedEnum;
+    /**
+     * Whether or not the transaction is approved
+     * @type {boolean}
+     * @memberof HybridTransaction
+     */
+    approved: boolean;
+    /**
+     * The transaction flag
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    flag_color?: HybridTransactionFlagColorEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    account_id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    payee_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    category_id?: string | null;
+    /**
+     * If a transfer transaction, the account to which it transfers
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    transfer_account_id?: string | null;
+    /**
+     * If a transfer transaction, the id of transaction on the other side of the transfer
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    transfer_transaction_id?: string | null;
+    /**
+     * If transaction is matched, the id of the matched transaction
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    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 HybridTransaction
+     */
+    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 HybridTransaction
+     */
+    import_payee_name?: string | null;
+    /**
+     * If the transaction was imported, the original payee name as it appeared on the statement
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    import_payee_name_original?: string | null;
+    /**
+     * If the transaction is a debt/loan account transaction, the type of transaction
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    debt_transaction_type?: HybridTransactionDebtTransactionTypeEnum;
+    /**
+     * Whether or not the transaction has been deleted.  Deleted transactions will only be included in delta requests.
+     * @type {boolean}
+     * @memberof HybridTransaction
+     */
+    deleted: boolean;
+    /**
+     * Whether the hybrid transaction represents a regular transaction or a subtransaction
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    type: HybridTransactionTypeEnum;
+    /**
+     * For subtransaction types, this is the id of the parent transaction.  For transaction types, this id will be always be null.
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    parent_transaction_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    account_name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    payee_name?: string | null;
+    /**
+     * The name of the category.  If a split transaction, this will be 'Split'.
+     * @type {string}
+     * @memberof HybridTransaction
+     */
+    category_name?: string;
+}
+/**
+ * @export
+ */
+export declare const HybridTransactionClearedEnum: {
+    readonly Cleared: "cleared";
+    readonly Uncleared: "uncleared";
+    readonly Reconciled: "reconciled";
+};
+export declare type HybridTransactionClearedEnum = typeof HybridTransactionClearedEnum[keyof typeof HybridTransactionClearedEnum];
+/**
+ * @export
+ */
+export declare const HybridTransactionFlagColorEnum: {
+    readonly Red: "red";
+    readonly Orange: "orange";
+    readonly Yellow: "yellow";
+    readonly Green: "green";
+    readonly Blue: "blue";
+    readonly Purple: "purple";
+    readonly Null: "null";
+};
+export declare type HybridTransactionFlagColorEnum = typeof HybridTransactionFlagColorEnum[keyof typeof HybridTransactionFlagColorEnum];
+/**
+ * @export
+ */
+export declare const HybridTransactionDebtTransactionTypeEnum: {
+    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 HybridTransactionDebtTransactionTypeEnum = typeof HybridTransactionDebtTransactionTypeEnum[keyof typeof HybridTransactionDebtTransactionTypeEnum];
+/**
+ * @export
+ */
+export declare const HybridTransactionTypeEnum: {
+    readonly Transaction: "transaction";
+    readonly Subtransaction: "subtransaction";
+};
+export declare type HybridTransactionTypeEnum = typeof HybridTransactionTypeEnum[keyof typeof HybridTransactionTypeEnum];
+/**
+ * Check if a given object implements the HybridTransaction interface.
+ */
+export declare function instanceOfHybridTransaction(value: object): boolean;
+export declare function HybridTransactionFromJSON(json: any): HybridTransaction;
+export declare function HybridTransactionFromJSONTyped(json: any, ignoreDiscriminator: boolean): HybridTransaction;
+export declare function HybridTransactionToJSON(value?: HybridTransaction | null): any;

package/dist/esm/models/HybridTransaction.js

@@ -0,0 +1,137 @@
+/* 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';
+/**
+ * @export
+ */
+export var HybridTransactionClearedEnum = {
+    Cleared: 'cleared',
+    Uncleared: 'uncleared',
+    Reconciled: 'reconciled'
+};
+/**
+ * @export
+ */
+export var HybridTransactionFlagColorEnum = {
+    Red: 'red',
+    Orange: 'orange',
+    Yellow: 'yellow',
+    Green: 'green',
+    Blue: 'blue',
+    Purple: 'purple',
+    Null: 'null'
+};
+/**
+ * @export
+ */
+export var HybridTransactionDebtTransactionTypeEnum = {
+    Payment: 'payment',
+    Refund: 'refund',
+    Fee: 'fee',
+    Interest: 'interest',
+    Escrow: 'escrow',
+    BalancedAdjustment: 'balancedAdjustment',
+    Credit: 'credit',
+    Charge: 'charge',
+    Null: 'null'
+};
+/**
+ * @export
+ */
+export var HybridTransactionTypeEnum = {
+    Transaction: 'transaction',
+    Subtransaction: 'subtransaction'
+};
+/**
+ * Check if a given object implements the HybridTransaction interface.
+ */
+export function instanceOfHybridTransaction(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 && "type" in value;
+    isInstance = isInstance && "account_name" in value;
+    return isInstance;
+}
+export function HybridTransactionFromJSON(json) {
+    return HybridTransactionFromJSONTyped(json, false);
+}
+export function HybridTransactionFromJSONTyped(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'],
+        'type': json['type'],
+        'parent_transaction_id': !exists(json, 'parent_transaction_id') ? undefined : json['parent_transaction_id'],
+        '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'],
+    };
+}
+export function HybridTransactionToJSON(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,
+        'type': value.type,
+        'parent_transaction_id': value.parent_transaction_id,
+        'account_name': value.account_name,
+        'payee_name': value.payee_name,
+        'category_name': value.category_name,
+    };
+}

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

@@ -0,0 +1,63 @@
+/**
+ * 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 HybridTransactionAllOf
+ */
+export interface HybridTransactionAllOf {
+    /**
+     * Whether the hybrid transaction represents a regular transaction or a subtransaction
+     * @type {string}
+     * @memberof HybridTransactionAllOf
+     */
+    type: HybridTransactionAllOfTypeEnum;
+    /**
+     * For subtransaction types, this is the id of the parent transaction.  For transaction types, this id will be always be null.
+     * @type {string}
+     * @memberof HybridTransactionAllOf
+     */
+    parent_transaction_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof HybridTransactionAllOf
+     */
+    account_name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HybridTransactionAllOf
+     */
+    payee_name?: string | null;
+    /**
+     * The name of the category.  If a split transaction, this will be 'Split'.
+     * @type {string}
+     * @memberof HybridTransactionAllOf
+     */
+    category_name?: string;
+}
+/**
+ * @export
+ */
+export declare const HybridTransactionAllOfTypeEnum: {
+    readonly Transaction: "transaction";
+    readonly Subtransaction: "subtransaction";
+};
+export declare type HybridTransactionAllOfTypeEnum = typeof HybridTransactionAllOfTypeEnum[keyof typeof HybridTransactionAllOfTypeEnum];
+/**
+ * Check if a given object implements the HybridTransactionAllOf interface.
+ */
+export declare function instanceOfHybridTransactionAllOf(value: object): boolean;
+export declare function HybridTransactionAllOfFromJSON(json: any): HybridTransactionAllOf;
+export declare function HybridTransactionAllOfFromJSONTyped(json: any, ignoreDiscriminator: boolean): HybridTransactionAllOf;
+export declare function HybridTransactionAllOfToJSON(value?: HybridTransactionAllOf | null): any;

package/dist/esm/models/HybridTransactionAllOf.js

@@ -0,0 +1,60 @@
+/* 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';
+/**
+ * @export
+ */
+export var HybridTransactionAllOfTypeEnum = {
+    Transaction: 'transaction',
+    Subtransaction: 'subtransaction'
+};
+/**
+ * Check if a given object implements the HybridTransactionAllOf interface.
+ */
+export function instanceOfHybridTransactionAllOf(value) {
+    var isInstance = true;
+    isInstance = isInstance && "type" in value;
+    isInstance = isInstance && "account_name" in value;
+    return isInstance;
+}
+export function HybridTransactionAllOfFromJSON(json) {
+    return HybridTransactionAllOfFromJSONTyped(json, false);
+}
+export function HybridTransactionAllOfFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'type': json['type'],
+        'parent_transaction_id': !exists(json, 'parent_transaction_id') ? undefined : json['parent_transaction_id'],
+        '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'],
+    };
+}
+export function HybridTransactionAllOfToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'type': value.type,
+        'parent_transaction_id': value.parent_transaction_id,
+        'account_name': value.account_name,
+        'payee_name': value.payee_name,
+        'category_name': value.category_name,
+    };
+}

package/dist/esm/models/HybridTransactionsResponse.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 { HybridTransactionsResponseData } from './HybridTransactionsResponseData';
+/**
+ *
+ * @export
+ * @interface HybridTransactionsResponse
+ */
+export interface HybridTransactionsResponse {
+    /**
+     *
+     * @type {HybridTransactionsResponseData}
+     * @memberof HybridTransactionsResponse
+     */
+    data: HybridTransactionsResponseData;
+}
+/**
+ * Check if a given object implements the HybridTransactionsResponse interface.
+ */
+export declare function instanceOfHybridTransactionsResponse(value: object): boolean;
+export declare function HybridTransactionsResponseFromJSON(json: any): HybridTransactionsResponse;
+export declare function HybridTransactionsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): HybridTransactionsResponse;
+export declare function HybridTransactionsResponseToJSON(value?: HybridTransactionsResponse | null): any;

package/dist/esm/models/HybridTransactionsResponse.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 { HybridTransactionsResponseDataFromJSON, HybridTransactionsResponseDataToJSON, } from './HybridTransactionsResponseData';
+/**
+ * Check if a given object implements the HybridTransactionsResponse interface.
+ */
+export function instanceOfHybridTransactionsResponse(value) {
+    var isInstance = true;
+    isInstance = isInstance && "data" in value;
+    return isInstance;
+}
+export function HybridTransactionsResponseFromJSON(json) {
+    return HybridTransactionsResponseFromJSONTyped(json, false);
+}
+export function HybridTransactionsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'data': HybridTransactionsResponseDataFromJSON(json['data']),
+    };
+}
+export function HybridTransactionsResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'data': HybridTransactionsResponseDataToJSON(value.data),
+    };
+}

package/dist/esm/models/HybridTransactionsResponseData.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 { HybridTransaction } from './HybridTransaction';
+/**
+ *
+ * @export
+ * @interface HybridTransactionsResponseData
+ */
+export interface HybridTransactionsResponseData {
+    /**
+     *
+     * @type {Array<HybridTransaction>}
+     * @memberof HybridTransactionsResponseData
+     */
+    transactions: Array<HybridTransaction>;
+    /**
+     * The knowledge of the server
+     * @type {number}
+     * @memberof HybridTransactionsResponseData
+     */
+    server_knowledge?: number;
+}
+/**
+ * Check if a given object implements the HybridTransactionsResponseData interface.
+ */
+export declare function instanceOfHybridTransactionsResponseData(value: object): boolean;
+export declare function HybridTransactionsResponseDataFromJSON(json: any): HybridTransactionsResponseData;
+export declare function HybridTransactionsResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): HybridTransactionsResponseData;
+export declare function HybridTransactionsResponseDataToJSON(value?: HybridTransactionsResponseData | null): any;

package/dist/esm/models/HybridTransactionsResponseData.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 { exists } from '../runtime';
+import { HybridTransactionFromJSON, HybridTransactionToJSON, } from './HybridTransaction';
+/**
+ * Check if a given object implements the HybridTransactionsResponseData interface.
+ */
+export function instanceOfHybridTransactionsResponseData(value) {
+    var isInstance = true;
+    isInstance = isInstance && "transactions" in value;
+    return isInstance;
+}
+export function HybridTransactionsResponseDataFromJSON(json) {
+    return HybridTransactionsResponseDataFromJSONTyped(json, false);
+}
+export function HybridTransactionsResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'transactions': (json['transactions'].map(HybridTransactionFromJSON)),
+        'server_knowledge': !exists(json, 'server_knowledge') ? undefined : json['server_knowledge'],
+    };
+}
+export function HybridTransactionsResponseDataToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'transactions': (value.transactions.map(HybridTransactionToJSON)),
+        'server_knowledge': value.server_knowledge,
+    };
+}