ynab 3.1.0 → 4.1.0

package/dist/esm/models/ScheduledTransactionSummaryBase.js

@@ -0,0 +1,94 @@
+/* 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 { TransactionFlagColorFromJSON, TransactionFlagColorToJSON, } from './TransactionFlagColor';
+/**
+ * @export
+ */
+export var ScheduledTransactionSummaryBaseFrequencyEnum = {
+    Never: 'never',
+    Daily: 'daily',
+    Weekly: 'weekly',
+    EveryOtherWeek: 'everyOtherWeek',
+    TwiceAMonth: 'twiceAMonth',
+    Every4Weeks: 'every4Weeks',
+    Monthly: 'monthly',
+    EveryOtherMonth: 'everyOtherMonth',
+    Every3Months: 'every3Months',
+    Every4Months: 'every4Months',
+    TwiceAYear: 'twiceAYear',
+    Yearly: 'yearly',
+    EveryOtherYear: 'everyOtherYear'
+};
+/**
+ * Check if a given object implements the ScheduledTransactionSummaryBase interface.
+ */
+export function instanceOfScheduledTransactionSummaryBase(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('date_first' in value) || value['date_first'] === undefined)
+        return false;
+    if (!('date_next' in value) || value['date_next'] === undefined)
+        return false;
+    if (!('frequency' in value) || value['frequency'] === undefined)
+        return false;
+    if (!('amount' in value) || value['amount'] === undefined)
+        return false;
+    if (!('account_id' in value) || value['account_id'] === undefined)
+        return false;
+    if (!('deleted' in value) || value['deleted'] === undefined)
+        return false;
+    return true;
+}
+export function ScheduledTransactionSummaryBaseFromJSON(json) {
+    return ScheduledTransactionSummaryBaseFromJSONTyped(json, false);
+}
+export function ScheduledTransactionSummaryBaseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'date_first': json['date_first'],
+        'date_next': json['date_next'],
+        'frequency': json['frequency'],
+        'amount': json['amount'],
+        'memo': json['memo'] == null ? undefined : json['memo'],
+        'flag_color': json['flag_color'] == null ? undefined : TransactionFlagColorFromJSON(json['flag_color']),
+        'flag_name': json['flag_name'] == null ? undefined : json['flag_name'],
+        'account_id': json['account_id'],
+        'payee_id': json['payee_id'] == null ? undefined : json['payee_id'],
+        'category_id': json['category_id'] == null ? undefined : json['category_id'],
+        'transfer_account_id': json['transfer_account_id'] == null ? undefined : json['transfer_account_id'],
+        'deleted': json['deleted'],
+    };
+}
+export function ScheduledTransactionSummaryBaseToJSON(json) {
+    return ScheduledTransactionSummaryBaseToJSONTyped(json, false);
+}
+export function ScheduledTransactionSummaryBaseToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'date_first': value['date_first'],
+        'date_next': value['date_next'],
+        'frequency': value['frequency'],
+        'amount': value['amount'],
+        'memo': value['memo'],
+        'flag_color': TransactionFlagColorToJSON(value['flag_color']),
+        'flag_name': value['flag_name'],
+        'account_id': value['account_id'],
+        'payee_id': value['payee_id'],
+        'category_id': value['category_id'],
+        'transfer_account_id': value['transfer_account_id'],
+        'deleted': value['deleted'],
+    };
+}

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

@@ -33,49 +33,61 @@ export interface SubTransaction {
      * @type {string}
      * @memberof SubTransaction
      */
-    memo?: string | null;
+    memo?: string;
     /**
      *
      * @type {string}
      * @memberof SubTransaction
      */
-    payee_id?: string | null;
+    payee_id?: string;
     /**
      *
      * @type {string}
      * @memberof SubTransaction
      */
-    payee_name?: string | null;
+    payee_name?: string;
     /**
      *
      * @type {string}
      * @memberof SubTransaction
      */
-    category_id?: string | null;
+    category_id?: string;
     /**
      *
      * @type {string}
      * @memberof SubTransaction
      */
-    category_name?: string | null;
+    category_name?: string;
     /**
      * If a transfer, the account_id which the subtransaction transfers to
      * @type {string}
      * @memberof SubTransaction
      */
-    transfer_account_id?: string | null;
+    transfer_account_id?: string;
     /**
      * If a transfer, the id of transaction on the other side of the transfer
      * @type {string}
      * @memberof SubTransaction
      */
-    transfer_transaction_id?: string | null;
+    transfer_transaction_id?: string;
     /**
      * Whether or not the subtransaction has been deleted.  Deleted subtransactions will only be included in delta requests.
      * @type {boolean}
      * @memberof SubTransaction
      */
     deleted: boolean;
+    /**
+     * The subtransaction amount formatted in the plan's currency format
+     * @type {string}
+     * @memberof SubTransaction
+     */
+    amount_formatted?: string;
+    /**
+     * The subtransaction amount as a decimal currency amount
+     * @type {number}
+     * @memberof SubTransaction
+     */
+    amount_currency?: number;
 }
 /**
  * Check if a given object implements the SubTransaction interface.

package/dist/esm/models/SubTransaction.js

@@ -39,6 +39,8 @@ export function SubTransactionFromJSONTyped(json, ignoreDiscriminator) {
         'transfer_account_id': json['transfer_account_id'] == null ? undefined : json['transfer_account_id'],
         'transfer_transaction_id': json['transfer_transaction_id'] == null ? undefined : json['transfer_transaction_id'],
         'deleted': json['deleted'],
+        'amount_formatted': json['amount_formatted'] == null ? undefined : json['amount_formatted'],
+        'amount_currency': json['amount_currency'] == null ? undefined : json['amount_currency'],
     };
 }
 export function SubTransactionToJSON(json) {
@@ -61,5 +63,7 @@ export function SubTransactionToJSONTyped(value, ignoreDiscriminator) {
         'transfer_account_id': value['transfer_account_id'],
         'transfer_transaction_id': value['transfer_transaction_id'],
         'deleted': value['deleted'],
+        'amount_formatted': value['amount_formatted'],
+        'amount_currency': value['amount_currency'],
     };
 }

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

@@ -0,0 +1,87 @@
+/**
+ * YNAB API Endpoints
+ * Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+/**
+ *
+ * @export
+ * @interface SubTransactionBase
+ */
+export interface SubTransactionBase {
+    /**
+     *
+     * @type {string}
+     * @memberof SubTransactionBase
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SubTransactionBase
+     */
+    transaction_id: string;
+    /**
+     * The subtransaction amount in milliunits format
+     * @type {number}
+     * @memberof SubTransactionBase
+     */
+    amount: number;
+    /**
+     *
+     * @type {string}
+     * @memberof SubTransactionBase
+     */
+    memo?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SubTransactionBase
+     */
+    payee_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SubTransactionBase
+     */
+    payee_name?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SubTransactionBase
+     */
+    category_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SubTransactionBase
+     */
+    category_name?: string | null;
+    /**
+     * If a transfer, the account_id which the subtransaction transfers to
+     * @type {string}
+     * @memberof SubTransactionBase
+     */
+    transfer_account_id?: string | null;
+    /**
+     * If a transfer, the id of transaction on the other side of the transfer
+     * @type {string}
+     * @memberof SubTransactionBase
+     */
+    transfer_transaction_id?: string | null;
+    /**
+     * Whether or not the subtransaction has been deleted.  Deleted subtransactions will only be included in delta requests.
+     * @type {boolean}
+     * @memberof SubTransactionBase
+     */
+    deleted: boolean;
+}
+/**
+ * Check if a given object implements the SubTransactionBase interface.
+ */
+export declare function instanceOfSubTransactionBase(value: object): value is SubTransactionBase;
+export declare function SubTransactionBaseFromJSON(json: any): SubTransactionBase;
+export declare function SubTransactionBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubTransactionBase;
+export declare function SubTransactionBaseToJSON(json: any): SubTransactionBase;
+export declare function SubTransactionBaseToJSONTyped(value?: SubTransactionBase | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SubTransactionBase.js

@@ -0,0 +1,65 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * YNAB API Endpoints
+ * Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+/**
+ * Check if a given object implements the SubTransactionBase interface.
+ */
+export function instanceOfSubTransactionBase(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('transaction_id' in value) || value['transaction_id'] === undefined)
+        return false;
+    if (!('amount' in value) || value['amount'] === undefined)
+        return false;
+    if (!('deleted' in value) || value['deleted'] === undefined)
+        return false;
+    return true;
+}
+export function SubTransactionBaseFromJSON(json) {
+    return SubTransactionBaseFromJSONTyped(json, false);
+}
+export function SubTransactionBaseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'transaction_id': json['transaction_id'],
+        'amount': json['amount'],
+        'memo': json['memo'] == null ? undefined : json['memo'],
+        'payee_id': json['payee_id'] == null ? undefined : json['payee_id'],
+        'payee_name': json['payee_name'] == null ? undefined : json['payee_name'],
+        'category_id': json['category_id'] == null ? undefined : json['category_id'],
+        'category_name': json['category_name'] == null ? undefined : json['category_name'],
+        'transfer_account_id': json['transfer_account_id'] == null ? undefined : json['transfer_account_id'],
+        'transfer_transaction_id': json['transfer_transaction_id'] == null ? undefined : json['transfer_transaction_id'],
+        'deleted': json['deleted'],
+    };
+}
+export function SubTransactionBaseToJSON(json) {
+    return SubTransactionBaseToJSONTyped(json, false);
+}
+export function SubTransactionBaseToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'transaction_id': value['transaction_id'],
+        'amount': value['amount'],
+        'memo': value['memo'],
+        'payee_id': value['payee_id'],
+        'payee_name': value['payee_name'],
+        'category_id': value['category_id'],
+        'category_name': value['category_name'],
+        'transfer_account_id': value['transfer_account_id'],
+        'transfer_transaction_id': value['transfer_transaction_id'],
+        'deleted': value['deleted'],
+    };
+}

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

@@ -127,6 +127,18 @@ export interface TransactionDetail {
      * @memberof TransactionDetail
      */
     deleted: boolean;
+    /**
+     * The transaction amount formatted in the plan's currency format
+     * @type {string}
+     * @memberof TransactionDetail
+     */
+    amount_formatted?: string;
+    /**
+     * The transaction amount as a decimal currency amount
+     * @type {number}
+     * @memberof TransactionDetail
+     */
+    amount_currency?: number;
     /**
      *
      * @type {string}

package/dist/esm/models/TransactionDetail.js

@@ -73,6 +73,8 @@ export function TransactionDetailFromJSONTyped(json, ignoreDiscriminator) {
         'import_payee_name_original': json['import_payee_name_original'] == null ? undefined : json['import_payee_name_original'],
         'debt_transaction_type': json['debt_transaction_type'] == null ? undefined : json['debt_transaction_type'],
         'deleted': json['deleted'],
+        'amount_formatted': json['amount_formatted'] == null ? undefined : json['amount_formatted'],
+        'amount_currency': json['amount_currency'] == null ? undefined : json['amount_currency'],
         'account_name': json['account_name'],
         'payee_name': json['payee_name'] == null ? undefined : json['payee_name'],
         'category_name': json['category_name'] == null ? undefined : json['category_name'],
@@ -107,6 +109,8 @@ export function TransactionDetailToJSONTyped(value, ignoreDiscriminator) {
         'import_payee_name_original': value['import_payee_name_original'],
         'debt_transaction_type': value['debt_transaction_type'],
         'deleted': value['deleted'],
+        'amount_formatted': value['amount_formatted'],
+        'amount_currency': value['amount_currency'],
         'account_name': value['account_name'],
         'payee_name': value['payee_name'],
         'category_name': value['category_name'],

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

@@ -35,7 +35,7 @@ export interface TransactionSummary {
      * @type {string}
      * @memberof TransactionSummary
      */
-    memo?: string | null;
+    memo?: string;
     /**
      *
      * @type {TransactionClearedStatus}
@@ -59,7 +59,7 @@ export interface TransactionSummary {
      * @type {string}
      * @memberof TransactionSummary
      */
-    flag_name?: string | null;
+    flag_name?: string;
     /**
      *
      * @type {string}
@@ -71,49 +71,49 @@ export interface TransactionSummary {
      * @type {string}
      * @memberof TransactionSummary
      */
-    payee_id?: string | null;
+    payee_id?: string;
     /**
      *
      * @type {string}
      * @memberof TransactionSummary
      */
-    category_id?: string | null;
+    category_id?: string;
     /**
      * If a transfer transaction, the account to which it transfers
      * @type {string}
      * @memberof TransactionSummary
      */
-    transfer_account_id?: string | null;
+    transfer_account_id?: string;
     /**
      * If a transfer transaction, the id of transaction on the other side of the transfer
      * @type {string}
      * @memberof TransactionSummary
      */
-    transfer_transaction_id?: string | null;
+    transfer_transaction_id?: string;
     /**
      * If transaction is matched, the id of the matched transaction
      * @type {string}
      * @memberof TransactionSummary
      */
-    matched_transaction_id?: string | null;
+    matched_transaction_id?: string;
     /**
      * 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 TransactionSummary
      */
-    import_id?: string | null;
+    import_id?: string;
     /**
      * If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules
      * @type {string}
      * @memberof TransactionSummary
      */
-    import_payee_name?: string | null;
+    import_payee_name?: string;
     /**
      * If the transaction was imported, the original payee name as it appeared on the statement
      * @type {string}
      * @memberof TransactionSummary
      */
-    import_payee_name_original?: string | null;
+    import_payee_name_original?: string;
     /**
      * If the transaction is a debt/loan account transaction, the type of transaction
      * @type {TransactionSummaryDebtTransactionTypeEnum}
@@ -126,6 +126,18 @@ export interface TransactionSummary {
      * @memberof TransactionSummary
      */
     deleted: boolean;
+    /**
+     * The transaction amount formatted in the plan's currency format
+     * @type {string}
+     * @memberof TransactionSummary
+     */
+    amount_formatted?: string;
+    /**
+     * The transaction amount as a decimal currency amount
+     * @type {number}
+     * @memberof TransactionSummary
+     */
+    amount_currency?: number;
 }
 /**
  * @export

package/dist/esm/models/TransactionSummary.js

@@ -68,6 +68,8 @@ export function TransactionSummaryFromJSONTyped(json, ignoreDiscriminator) {
         'import_payee_name_original': json['import_payee_name_original'] == null ? undefined : json['import_payee_name_original'],
         'debt_transaction_type': json['debt_transaction_type'] == null ? undefined : json['debt_transaction_type'],
         'deleted': json['deleted'],
+        'amount_formatted': json['amount_formatted'] == null ? undefined : json['amount_formatted'],
+        'amount_currency': json['amount_currency'] == null ? undefined : json['amount_currency'],
     };
 }
 export function TransactionSummaryToJSON(json) {
@@ -98,5 +100,7 @@ export function TransactionSummaryToJSONTyped(value, ignoreDiscriminator) {
         'import_payee_name_original': value['import_payee_name_original'],
         'debt_transaction_type': value['debt_transaction_type'],
         'deleted': value['deleted'],
+        'amount_formatted': value['amount_formatted'],
+        'amount_currency': value['amount_currency'],
     };
 }

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

@@ -0,0 +1,151 @@
+/**
+ * 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 { TransactionFlagColor } from './TransactionFlagColor';
+import type { TransactionClearedStatus } from './TransactionClearedStatus';
+/**
+ *
+ * @export
+ * @interface TransactionSummaryBase
+ */
+export interface TransactionSummaryBase {
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionSummaryBase
+     */
+    id: string;
+    /**
+     * The transaction date in ISO format (e.g. 2016-12-01)
+     * @type {string}
+     * @memberof TransactionSummaryBase
+     */
+    date: string;
+    /**
+     * The transaction amount in milliunits format
+     * @type {number}
+     * @memberof TransactionSummaryBase
+     */
+    amount: number;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionSummaryBase
+     */
+    memo?: string | null;
+    /**
+     *
+     * @type {TransactionClearedStatus}
+     * @memberof TransactionSummaryBase
+     */
+    cleared: TransactionClearedStatus;
+    /**
+     * Whether or not the transaction is approved
+     * @type {boolean}
+     * @memberof TransactionSummaryBase
+     */
+    approved: boolean;
+    /**
+     *
+     * @type {TransactionFlagColor}
+     * @memberof TransactionSummaryBase
+     */
+    flag_color?: TransactionFlagColor | null;
+    /**
+     * The customized name of a transaction flag
+     * @type {string}
+     * @memberof TransactionSummaryBase
+     */
+    flag_name?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionSummaryBase
+     */
+    account_id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionSummaryBase
+     */
+    payee_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionSummaryBase
+     */
+    category_id?: string | null;
+    /**
+     * If a transfer transaction, the account to which it transfers
+     * @type {string}
+     * @memberof TransactionSummaryBase
+     */
+    transfer_account_id?: string | null;
+    /**
+     * If a transfer transaction, the id of transaction on the other side of the transfer
+     * @type {string}
+     * @memberof TransactionSummaryBase
+     */
+    transfer_transaction_id?: string | null;
+    /**
+     * If transaction is matched, the id of the matched transaction
+     * @type {string}
+     * @memberof TransactionSummaryBase
+     */
+    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 TransactionSummaryBase
+     */
+    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 TransactionSummaryBase
+     */
+    import_payee_name?: string | null;
+    /**
+     * If the transaction was imported, the original payee name as it appeared on the statement
+     * @type {string}
+     * @memberof TransactionSummaryBase
+     */
+    import_payee_name_original?: string | null;
+    /**
+     * If the transaction is a debt/loan account transaction, the type of transaction
+     * @type {TransactionSummaryBaseDebtTransactionTypeEnum}
+     * @memberof TransactionSummaryBase
+     */
+    debt_transaction_type?: TransactionSummaryBaseDebtTransactionTypeEnum | null;
+    /**
+     * Whether or not the transaction has been deleted.  Deleted transactions will only be included in delta requests.
+     * @type {boolean}
+     * @memberof TransactionSummaryBase
+     */
+    deleted: boolean;
+}
+/**
+ * @export
+ */
+export declare const TransactionSummaryBaseDebtTransactionTypeEnum: {
+    readonly Payment: "payment";
+    readonly Refund: "refund";
+    readonly Fee: "fee";
+    readonly Interest: "interest";
+    readonly Escrow: "escrow";
+    readonly BalanceAdjustment: "balanceAdjustment";
+    readonly Credit: "credit";
+    readonly Charge: "charge";
+};
+export type TransactionSummaryBaseDebtTransactionTypeEnum = typeof TransactionSummaryBaseDebtTransactionTypeEnum[keyof typeof TransactionSummaryBaseDebtTransactionTypeEnum];
+/**
+ * Check if a given object implements the TransactionSummaryBase interface.
+ */
+export declare function instanceOfTransactionSummaryBase(value: object): value is TransactionSummaryBase;
+export declare function TransactionSummaryBaseFromJSON(json: any): TransactionSummaryBase;
+export declare function TransactionSummaryBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionSummaryBase;
+export declare function TransactionSummaryBaseToJSON(json: any): TransactionSummaryBase;
+export declare function TransactionSummaryBaseToJSONTyped(value?: TransactionSummaryBase | null, ignoreDiscriminator?: boolean): any;