ynab 1.55.0 → 2.0.0-rc.0

package/dist/esm/models/ScheduledTransactionResponseData.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 { ScheduledTransactionDetailFromJSON, ScheduledTransactionDetailToJSON, } from './ScheduledTransactionDetail';
+/**
+ * Check if a given object implements the ScheduledTransactionResponseData interface.
+ */
+export function instanceOfScheduledTransactionResponseData(value) {
+    var isInstance = true;
+    isInstance = isInstance && "scheduled_transaction" in value;
+    return isInstance;
+}
+export function ScheduledTransactionResponseDataFromJSON(json) {
+    return ScheduledTransactionResponseDataFromJSONTyped(json, false);
+}
+export function ScheduledTransactionResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'scheduled_transaction': ScheduledTransactionDetailFromJSON(json['scheduled_transaction']),
+    };
+}
+export function ScheduledTransactionResponseDataToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'scheduled_transaction': ScheduledTransactionDetailToJSON(value.scheduled_transaction),
+    };
+}

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

@@ -0,0 +1,129 @@
+/**
+ * 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 ScheduledTransactionSummary
+ */
+export interface ScheduledTransactionSummary {
+    /**
+     *
+     * @type {string}
+     * @memberof ScheduledTransactionSummary
+     */
+    id: string;
+    /**
+     * The first date for which the Scheduled Transaction was scheduled.
+     * @type {string}
+     * @memberof ScheduledTransactionSummary
+     */
+    date_first: string;
+    /**
+     * The next date for which the Scheduled Transaction is scheduled.
+     * @type {string}
+     * @memberof ScheduledTransactionSummary
+     */
+    date_next: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ScheduledTransactionSummary
+     */
+    frequency: ScheduledTransactionSummaryFrequencyEnum;
+    /**
+     * The scheduled transaction amount in milliunits format
+     * @type {number}
+     * @memberof ScheduledTransactionSummary
+     */
+    amount: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ScheduledTransactionSummary
+     */
+    memo?: string | null;
+    /**
+     * The scheduled transaction flag
+     * @type {string}
+     * @memberof ScheduledTransactionSummary
+     */
+    flag_color?: ScheduledTransactionSummaryFlagColorEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ScheduledTransactionSummary
+     */
+    account_id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ScheduledTransactionSummary
+     */
+    payee_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ScheduledTransactionSummary
+     */
+    category_id?: string | null;
+    /**
+     * If a transfer, the account_id which the scheduled transaction transfers to
+     * @type {string}
+     * @memberof ScheduledTransactionSummary
+     */
+    transfer_account_id?: string | null;
+    /**
+     * Whether or not the scheduled transaction has been deleted.  Deleted scheduled transactions will only be included in delta requests.
+     * @type {boolean}
+     * @memberof ScheduledTransactionSummary
+     */
+    deleted: boolean;
+}
+/**
+ * @export
+ */
+export declare const ScheduledTransactionSummaryFrequencyEnum: {
+    readonly Never: "never";
+    readonly Daily: "daily";
+    readonly Weekly: "weekly";
+    readonly EveryOtherWeek: "everyOtherWeek";
+    readonly TwiceAMonth: "twiceAMonth";
+    readonly Every4Weeks: "every4Weeks";
+    readonly Monthly: "monthly";
+    readonly EveryOtherMonth: "everyOtherMonth";
+    readonly Every3Months: "every3Months";
+    readonly Every4Months: "every4Months";
+    readonly TwiceAYear: "twiceAYear";
+    readonly Yearly: "yearly";
+    readonly EveryOtherYear: "everyOtherYear";
+};
+export declare type ScheduledTransactionSummaryFrequencyEnum = typeof ScheduledTransactionSummaryFrequencyEnum[keyof typeof ScheduledTransactionSummaryFrequencyEnum];
+/**
+ * @export
+ */
+export declare const ScheduledTransactionSummaryFlagColorEnum: {
+    readonly Red: "red";
+    readonly Orange: "orange";
+    readonly Yellow: "yellow";
+    readonly Green: "green";
+    readonly Blue: "blue";
+    readonly Purple: "purple";
+    readonly Null: "null";
+};
+export declare type ScheduledTransactionSummaryFlagColorEnum = typeof ScheduledTransactionSummaryFlagColorEnum[keyof typeof ScheduledTransactionSummaryFlagColorEnum];
+/**
+ * Check if a given object implements the ScheduledTransactionSummary interface.
+ */
+export declare function instanceOfScheduledTransactionSummary(value: object): boolean;
+export declare function ScheduledTransactionSummaryFromJSON(json: any): ScheduledTransactionSummary;
+export declare function ScheduledTransactionSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScheduledTransactionSummary;
+export declare function ScheduledTransactionSummaryToJSON(value?: ScheduledTransactionSummary | null): any;

package/dist/esm/models/ScheduledTransactionSummary.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
+ *
+ * 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 ScheduledTransactionSummaryFrequencyEnum = {
+    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'
+};
+/**
+ * @export
+ */
+export var ScheduledTransactionSummaryFlagColorEnum = {
+    Red: 'red',
+    Orange: 'orange',
+    Yellow: 'yellow',
+    Green: 'green',
+    Blue: 'blue',
+    Purple: 'purple',
+    Null: 'null'
+};
+/**
+ * Check if a given object implements the ScheduledTransactionSummary interface.
+ */
+export function instanceOfScheduledTransactionSummary(value) {
+    var isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "date_first" in value;
+    isInstance = isInstance && "date_next" in value;
+    isInstance = isInstance && "frequency" in value;
+    isInstance = isInstance && "amount" in value;
+    isInstance = isInstance && "account_id" in value;
+    isInstance = isInstance && "deleted" in value;
+    return isInstance;
+}
+export function ScheduledTransactionSummaryFromJSON(json) {
+    return ScheduledTransactionSummaryFromJSONTyped(json, false);
+}
+export function ScheduledTransactionSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (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': !exists(json, 'memo') ? undefined : json['memo'],
+        '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'],
+        'deleted': json['deleted'],
+    };
+}
+export function ScheduledTransactionSummaryToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    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': 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,
+        'deleted': value.deleted,
+    };
+}

package/dist/esm/models/ScheduledTransactionsResponse.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 { ScheduledTransactionsResponseData } from './ScheduledTransactionsResponseData';
+/**
+ *
+ * @export
+ * @interface ScheduledTransactionsResponse
+ */
+export interface ScheduledTransactionsResponse {
+    /**
+     *
+     * @type {ScheduledTransactionsResponseData}
+     * @memberof ScheduledTransactionsResponse
+     */
+    data: ScheduledTransactionsResponseData;
+}
+/**
+ * Check if a given object implements the ScheduledTransactionsResponse interface.
+ */
+export declare function instanceOfScheduledTransactionsResponse(value: object): boolean;
+export declare function ScheduledTransactionsResponseFromJSON(json: any): ScheduledTransactionsResponse;
+export declare function ScheduledTransactionsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScheduledTransactionsResponse;
+export declare function ScheduledTransactionsResponseToJSON(value?: ScheduledTransactionsResponse | null): any;

package/dist/esm/models/ScheduledTransactionsResponse.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 { ScheduledTransactionsResponseDataFromJSON, ScheduledTransactionsResponseDataToJSON, } from './ScheduledTransactionsResponseData';
+/**
+ * Check if a given object implements the ScheduledTransactionsResponse interface.
+ */
+export function instanceOfScheduledTransactionsResponse(value) {
+    var isInstance = true;
+    isInstance = isInstance && "data" in value;
+    return isInstance;
+}
+export function ScheduledTransactionsResponseFromJSON(json) {
+    return ScheduledTransactionsResponseFromJSONTyped(json, false);
+}
+export function ScheduledTransactionsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'data': ScheduledTransactionsResponseDataFromJSON(json['data']),
+    };
+}
+export function ScheduledTransactionsResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'data': ScheduledTransactionsResponseDataToJSON(value.data),
+    };
+}

package/dist/esm/models/ScheduledTransactionsResponseData.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 { ScheduledTransactionDetail } from './ScheduledTransactionDetail';
+/**
+ *
+ * @export
+ * @interface ScheduledTransactionsResponseData
+ */
+export interface ScheduledTransactionsResponseData {
+    /**
+     *
+     * @type {Array<ScheduledTransactionDetail>}
+     * @memberof ScheduledTransactionsResponseData
+     */
+    scheduled_transactions: Array<ScheduledTransactionDetail>;
+    /**
+     * The knowledge of the server
+     * @type {number}
+     * @memberof ScheduledTransactionsResponseData
+     */
+    server_knowledge: number;
+}
+/**
+ * Check if a given object implements the ScheduledTransactionsResponseData interface.
+ */
+export declare function instanceOfScheduledTransactionsResponseData(value: object): boolean;
+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/esm/models/ScheduledTransactionsResponseData.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 { ScheduledTransactionDetailFromJSON, ScheduledTransactionDetailToJSON, } from './ScheduledTransactionDetail';
+/**
+ * Check if a given object implements the ScheduledTransactionsResponseData interface.
+ */
+export function instanceOfScheduledTransactionsResponseData(value) {
+    var isInstance = true;
+    isInstance = isInstance && "scheduled_transactions" in value;
+    isInstance = isInstance && "server_knowledge" in value;
+    return isInstance;
+}
+export function ScheduledTransactionsResponseDataFromJSON(json) {
+    return ScheduledTransactionsResponseDataFromJSONTyped(json, false);
+}
+export function ScheduledTransactionsResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'scheduled_transactions': (json['scheduled_transactions'].map(ScheduledTransactionDetailFromJSON)),
+        'server_knowledge': json['server_knowledge'],
+    };
+}
+export function ScheduledTransactionsResponseDataToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'scheduled_transactions': (value.scheduled_transactions.map(ScheduledTransactionDetailToJSON)),
+        'server_knowledge': value.server_knowledge,
+    };
+}

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

@@ -0,0 +1,91 @@
+/**
+ * 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 SubTransaction
+ */
+export interface SubTransaction {
+    /**
+     *
+     * @type {string}
+     * @memberof SubTransaction
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SubTransaction
+     */
+    transaction_id: string;
+    /**
+     * The subtransaction amount in milliunits format
+     * @type {number}
+     * @memberof SubTransaction
+     */
+    amount: number;
+    /**
+     *
+     * @type {string}
+     * @memberof SubTransaction
+     */
+    memo?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SubTransaction
+     */
+    payee_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SubTransaction
+     */
+    payee_name?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SubTransaction
+     */
+    category_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SubTransaction
+     */
+    category_name?: string | null;
+    /**
+     * If a transfer, the account_id which the subtransaction transfers to
+     * @type {string}
+     * @memberof SubTransaction
+     */
+    transfer_account_id?: string | null;
+    /**
+     * If a transfer, the id of transaction on the other side of the transfer
+     * @type {string}
+     * @memberof SubTransaction
+     */
+    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 SubTransaction
+     */
+    deleted: boolean;
+}
+/**
+ * Check if a given object implements the SubTransaction interface.
+ */
+export declare function instanceOfSubTransaction(value: object): boolean;
+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/esm/models/SubTransaction.js

@@ -0,0 +1,67 @@
+/* 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';
+/**
+ * Check if a given object implements the SubTransaction interface.
+ */
+export function instanceOfSubTransaction(value) {
+    var 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;
+}
+export function SubTransactionFromJSON(json) {
+    return SubTransactionFromJSONTyped(json, false);
+}
+export function SubTransactionFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'transaction_id': json['transaction_id'],
+        'amount': json['amount'],
+        'memo': !exists(json, 'memo') ? undefined : json['memo'],
+        'payee_id': !exists(json, 'payee_id') ? undefined : json['payee_id'],
+        'payee_name': !exists(json, 'payee_name') ? undefined : json['payee_name'],
+        'category_id': !exists(json, 'category_id') ? undefined : json['category_id'],
+        'category_name': !exists(json, 'category_name') ? undefined : json['category_name'],
+        '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'],
+        'deleted': json['deleted'],
+    };
+}
+export function SubTransactionToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    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,
+    };
+}