ynab 2.0.0 → 2.3.0

package/dist/models/ScheduledTransactionsResponseData.d.ts

@@ -2,7 +2,7 @@
  * 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
+ * The version of the OpenAPI document: 1.70.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,7 +32,7 @@ export interface ScheduledTransactionsResponseData {
 /**
  * Check if a given object implements the ScheduledTransactionsResponseData interface.
  */
-export declare function instanceOfScheduledTransactionsResponseData(value: object): boolean;
+export declare function instanceOfScheduledTransactionsResponseData(value: object): value is ScheduledTransactionsResponseData;
 export declare function ScheduledTransactionsResponseDataFromJSON(json: any): ScheduledTransactionsResponseData;
 export declare function ScheduledTransactionsResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScheduledTransactionsResponseData;
 export declare function ScheduledTransactionsResponseDataToJSON(value?: ScheduledTransactionsResponseData | null): any;

package/dist/models/ScheduledTransactionsResponseData.js

@@ -5,7 +5,7 @@
  * 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
+ * The version of the OpenAPI document: 1.70.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -19,10 +19,11 @@ const ScheduledTransactionDetail_1 = require("./ScheduledTransactionDetail");
  * Check if a given object implements the ScheduledTransactionsResponseData interface.
  */
 function instanceOfScheduledTransactionsResponseData(value) {
-    let isInstance = true;
-    isInstance = isInstance && "scheduled_transactions" in value;
-    isInstance = isInstance && "server_knowledge" in value;
-    return isInstance;
+    if (!('scheduled_transactions' in value) || value['scheduled_transactions'] === undefined)
+        return false;
+    if (!('server_knowledge' in value) || value['server_knowledge'] === undefined)
+        return false;
+    return true;
 }
 exports.instanceOfScheduledTransactionsResponseData = instanceOfScheduledTransactionsResponseData;
 function ScheduledTransactionsResponseDataFromJSON(json) {
@@ -30,7 +31,7 @@ function ScheduledTransactionsResponseDataFromJSON(json) {
 }
 exports.ScheduledTransactionsResponseDataFromJSON = ScheduledTransactionsResponseDataFromJSON;
 function ScheduledTransactionsResponseDataFromJSONTyped(json, ignoreDiscriminator) {
-    if ((json === undefined) || (json === null)) {
+    if (json == null) {
         return json;
     }
     return {
@@ -40,15 +41,12 @@ function ScheduledTransactionsResponseDataFromJSONTyped(json, ignoreDiscriminato
 }
 exports.ScheduledTransactionsResponseDataFromJSONTyped = ScheduledTransactionsResponseDataFromJSONTyped;
 function ScheduledTransactionsResponseDataToJSON(value) {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
+    if (value == null) {
+        return value;
     }
     return {
-        'scheduled_transactions': (value.scheduled_transactions.map(ScheduledTransactionDetail_1.ScheduledTransactionDetailToJSON)),
-        'server_knowledge': value.server_knowledge,
+        'scheduled_transactions': (value['scheduled_transactions'].map(ScheduledTransactionDetail_1.ScheduledTransactionDetailToJSON)),
+        'server_knowledge': value['server_knowledge'],
     };
 }
 exports.ScheduledTransactionsResponseDataToJSON = ScheduledTransactionsResponseDataToJSON;

package/dist/models/SubTransaction.d.ts

@@ -2,7 +2,7 @@
  * 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
+ * The version of the OpenAPI document: 1.70.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -38,43 +38,43 @@ 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}
@@ -85,7 +85,7 @@ export interface SubTransaction {
 /**
  * Check if a given object implements the SubTransaction interface.
  */
-export declare function instanceOfSubTransaction(value: object): boolean;
+export declare function instanceOfSubTransaction(value: object): value is SubTransaction;
 export declare function SubTransactionFromJSON(json: any): SubTransaction;
 export declare function SubTransactionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubTransaction;
 export declare function SubTransactionToJSON(value?: SubTransaction | null): any;

package/dist/models/SubTransaction.js

@@ -5,7 +5,7 @@
  * 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
+ * The version of the OpenAPI document: 1.70.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -14,17 +14,19 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SubTransactionToJSON = exports.SubTransactionFromJSONTyped = exports.SubTransactionFromJSON = exports.instanceOfSubTransaction = void 0;
-const runtime_1 = require("../runtime");
 /**
  * Check if a given object implements the SubTransaction interface.
  */
 function instanceOfSubTransaction(value) {
-    let isInstance = true;
-    isInstance = isInstance && "id" in value;
-    isInstance = isInstance && "transaction_id" in value;
-    isInstance = isInstance && "amount" in value;
-    isInstance = isInstance && "deleted" in value;
-    return isInstance;
+    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;
 }
 exports.instanceOfSubTransaction = instanceOfSubTransaction;
 function SubTransactionFromJSON(json) {
@@ -32,43 +34,40 @@ function SubTransactionFromJSON(json) {
 }
 exports.SubTransactionFromJSON = SubTransactionFromJSON;
 function SubTransactionFromJSONTyped(json, ignoreDiscriminator) {
-    if ((json === undefined) || (json === null)) {
+    if (json == null) {
         return json;
     }
     return {
         'id': json['id'],
         'transaction_id': json['transaction_id'],
         'amount': json['amount'],
-        'memo': !(0, runtime_1.exists)(json, 'memo') ? undefined : json['memo'],
-        'payee_id': !(0, runtime_1.exists)(json, 'payee_id') ? undefined : json['payee_id'],
-        'payee_name': !(0, runtime_1.exists)(json, 'payee_name') ? undefined : json['payee_name'],
-        'category_id': !(0, runtime_1.exists)(json, 'category_id') ? undefined : json['category_id'],
-        'category_name': !(0, runtime_1.exists)(json, 'category_name') ? undefined : json['category_name'],
-        'transfer_account_id': !(0, runtime_1.exists)(json, 'transfer_account_id') ? undefined : json['transfer_account_id'],
-        'transfer_transaction_id': !(0, runtime_1.exists)(json, 'transfer_transaction_id') ? undefined : json['transfer_transaction_id'],
+        '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'],
     };
 }
 exports.SubTransactionFromJSONTyped = SubTransactionFromJSONTyped;
 function SubTransactionToJSON(value) {
-    if (value === undefined) {
-        return undefined;
-    }
-    if (value === null) {
-        return null;
+    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,
+        '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'],
     };
 }
 exports.SubTransactionToJSON = SubTransactionToJSON;

package/dist/models/TransactionClearedStatus.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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.70.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The cleared status of the transaction
+ * @export
+ */
+export declare const TransactionClearedStatus: {
+    readonly Cleared: "cleared";
+    readonly Uncleared: "uncleared";
+    readonly Reconciled: "reconciled";
+};
+export type TransactionClearedStatus = typeof TransactionClearedStatus[keyof typeof TransactionClearedStatus];
+export declare function instanceOfTransactionClearedStatus(value: any): boolean;
+export declare function TransactionClearedStatusFromJSON(json: any): TransactionClearedStatus;
+export declare function TransactionClearedStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionClearedStatus;
+export declare function TransactionClearedStatusToJSON(value?: TransactionClearedStatus | null): any;

package/dist/models/TransactionClearedStatus.js

@@ -0,0 +1,48 @@
+"use strict";
+/* 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.70.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionClearedStatusToJSON = exports.TransactionClearedStatusFromJSONTyped = exports.TransactionClearedStatusFromJSON = exports.instanceOfTransactionClearedStatus = exports.TransactionClearedStatus = void 0;
+/**
+ * The cleared status of the transaction
+ * @export
+ */
+exports.TransactionClearedStatus = {
+    Cleared: 'cleared',
+    Uncleared: 'uncleared',
+    Reconciled: 'reconciled'
+};
+function instanceOfTransactionClearedStatus(value) {
+    for (const key in exports.TransactionClearedStatus) {
+        if (Object.prototype.hasOwnProperty.call(exports.TransactionClearedStatus, key)) {
+            if (exports.TransactionClearedStatus[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+exports.instanceOfTransactionClearedStatus = instanceOfTransactionClearedStatus;
+function TransactionClearedStatusFromJSON(json) {
+    return TransactionClearedStatusFromJSONTyped(json, false);
+}
+exports.TransactionClearedStatusFromJSON = TransactionClearedStatusFromJSON;
+function TransactionClearedStatusFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+exports.TransactionClearedStatusFromJSONTyped = TransactionClearedStatusFromJSONTyped;
+function TransactionClearedStatusToJSON(value) {
+    return value;
+}
+exports.TransactionClearedStatusToJSON = TransactionClearedStatusToJSON;

package/dist/models/TransactionDetail.d.ts

@@ -2,13 +2,15 @@
  * 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
+ * The version of the OpenAPI document: 1.70.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 { TransactionFlagColor } from './TransactionFlagColor';
+import type { TransactionClearedStatus } from './TransactionClearedStatus';
 import type { SubTransaction } from './SubTransaction';
 /**
  *
@@ -39,13 +41,13 @@ export interface TransactionDetail {
      * @type {string}
      * @memberof TransactionDetail
      */
-    memo?: string | null;
+    memo?: string;
     /**
-     * The cleared status of the transaction
-     * @type {string}
+     *
+     * @type {TransactionClearedStatus}
      * @memberof TransactionDetail
      */
-    cleared: TransactionDetailClearedEnum;
+    cleared: TransactionClearedStatus;
     /**
      * Whether or not the transaction is approved
      * @type {boolean}
@@ -53,11 +55,17 @@ export interface TransactionDetail {
      */
     approved: boolean;
     /**
-     * The transaction flag
+     *
+     * @type {TransactionFlagColor}
+     * @memberof TransactionDetail
+     */
+    flag_color?: TransactionFlagColor;
+    /**
+     * The customized name of a transaction flag
      * @type {string}
      * @memberof TransactionDetail
      */
-    flag_color?: TransactionDetailFlagColorEnum;
+    flag_name?: string;
     /**
      *
      * @type {string}
@@ -69,49 +77,49 @@ export interface TransactionDetail {
      * @type {string}
      * @memberof TransactionDetail
      */
-    payee_id?: string | null;
+    payee_id?: string;
     /**
      *
      * @type {string}
      * @memberof TransactionDetail
      */
-    category_id?: string | null;
+    category_id?: string;
     /**
      * If a transfer transaction, the account to which it transfers
      * @type {string}
      * @memberof TransactionDetail
      */
-    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 TransactionDetail
      */
-    transfer_transaction_id?: string | null;
+    transfer_transaction_id?: string;
     /**
      * If transaction is matched, the id of the matched transaction
      * @type {string}
      * @memberof TransactionDetail
      */
-    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 TransactionDetail
      */
-    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 TransactionDetail
      */
-    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 TransactionDetail
      */
-    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 {string}
@@ -135,13 +143,13 @@ export interface TransactionDetail {
      * @type {string}
      * @memberof TransactionDetail
      */
-    payee_name?: string | null;
+    payee_name?: string;
     /**
      * The name of the category.  If a split transaction, this will be 'Split'.
      * @type {string}
      * @memberof TransactionDetail
      */
-    category_name?: string | null;
+    category_name?: string;
     /**
      * If a split transaction, the subtransactions.
      * @type {Array<SubTransaction>}
@@ -149,28 +157,6 @@ export interface 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
  */
@@ -180,16 +166,15 @@ export declare const TransactionDetailDebtTransactionTypeEnum: {
     readonly Fee: "fee";
     readonly Interest: "interest";
     readonly Escrow: "escrow";
-    readonly BalancedAdjustment: "balancedAdjustment";
+    readonly BalanceAdjustment: "balanceAdjustment";
     readonly Credit: "credit";
     readonly Charge: "charge";
-    readonly Null: "null";
 };
-export declare type TransactionDetailDebtTransactionTypeEnum = typeof TransactionDetailDebtTransactionTypeEnum[keyof typeof TransactionDetailDebtTransactionTypeEnum];
+export 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 instanceOfTransactionDetail(value: object): value is TransactionDetail;
 export declare function TransactionDetailFromJSON(json: any): TransactionDetail;
 export declare function TransactionDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionDetail;
 export declare function TransactionDetailToJSON(value?: TransactionDetail | null): any;