ynab 1.55.0 → 2.0.0-rc.0

package/dist/esm/models/AccountResponse.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 { AccountResponseDataFromJSON, AccountResponseDataToJSON, } from './AccountResponseData';
+/**
+ * Check if a given object implements the AccountResponse interface.
+ */
+export function instanceOfAccountResponse(value) {
+    var isInstance = true;
+    isInstance = isInstance && "data" in value;
+    return isInstance;
+}
+export function AccountResponseFromJSON(json) {
+    return AccountResponseFromJSONTyped(json, false);
+}
+export function AccountResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'data': AccountResponseDataFromJSON(json['data']),
+    };
+}
+export function AccountResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'data': AccountResponseDataToJSON(value.data),
+    };
+}

package/dist/esm/models/AccountResponseData.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 { Account } from './Account';
+/**
+ *
+ * @export
+ * @interface AccountResponseData
+ */
+export interface AccountResponseData {
+    /**
+     *
+     * @type {Account}
+     * @memberof AccountResponseData
+     */
+    account: Account;
+}
+/**
+ * Check if a given object implements the AccountResponseData interface.
+ */
+export declare function instanceOfAccountResponseData(value: object): boolean;
+export declare function AccountResponseDataFromJSON(json: any): AccountResponseData;
+export declare function AccountResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountResponseData;
+export declare function AccountResponseDataToJSON(value?: AccountResponseData | null): any;

package/dist/esm/models/AccountResponseData.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 { AccountFromJSON, AccountToJSON, } from './Account';
+/**
+ * Check if a given object implements the AccountResponseData interface.
+ */
+export function instanceOfAccountResponseData(value) {
+    var isInstance = true;
+    isInstance = isInstance && "account" in value;
+    return isInstance;
+}
+export function AccountResponseDataFromJSON(json) {
+    return AccountResponseDataFromJSONTyped(json, false);
+}
+export function AccountResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'account': AccountFromJSON(json['account']),
+    };
+}
+export function AccountResponseDataToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'account': AccountToJSON(value.account),
+    };
+}

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

@@ -0,0 +1,34 @@
+/**
+ * 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.
+ */
+/**
+ * The type of account
+ * @export
+ */
+export declare const AccountType: {
+    readonly Checking: "checking";
+    readonly Savings: "savings";
+    readonly Cash: "cash";
+    readonly CreditCard: "creditCard";
+    readonly LineOfCredit: "lineOfCredit";
+    readonly OtherAsset: "otherAsset";
+    readonly OtherLiability: "otherLiability";
+    readonly Mortgage: "mortgage";
+    readonly AutoLoan: "autoLoan";
+    readonly StudentLoan: "studentLoan";
+    readonly PersonalLoan: "personalLoan";
+    readonly MedicalDebt: "medicalDebt";
+    readonly OtherDebt: "otherDebt";
+};
+export declare type AccountType = typeof AccountType[keyof typeof AccountType];
+export declare function AccountTypeFromJSON(json: any): AccountType;
+export declare function AccountTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountType;
+export declare function AccountTypeToJSON(value?: AccountType | null): any;

package/dist/esm/models/AccountType.js

@@ -0,0 +1,41 @@
+/* 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.
+ */
+/**
+ * The type of account
+ * @export
+ */
+export var AccountType = {
+    Checking: 'checking',
+    Savings: 'savings',
+    Cash: 'cash',
+    CreditCard: 'creditCard',
+    LineOfCredit: 'lineOfCredit',
+    OtherAsset: 'otherAsset',
+    OtherLiability: 'otherLiability',
+    Mortgage: 'mortgage',
+    AutoLoan: 'autoLoan',
+    StudentLoan: 'studentLoan',
+    PersonalLoan: 'personalLoan',
+    MedicalDebt: 'medicalDebt',
+    OtherDebt: 'otherDebt'
+};
+export function AccountTypeFromJSON(json) {
+    return AccountTypeFromJSONTyped(json, false);
+}
+export function AccountTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function AccountTypeToJSON(value) {
+    return value;
+}

package/dist/esm/models/AccountsResponse.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 { AccountsResponseData } from './AccountsResponseData';
+/**
+ *
+ * @export
+ * @interface AccountsResponse
+ */
+export interface AccountsResponse {
+    /**
+     *
+     * @type {AccountsResponseData}
+     * @memberof AccountsResponse
+     */
+    data: AccountsResponseData;
+}
+/**
+ * Check if a given object implements the AccountsResponse interface.
+ */
+export declare function instanceOfAccountsResponse(value: object): boolean;
+export declare function AccountsResponseFromJSON(json: any): AccountsResponse;
+export declare function AccountsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountsResponse;
+export declare function AccountsResponseToJSON(value?: AccountsResponse | null): any;

package/dist/esm/models/AccountsResponse.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 { AccountsResponseDataFromJSON, AccountsResponseDataToJSON, } from './AccountsResponseData';
+/**
+ * Check if a given object implements the AccountsResponse interface.
+ */
+export function instanceOfAccountsResponse(value) {
+    var isInstance = true;
+    isInstance = isInstance && "data" in value;
+    return isInstance;
+}
+export function AccountsResponseFromJSON(json) {
+    return AccountsResponseFromJSONTyped(json, false);
+}
+export function AccountsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'data': AccountsResponseDataFromJSON(json['data']),
+    };
+}
+export function AccountsResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'data': AccountsResponseDataToJSON(value.data),
+    };
+}

package/dist/esm/models/AccountsResponseData.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 { Account } from './Account';
+/**
+ *
+ * @export
+ * @interface AccountsResponseData
+ */
+export interface AccountsResponseData {
+    /**
+     *
+     * @type {Array<Account>}
+     * @memberof AccountsResponseData
+     */
+    accounts: Array<Account>;
+    /**
+     * The knowledge of the server
+     * @type {number}
+     * @memberof AccountsResponseData
+     */
+    server_knowledge: number;
+}
+/**
+ * Check if a given object implements the AccountsResponseData interface.
+ */
+export declare function instanceOfAccountsResponseData(value: object): boolean;
+export declare function AccountsResponseDataFromJSON(json: any): AccountsResponseData;
+export declare function AccountsResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountsResponseData;
+export declare function AccountsResponseDataToJSON(value?: AccountsResponseData | null): any;

package/dist/esm/models/AccountsResponseData.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 { AccountFromJSON, AccountToJSON, } from './Account';
+/**
+ * Check if a given object implements the AccountsResponseData interface.
+ */
+export function instanceOfAccountsResponseData(value) {
+    var isInstance = true;
+    isInstance = isInstance && "accounts" in value;
+    isInstance = isInstance && "server_knowledge" in value;
+    return isInstance;
+}
+export function AccountsResponseDataFromJSON(json) {
+    return AccountsResponseDataFromJSONTyped(json, false);
+}
+export function AccountsResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'accounts': (json['accounts'].map(AccountFromJSON)),
+        'server_knowledge': json['server_knowledge'],
+    };
+}
+export function AccountsResponseDataToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'accounts': (value.accounts.map(AccountToJSON)),
+        'server_knowledge': value.server_knowledge,
+    };
+}

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

@@ -0,0 +1,139 @@
+/**
+ * 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 { Account } from './Account';
+import type { Category } from './Category';
+import type { CategoryGroup } from './CategoryGroup';
+import type { CurrencyFormat } from './CurrencyFormat';
+import type { DateFormat } from './DateFormat';
+import type { MonthDetail } from './MonthDetail';
+import type { Payee } from './Payee';
+import type { PayeeLocation } from './PayeeLocation';
+import type { ScheduledSubTransaction } from './ScheduledSubTransaction';
+import type { ScheduledTransactionSummary } from './ScheduledTransactionSummary';
+import type { SubTransaction } from './SubTransaction';
+import type { TransactionSummary } from './TransactionSummary';
+/**
+ *
+ * @export
+ * @interface BudgetDetail
+ */
+export interface BudgetDetail {
+    /**
+     *
+     * @type {string}
+     * @memberof BudgetDetail
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BudgetDetail
+     */
+    name: string;
+    /**
+     * The last time any changes were made to the budget from either a web or mobile client
+     * @type {string}
+     * @memberof BudgetDetail
+     */
+    last_modified_on?: string;
+    /**
+     * The earliest budget month
+     * @type {string}
+     * @memberof BudgetDetail
+     */
+    first_month?: string;
+    /**
+     * The latest budget month
+     * @type {string}
+     * @memberof BudgetDetail
+     */
+    last_month?: string;
+    /**
+     *
+     * @type {DateFormat}
+     * @memberof BudgetDetail
+     */
+    date_format?: DateFormat | null;
+    /**
+     *
+     * @type {CurrencyFormat}
+     * @memberof BudgetDetail
+     */
+    currency_format?: CurrencyFormat | null;
+    /**
+     *
+     * @type {Array<Account>}
+     * @memberof BudgetDetail
+     */
+    accounts?: Array<Account>;
+    /**
+     *
+     * @type {Array<Payee>}
+     * @memberof BudgetDetail
+     */
+    payees?: Array<Payee>;
+    /**
+     *
+     * @type {Array<PayeeLocation>}
+     * @memberof BudgetDetail
+     */
+    payee_locations?: Array<PayeeLocation>;
+    /**
+     *
+     * @type {Array<CategoryGroup>}
+     * @memberof BudgetDetail
+     */
+    category_groups?: Array<CategoryGroup>;
+    /**
+     *
+     * @type {Array<Category>}
+     * @memberof BudgetDetail
+     */
+    categories?: Array<Category>;
+    /**
+     *
+     * @type {Array<MonthDetail>}
+     * @memberof BudgetDetail
+     */
+    months?: Array<MonthDetail>;
+    /**
+     *
+     * @type {Array<TransactionSummary>}
+     * @memberof BudgetDetail
+     */
+    transactions?: Array<TransactionSummary>;
+    /**
+     *
+     * @type {Array<SubTransaction>}
+     * @memberof BudgetDetail
+     */
+    subtransactions?: Array<SubTransaction>;
+    /**
+     *
+     * @type {Array<ScheduledTransactionSummary>}
+     * @memberof BudgetDetail
+     */
+    scheduled_transactions?: Array<ScheduledTransactionSummary>;
+    /**
+     *
+     * @type {Array<ScheduledSubTransaction>}
+     * @memberof BudgetDetail
+     */
+    scheduled_subtransactions?: Array<ScheduledSubTransaction>;
+}
+/**
+ * Check if a given object implements the BudgetDetail interface.
+ */
+export declare function instanceOfBudgetDetail(value: object): boolean;
+export declare function BudgetDetailFromJSON(json: any): BudgetDetail;
+export declare function BudgetDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): BudgetDetail;
+export declare function BudgetDetailToJSON(value?: BudgetDetail | null): any;

package/dist/esm/models/BudgetDetail.js

@@ -0,0 +1,89 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * YNAB API Endpoints
+ * Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { exists } from '../runtime';
+import { AccountFromJSON, AccountToJSON, } from './Account';
+import { CategoryFromJSON, CategoryToJSON, } from './Category';
+import { CategoryGroupFromJSON, CategoryGroupToJSON, } from './CategoryGroup';
+import { CurrencyFormatFromJSON, CurrencyFormatToJSON, } from './CurrencyFormat';
+import { DateFormatFromJSON, DateFormatToJSON, } from './DateFormat';
+import { MonthDetailFromJSON, MonthDetailToJSON, } from './MonthDetail';
+import { PayeeFromJSON, PayeeToJSON, } from './Payee';
+import { PayeeLocationFromJSON, PayeeLocationToJSON, } from './PayeeLocation';
+import { ScheduledSubTransactionFromJSON, ScheduledSubTransactionToJSON, } from './ScheduledSubTransaction';
+import { ScheduledTransactionSummaryFromJSON, ScheduledTransactionSummaryToJSON, } from './ScheduledTransactionSummary';
+import { SubTransactionFromJSON, SubTransactionToJSON, } from './SubTransaction';
+import { TransactionSummaryFromJSON, TransactionSummaryToJSON, } from './TransactionSummary';
+/**
+ * Check if a given object implements the BudgetDetail interface.
+ */
+export function instanceOfBudgetDetail(value) {
+    var isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "name" in value;
+    return isInstance;
+}
+export function BudgetDetailFromJSON(json) {
+    return BudgetDetailFromJSONTyped(json, false);
+}
+export function BudgetDetailFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'last_modified_on': !exists(json, 'last_modified_on') ? undefined : json['last_modified_on'],
+        'first_month': !exists(json, 'first_month') ? undefined : json['first_month'],
+        'last_month': !exists(json, 'last_month') ? undefined : json['last_month'],
+        'date_format': !exists(json, 'date_format') ? undefined : DateFormatFromJSON(json['date_format']),
+        'currency_format': !exists(json, 'currency_format') ? undefined : CurrencyFormatFromJSON(json['currency_format']),
+        'accounts': !exists(json, 'accounts') ? undefined : (json['accounts'].map(AccountFromJSON)),
+        'payees': !exists(json, 'payees') ? undefined : (json['payees'].map(PayeeFromJSON)),
+        'payee_locations': !exists(json, 'payee_locations') ? undefined : (json['payee_locations'].map(PayeeLocationFromJSON)),
+        'category_groups': !exists(json, 'category_groups') ? undefined : (json['category_groups'].map(CategoryGroupFromJSON)),
+        'categories': !exists(json, 'categories') ? undefined : (json['categories'].map(CategoryFromJSON)),
+        'months': !exists(json, 'months') ? undefined : (json['months'].map(MonthDetailFromJSON)),
+        'transactions': !exists(json, 'transactions') ? undefined : (json['transactions'].map(TransactionSummaryFromJSON)),
+        'subtransactions': !exists(json, 'subtransactions') ? undefined : (json['subtransactions'].map(SubTransactionFromJSON)),
+        'scheduled_transactions': !exists(json, 'scheduled_transactions') ? undefined : (json['scheduled_transactions'].map(ScheduledTransactionSummaryFromJSON)),
+        'scheduled_subtransactions': !exists(json, 'scheduled_subtransactions') ? undefined : (json['scheduled_subtransactions'].map(ScheduledSubTransactionFromJSON)),
+    };
+}
+export function BudgetDetailToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'name': value.name,
+        'last_modified_on': value.last_modified_on,
+        'first_month': value.first_month,
+        'last_month': value.last_month,
+        'date_format': DateFormatToJSON(value.date_format),
+        'currency_format': CurrencyFormatToJSON(value.currency_format),
+        'accounts': value.accounts === undefined ? undefined : (value.accounts.map(AccountToJSON)),
+        'payees': value.payees === undefined ? undefined : (value.payees.map(PayeeToJSON)),
+        'payee_locations': value.payee_locations === undefined ? undefined : (value.payee_locations.map(PayeeLocationToJSON)),
+        'category_groups': value.category_groups === undefined ? undefined : (value.category_groups.map(CategoryGroupToJSON)),
+        'categories': value.categories === undefined ? undefined : (value.categories.map(CategoryToJSON)),
+        'months': value.months === undefined ? undefined : (value.months.map(MonthDetailToJSON)),
+        'transactions': value.transactions === undefined ? undefined : (value.transactions.map(TransactionSummaryToJSON)),
+        'subtransactions': value.subtransactions === undefined ? undefined : (value.subtransactions.map(SubTransactionToJSON)),
+        'scheduled_transactions': value.scheduled_transactions === undefined ? undefined : (value.scheduled_transactions.map(ScheduledTransactionSummaryToJSON)),
+        'scheduled_subtransactions': value.scheduled_subtransactions === undefined ? undefined : (value.scheduled_subtransactions.map(ScheduledSubTransactionToJSON)),
+    };
+}