ynab 4.0.0 → 4.1.0

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;

package/dist/esm/models/TransactionSummaryBase.js

@@ -0,0 +1,102 @@
+/* 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';
+import { TransactionClearedStatusFromJSON, TransactionClearedStatusToJSON, } from './TransactionClearedStatus';
+/**
+ * @export
+ */
+export var TransactionSummaryBaseDebtTransactionTypeEnum = {
+    Payment: 'payment',
+    Refund: 'refund',
+    Fee: 'fee',
+    Interest: 'interest',
+    Escrow: 'escrow',
+    BalanceAdjustment: 'balanceAdjustment',
+    Credit: 'credit',
+    Charge: 'charge'
+};
+/**
+ * Check if a given object implements the TransactionSummaryBase interface.
+ */
+export function instanceOfTransactionSummaryBase(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('date' in value) || value['date'] === undefined)
+        return false;
+    if (!('amount' in value) || value['amount'] === undefined)
+        return false;
+    if (!('cleared' in value) || value['cleared'] === undefined)
+        return false;
+    if (!('approved' in value) || value['approved'] === 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 TransactionSummaryBaseFromJSON(json) {
+    return TransactionSummaryBaseFromJSONTyped(json, false);
+}
+export function TransactionSummaryBaseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'date': json['date'],
+        'amount': json['amount'],
+        'memo': json['memo'] == null ? undefined : json['memo'],
+        'cleared': TransactionClearedStatusFromJSON(json['cleared']),
+        'approved': json['approved'],
+        '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'],
+        'transfer_transaction_id': json['transfer_transaction_id'] == null ? undefined : json['transfer_transaction_id'],
+        'matched_transaction_id': json['matched_transaction_id'] == null ? undefined : json['matched_transaction_id'],
+        'import_id': json['import_id'] == null ? undefined : json['import_id'],
+        'import_payee_name': json['import_payee_name'] == null ? undefined : json['import_payee_name'],
+        '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'],
+    };
+}
+export function TransactionSummaryBaseToJSON(json) {
+    return TransactionSummaryBaseToJSONTyped(json, false);
+}
+export function TransactionSummaryBaseToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'date': value['date'],
+        'amount': value['amount'],
+        'memo': value['memo'],
+        'cleared': TransactionClearedStatusToJSON(value['cleared']),
+        'approved': value['approved'],
+        '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'],
+        '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'],
+    };
+}

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

@@ -1,4 +1,5 @@
 export * from './Account';
+export * from './AccountBase';
 export * from './AccountResponse';
 export * from './AccountResponseData';
 export * from './AccountType';
@@ -11,6 +12,7 @@ export * from './BulkTransactions';
 export * from './CategoriesResponse';
 export * from './CategoriesResponseData';
 export * from './Category';
+export * from './CategoryBase';
 export * from './CategoryGroup';
 export * from './CategoryGroupWithCategories';
 export * from './CategoryResponse';
@@ -25,17 +27,20 @@ export * from './HybridTransaction';
 export * from './HybridTransactionsResponse';
 export * from './HybridTransactionsResponseData';
 export * from './MoneyMovement';
+export * from './MoneyMovementBase';
 export * from './MoneyMovementGroup';
 export * from './MoneyMovementGroupsResponse';
 export * from './MoneyMovementGroupsResponseData';
 export * from './MoneyMovementsResponse';
 export * from './MoneyMovementsResponseData';
 export * from './MonthDetail';
+export * from './MonthDetailBase';
 export * from './MonthDetailResponse';
 export * from './MonthDetailResponseData';
 export * from './MonthSummariesResponse';
 export * from './MonthSummariesResponseData';
 export * from './MonthSummary';
+export * from './MonthSummaryBase';
 export * from './NewCategory';
 export * from './NewTransaction';
 export * from './PatchCategoryGroupWrapper';
@@ -65,11 +70,14 @@ export * from './PlanSummaryResponseData';
 export * from './PostAccountWrapper';
 export * from './PostCategoryGroupWrapper';
 export * from './PostCategoryWrapper';
+export * from './PostPayee';
+export * from './PostPayeeWrapper';
 export * from './PostScheduledTransactionWrapper';
 export * from './PostTransactionsWrapper';
 export * from './PutScheduledTransactionWrapper';
 export * from './PutTransactionWrapper';
 export * from './SaveAccount';
+export * from './SaveAccountType';
 export * from './SaveCategory';
 export * from './SaveCategoryGroup';
 export * from './SaveCategoryGroupResponse';
@@ -87,20 +95,24 @@ export * from './SaveTransactionWithOptionalFields';
 export * from './SaveTransactionsResponse';
 export * from './SaveTransactionsResponseData';
 export * from './ScheduledSubTransaction';
+export * from './ScheduledSubTransactionBase';
 export * from './ScheduledTransactionDetail';
 export * from './ScheduledTransactionFrequency';
 export * from './ScheduledTransactionResponse';
 export * from './ScheduledTransactionResponseData';
 export * from './ScheduledTransactionSummary';
+export * from './ScheduledTransactionSummaryBase';
 export * from './ScheduledTransactionsResponse';
 export * from './ScheduledTransactionsResponseData';
 export * from './SubTransaction';
+export * from './SubTransactionBase';
 export * from './TransactionClearedStatus';
 export * from './TransactionDetail';
 export * from './TransactionFlagColor';
 export * from './TransactionResponse';
 export * from './TransactionResponseData';
 export * from './TransactionSummary';
+export * from './TransactionSummaryBase';
 export * from './TransactionsImportResponse';
 export * from './TransactionsImportResponseData';
 export * from './TransactionsResponse';

package/dist/esm/models/index.js

@@ -1,6 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 export * from './Account';
+export * from './AccountBase';
 export * from './AccountResponse';
 export * from './AccountResponseData';
 export * from './AccountType';
@@ -13,6 +14,7 @@ export * from './BulkTransactions';
 export * from './CategoriesResponse';
 export * from './CategoriesResponseData';
 export * from './Category';
+export * from './CategoryBase';
 export * from './CategoryGroup';
 export * from './CategoryGroupWithCategories';
 export * from './CategoryResponse';
@@ -27,17 +29,20 @@ export * from './HybridTransaction';
 export * from './HybridTransactionsResponse';
 export * from './HybridTransactionsResponseData';
 export * from './MoneyMovement';
+export * from './MoneyMovementBase';
 export * from './MoneyMovementGroup';
 export * from './MoneyMovementGroupsResponse';
 export * from './MoneyMovementGroupsResponseData';
 export * from './MoneyMovementsResponse';
 export * from './MoneyMovementsResponseData';
 export * from './MonthDetail';
+export * from './MonthDetailBase';
 export * from './MonthDetailResponse';
 export * from './MonthDetailResponseData';
 export * from './MonthSummariesResponse';
 export * from './MonthSummariesResponseData';
 export * from './MonthSummary';
+export * from './MonthSummaryBase';
 export * from './NewCategory';
 export * from './NewTransaction';
 export * from './PatchCategoryGroupWrapper';
@@ -67,11 +72,14 @@ export * from './PlanSummaryResponseData';
 export * from './PostAccountWrapper';
 export * from './PostCategoryGroupWrapper';
 export * from './PostCategoryWrapper';
+export * from './PostPayee';
+export * from './PostPayeeWrapper';
 export * from './PostScheduledTransactionWrapper';
 export * from './PostTransactionsWrapper';
 export * from './PutScheduledTransactionWrapper';
 export * from './PutTransactionWrapper';
 export * from './SaveAccount';
+export * from './SaveAccountType';
 export * from './SaveCategory';
 export * from './SaveCategoryGroup';
 export * from './SaveCategoryGroupResponse';
@@ -89,20 +97,24 @@ export * from './SaveTransactionWithOptionalFields';
 export * from './SaveTransactionsResponse';
 export * from './SaveTransactionsResponseData';
 export * from './ScheduledSubTransaction';
+export * from './ScheduledSubTransactionBase';
 export * from './ScheduledTransactionDetail';
 export * from './ScheduledTransactionFrequency';
 export * from './ScheduledTransactionResponse';
 export * from './ScheduledTransactionResponseData';
 export * from './ScheduledTransactionSummary';
+export * from './ScheduledTransactionSummaryBase';
 export * from './ScheduledTransactionsResponse';
 export * from './ScheduledTransactionsResponseData';
 export * from './SubTransaction';
+export * from './SubTransactionBase';
 export * from './TransactionClearedStatus';
 export * from './TransactionDetail';
 export * from './TransactionFlagColor';
 export * from './TransactionResponse';
 export * from './TransactionResponseData';
 export * from './TransactionSummary';
+export * from './TransactionSummaryBase';
 export * from './TransactionsImportResponse';
 export * from './TransactionsImportResponseData';
 export * from './TransactionsResponse';

package/dist/models/Account.d.ts

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

package/dist/models/Account.js

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

package/dist/models/AccountBase.d.ts

@@ -0,0 +1,136 @@
+/**
+ * YNAB API Endpoints
+ * Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+import type { AccountType } from './AccountType';
+/**
+ *
+ * @export
+ * @interface AccountBase
+ */
+export interface AccountBase {
+    /**
+     *
+     * @type {string}
+     * @memberof AccountBase
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AccountBase
+     */
+    name: string;
+    /**
+     *
+     * @type {AccountType}
+     * @memberof AccountBase
+     */
+    type: AccountType;
+    /**
+     * Whether this account is "on budget" or not
+     * @type {boolean}
+     * @memberof AccountBase
+     */
+    on_budget: boolean;
+    /**
+     * Whether this account is closed or not
+     * @type {boolean}
+     * @memberof AccountBase
+     */
+    closed: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof AccountBase
+     */
+    note?: string | null;
+    /**
+     * The current available balance of the account in milliunits format
+     * @type {number}
+     * @memberof AccountBase
+     */
+    balance: number;
+    /**
+     * The current cleared balance of the account in milliunits format
+     * @type {number}
+     * @memberof AccountBase
+     */
+    cleared_balance: number;
+    /**
+     * The current uncleared balance of the account in milliunits format
+     * @type {number}
+     * @memberof AccountBase
+     */
+    uncleared_balance: number;
+    /**
+     * The payee id which should be used when transferring to this account
+     * @type {string}
+     * @memberof AccountBase
+     */
+    transfer_payee_id: string | null;
+    /**
+     * Whether or not the account is linked to a financial institution for automatic transaction import.
+     * @type {boolean}
+     * @memberof AccountBase
+     */
+    direct_import_linked?: boolean;
+    /**
+     * If an account linked to a financial institution (direct_import_linked=true) and the linked connection is not in a healthy state, this will be true.
+     * @type {boolean}
+     * @memberof AccountBase
+     */
+    direct_import_in_error?: boolean;
+    /**
+     * A date/time specifying when the account was last reconciled.
+     * @type {string}
+     * @memberof AccountBase
+     */
+    last_reconciled_at?: string | null;
+    /**
+     * This field is deprecated and will always be null.
+     * @type {number}
+     * @memberof AccountBase
+     */
+    debt_original_balance?: number | null;
+    /**
+     *
+     * @type {{ [key: string]: number; }}
+     * @memberof AccountBase
+     */
+    debt_interest_rates?: {
+        [key: string]: number;
+    };
+    /**
+     *
+     * @type {{ [key: string]: number; }}
+     * @memberof AccountBase
+     */
+    debt_minimum_payments?: {
+        [key: string]: number;
+    };
+    /**
+     *
+     * @type {{ [key: string]: number; }}
+     * @memberof AccountBase
+     */
+    debt_escrow_amounts?: {
+        [key: string]: number;
+    };
+    /**
+     * Whether or not the account has been deleted.  Deleted accounts will only be included in delta requests.
+     * @type {boolean}
+     * @memberof AccountBase
+     */
+    deleted: boolean;
+}
+/**
+ * Check if a given object implements the AccountBase interface.
+ */
+export declare function instanceOfAccountBase(value: object): value is AccountBase;
+export declare function AccountBaseFromJSON(json: any): AccountBase;
+export declare function AccountBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountBase;
+export declare function AccountBaseToJSON(json: any): AccountBase;
+export declare function AccountBaseToJSONTyped(value?: AccountBase | null, ignoreDiscriminator?: boolean): any;