ynab 2.10.0 → 3.1.0

package/dist/esm/models/MoneyMovementGroupsResponse.js

@@ -0,0 +1,40 @@
+/* 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 { MoneyMovementGroupsResponseDataFromJSON, MoneyMovementGroupsResponseDataToJSON, } from './MoneyMovementGroupsResponseData';
+/**
+ * Check if a given object implements the MoneyMovementGroupsResponse interface.
+ */
+export function instanceOfMoneyMovementGroupsResponse(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    return true;
+}
+export function MoneyMovementGroupsResponseFromJSON(json) {
+    return MoneyMovementGroupsResponseFromJSONTyped(json, false);
+}
+export function MoneyMovementGroupsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': MoneyMovementGroupsResponseDataFromJSON(json['data']),
+    };
+}
+export function MoneyMovementGroupsResponseToJSON(json) {
+    return MoneyMovementGroupsResponseToJSONTyped(json, false);
+}
+export function MoneyMovementGroupsResponseToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': MoneyMovementGroupsResponseDataToJSON(value['data']),
+    };
+}

package/dist/esm/models/MoneyMovementGroupsResponseData.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
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+import type { MoneyMovementGroup } from './MoneyMovementGroup';
+/**
+ *
+ * @export
+ * @interface MoneyMovementGroupsResponseData
+ */
+export interface MoneyMovementGroupsResponseData {
+    /**
+     *
+     * @type {Array<MoneyMovementGroup>}
+     * @memberof MoneyMovementGroupsResponseData
+     */
+    money_movement_groups: Array<MoneyMovementGroup>;
+    /**
+     * The knowledge of the server
+     * @type {number}
+     * @memberof MoneyMovementGroupsResponseData
+     */
+    server_knowledge: number;
+}
+/**
+ * Check if a given object implements the MoneyMovementGroupsResponseData interface.
+ */
+export declare function instanceOfMoneyMovementGroupsResponseData(value: object): value is MoneyMovementGroupsResponseData;
+export declare function MoneyMovementGroupsResponseDataFromJSON(json: any): MoneyMovementGroupsResponseData;
+export declare function MoneyMovementGroupsResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): MoneyMovementGroupsResponseData;
+export declare function MoneyMovementGroupsResponseDataToJSON(json: any): MoneyMovementGroupsResponseData;
+export declare function MoneyMovementGroupsResponseDataToJSONTyped(value?: MoneyMovementGroupsResponseData | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/MoneyMovementGroupsResponseData.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
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+import { MoneyMovementGroupFromJSON, MoneyMovementGroupToJSON, } from './MoneyMovementGroup';
+/**
+ * Check if a given object implements the MoneyMovementGroupsResponseData interface.
+ */
+export function instanceOfMoneyMovementGroupsResponseData(value) {
+    if (!('money_movement_groups' in value) || value['money_movement_groups'] === undefined)
+        return false;
+    if (!('server_knowledge' in value) || value['server_knowledge'] === undefined)
+        return false;
+    return true;
+}
+export function MoneyMovementGroupsResponseDataFromJSON(json) {
+    return MoneyMovementGroupsResponseDataFromJSONTyped(json, false);
+}
+export function MoneyMovementGroupsResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'money_movement_groups': (json['money_movement_groups'].map(MoneyMovementGroupFromJSON)),
+        'server_knowledge': json['server_knowledge'],
+    };
+}
+export function MoneyMovementGroupsResponseDataToJSON(json) {
+    return MoneyMovementGroupsResponseDataToJSONTyped(json, false);
+}
+export function MoneyMovementGroupsResponseDataToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'money_movement_groups': (value['money_movement_groups'].map(MoneyMovementGroupToJSON)),
+        'server_knowledge': value['server_knowledge'],
+    };
+}

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

@@ -0,0 +1,28 @@
+/**
+ * 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 { MoneyMovementsResponseData } from './MoneyMovementsResponseData';
+/**
+ *
+ * @export
+ * @interface MoneyMovementsResponse
+ */
+export interface MoneyMovementsResponse {
+    /**
+     *
+     * @type {MoneyMovementsResponseData}
+     * @memberof MoneyMovementsResponse
+     */
+    data: MoneyMovementsResponseData;
+}
+/**
+ * Check if a given object implements the MoneyMovementsResponse interface.
+ */
+export declare function instanceOfMoneyMovementsResponse(value: object): value is MoneyMovementsResponse;
+export declare function MoneyMovementsResponseFromJSON(json: any): MoneyMovementsResponse;
+export declare function MoneyMovementsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): MoneyMovementsResponse;
+export declare function MoneyMovementsResponseToJSON(json: any): MoneyMovementsResponse;
+export declare function MoneyMovementsResponseToJSONTyped(value?: MoneyMovementsResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/{BudgetSettingsResponse.js → MoneyMovementsResponse.js}

@@ -6,35 +6,35 @@
  *
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)
  */
-import { BudgetSettingsResponseDataFromJSON, BudgetSettingsResponseDataToJSON, } from './BudgetSettingsResponseData';
+import { MoneyMovementsResponseDataFromJSON, MoneyMovementsResponseDataToJSON, } from './MoneyMovementsResponseData';
 /**
- * Check if a given object implements the BudgetSettingsResponse interface.
+ * Check if a given object implements the MoneyMovementsResponse interface.
  */
-export function instanceOfBudgetSettingsResponse(value) {
+export function instanceOfMoneyMovementsResponse(value) {
     if (!('data' in value) || value['data'] === undefined)
         return false;
     return true;
 }
-export function BudgetSettingsResponseFromJSON(json) {
-    return BudgetSettingsResponseFromJSONTyped(json, false);
+export function MoneyMovementsResponseFromJSON(json) {
+    return MoneyMovementsResponseFromJSONTyped(json, false);
 }
-export function BudgetSettingsResponseFromJSONTyped(json, ignoreDiscriminator) {
+export function MoneyMovementsResponseFromJSONTyped(json, ignoreDiscriminator) {
     if (json == null) {
         return json;
     }
     return {
-        'data': BudgetSettingsResponseDataFromJSON(json['data']),
+        'data': MoneyMovementsResponseDataFromJSON(json['data']),
     };
 }
-export function BudgetSettingsResponseToJSON(json) {
-    return BudgetSettingsResponseToJSONTyped(json, false);
+export function MoneyMovementsResponseToJSON(json) {
+    return MoneyMovementsResponseToJSONTyped(json, false);
 }
-export function BudgetSettingsResponseToJSONTyped(value, ignoreDiscriminator) {
+export function MoneyMovementsResponseToJSONTyped(value, ignoreDiscriminator) {
     if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
     if (value == null) {
         return value;
     }
     return {
-        'data': BudgetSettingsResponseDataToJSON(value['data']),
+        'data': MoneyMovementsResponseDataToJSON(value['data']),
     };
 }

package/dist/esm/models/MoneyMovementsResponseData.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
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+import type { MoneyMovement } from './MoneyMovement';
+/**
+ *
+ * @export
+ * @interface MoneyMovementsResponseData
+ */
+export interface MoneyMovementsResponseData {
+    /**
+     *
+     * @type {Array<MoneyMovement>}
+     * @memberof MoneyMovementsResponseData
+     */
+    money_movements: Array<MoneyMovement>;
+    /**
+     * The knowledge of the server
+     * @type {number}
+     * @memberof MoneyMovementsResponseData
+     */
+    server_knowledge: number;
+}
+/**
+ * Check if a given object implements the MoneyMovementsResponseData interface.
+ */
+export declare function instanceOfMoneyMovementsResponseData(value: object): value is MoneyMovementsResponseData;
+export declare function MoneyMovementsResponseDataFromJSON(json: any): MoneyMovementsResponseData;
+export declare function MoneyMovementsResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): MoneyMovementsResponseData;
+export declare function MoneyMovementsResponseDataToJSON(json: any): MoneyMovementsResponseData;
+export declare function MoneyMovementsResponseDataToJSONTyped(value?: MoneyMovementsResponseData | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/MoneyMovementsResponseData.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
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+import { MoneyMovementFromJSON, MoneyMovementToJSON, } from './MoneyMovement';
+/**
+ * Check if a given object implements the MoneyMovementsResponseData interface.
+ */
+export function instanceOfMoneyMovementsResponseData(value) {
+    if (!('money_movements' in value) || value['money_movements'] === undefined)
+        return false;
+    if (!('server_knowledge' in value) || value['server_knowledge'] === undefined)
+        return false;
+    return true;
+}
+export function MoneyMovementsResponseDataFromJSON(json) {
+    return MoneyMovementsResponseDataFromJSONTyped(json, false);
+}
+export function MoneyMovementsResponseDataFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'money_movements': (json['money_movements'].map(MoneyMovementFromJSON)),
+        'server_knowledge': json['server_knowledge'],
+    };
+}
+export function MoneyMovementsResponseDataToJSON(json) {
+    return MoneyMovementsResponseDataToJSONTyped(json, false);
+}
+export function MoneyMovementsResponseDataToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'money_movements': (value['money_movements'].map(MoneyMovementToJSON)),
+        'server_knowledge': value['server_knowledge'],
+    };
+}

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

@@ -22,7 +22,7 @@ export interface MonthDetail {
      * @type {string}
      * @memberof MonthDetail
      */
-    note?: string | null;
+    note?: string;
     /**
      * The total amount of transactions categorized to 'Inflow: Ready to Assign' in the month
      * @type {number}
@@ -30,7 +30,7 @@ export interface MonthDetail {
      */
     income: number;
     /**
-     * The total amount budgeted in the month
+     * The total amount assigned (budgeted) in the month
      * @type {number}
      * @memberof MonthDetail
      */
@@ -52,7 +52,7 @@ export interface MonthDetail {
      * @type {number}
      * @memberof MonthDetail
      */
-    age_of_money?: number | null;
+    age_of_money?: number;
     /**
      * Whether or not the month has been deleted.  Deleted months will only be included in delta requests.
      * @type {boolean}
@@ -60,7 +60,7 @@ export interface MonthDetail {
      */
     deleted: boolean;
     /**
-     * The budget month categories.  Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified.
+     * The plan month categories.  Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified.
      * @type {Array<Category>}
      * @memberof MonthDetail
      */

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

@@ -29,7 +29,7 @@ export interface MonthSummary {
      */
     income: number;
     /**
-     * The total amount budgeted in the month
+     * The total amount assigned (budgeted) in the month
      * @type {number}
      * @memberof MonthSummary
      */

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

@@ -0,0 +1,51 @@
+/**
+ * YNAB API Endpoints
+ * Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+/**
+ *
+ * @export
+ * @interface NewCategory
+ */
+export interface NewCategory {
+    /**
+     *
+     * @type {string}
+     * @memberof NewCategory
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof NewCategory
+     */
+    note?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof NewCategory
+     */
+    category_group_id?: string;
+    /**
+     * The goal target amount in milliunits format.  If value is specified and goal has not already been configured for category, a monthly 'Needed for Spending' goal will be created for the category with this target amount.
+     * @type {number}
+     * @memberof NewCategory
+     */
+    goal_target?: number;
+    /**
+     * The goal target date in ISO format (e.g. 2016-12-01).
+     * @type {string}
+     * @memberof NewCategory
+     */
+    goal_target_date?: string;
+}
+/**
+ * Check if a given object implements the NewCategory interface.
+ */
+export declare function instanceOfNewCategory(value: object): value is NewCategory;
+export declare function NewCategoryFromJSON(json: any): NewCategory;
+export declare function NewCategoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): NewCategory;
+export declare function NewCategoryToJSON(json: any): NewCategory;
+export declare function NewCategoryToJSONTyped(value?: NewCategory | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/NewCategory.js

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * YNAB API Endpoints
+ * Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
+ *
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
+ */
+/**
+ * Check if a given object implements the NewCategory interface.
+ */
+export function instanceOfNewCategory(value) {
+    return true;
+}
+export function NewCategoryFromJSON(json) {
+    return NewCategoryFromJSONTyped(json, false);
+}
+export function NewCategoryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+        'note': json['note'] == null ? undefined : json['note'],
+        'category_group_id': json['category_group_id'] == null ? undefined : json['category_group_id'],
+        'goal_target': json['goal_target'] == null ? undefined : json['goal_target'],
+        'goal_target_date': json['goal_target_date'] == null ? undefined : json['goal_target_date'],
+    };
+}
+export function NewCategoryToJSON(json) {
+    return NewCategoryToJSONTyped(json, false);
+}
+export function NewCategoryToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'note': value['note'],
+        'category_group_id': value['category_group_id'],
+        'goal_target': value['goal_target'],
+        'goal_target_date': value['goal_target_date'],
+    };
+}

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

@@ -36,25 +36,25 @@ export interface NewTransaction {
      * @type {string}
      * @memberof NewTransaction
      */
-    payee_id?: string | null;
+    payee_id?: string;
     /**
      * The payee name.  If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee.
      * @type {string}
      * @memberof NewTransaction
      */
-    payee_name?: string | null;
+    payee_name?: string;
     /**
      * The category for the transaction.  To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object.  If an existing transaction is a split, the `category_id` cannot be changed.  Credit Card Payment categories are not permitted and will be ignored if supplied.
      * @type {string}
      * @memberof NewTransaction
      */
-    category_id?: string | null;
+    category_id?: string;
     /**
      *
      * @type {string}
      * @memberof NewTransaction
      */
-    memo?: string | null;
+    memo?: string;
     /**
      *
      * @type {TransactionClearedStatus}

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

@@ -0,0 +1,28 @@
+/**
+ * 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 { SaveCategoryGroup } from './SaveCategoryGroup';
+/**
+ *
+ * @export
+ * @interface PatchCategoryGroupWrapper
+ */
+export interface PatchCategoryGroupWrapper {
+    /**
+     *
+     * @type {SaveCategoryGroup}
+     * @memberof PatchCategoryGroupWrapper
+     */
+    category_group: SaveCategoryGroup;
+}
+/**
+ * Check if a given object implements the PatchCategoryGroupWrapper interface.
+ */
+export declare function instanceOfPatchCategoryGroupWrapper(value: object): value is PatchCategoryGroupWrapper;
+export declare function PatchCategoryGroupWrapperFromJSON(json: any): PatchCategoryGroupWrapper;
+export declare function PatchCategoryGroupWrapperFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchCategoryGroupWrapper;
+export declare function PatchCategoryGroupWrapperToJSON(json: any): PatchCategoryGroupWrapper;
+export declare function PatchCategoryGroupWrapperToJSONTyped(value?: PatchCategoryGroupWrapper | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PatchCategoryGroupWrapper.js

@@ -0,0 +1,40 @@
+/* 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 { SaveCategoryGroupFromJSON, SaveCategoryGroupToJSON, } from './SaveCategoryGroup';
+/**
+ * Check if a given object implements the PatchCategoryGroupWrapper interface.
+ */
+export function instanceOfPatchCategoryGroupWrapper(value) {
+    if (!('category_group' in value) || value['category_group'] === undefined)
+        return false;
+    return true;
+}
+export function PatchCategoryGroupWrapperFromJSON(json) {
+    return PatchCategoryGroupWrapperFromJSONTyped(json, false);
+}
+export function PatchCategoryGroupWrapperFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'category_group': SaveCategoryGroupFromJSON(json['category_group']),
+    };
+}
+export function PatchCategoryGroupWrapperToJSON(json) {
+    return PatchCategoryGroupWrapperToJSONTyped(json, false);
+}
+export function PatchCategoryGroupWrapperToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'category_group': SaveCategoryGroupToJSON(value['category_group']),
+    };
+}

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

@@ -4,7 +4,7 @@
  *
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)
  */
-import type { SaveCategory } from './SaveCategory';
+import type { ExistingCategory } from './ExistingCategory';
 /**
  *
  * @export
@@ -13,10 +13,10 @@ import type { SaveCategory } from './SaveCategory';
 export interface PatchCategoryWrapper {
     /**
      *
-     * @type {SaveCategory}
+     * @type {ExistingCategory}
      * @memberof PatchCategoryWrapper
      */
-    category: SaveCategory;
+    category: ExistingCategory;
 }
 /**
  * Check if a given object implements the PatchCategoryWrapper interface.

package/dist/esm/models/PatchCategoryWrapper.js

@@ -6,7 +6,7 @@
  *
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)
  */
-import { SaveCategoryFromJSON, SaveCategoryToJSON, } from './SaveCategory';
+import { ExistingCategoryFromJSON, ExistingCategoryToJSON, } from './ExistingCategory';
 /**
  * Check if a given object implements the PatchCategoryWrapper interface.
  */
@@ -23,7 +23,7 @@ export function PatchCategoryWrapperFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
-        'category': SaveCategoryFromJSON(json['category']),
+        'category': ExistingCategoryFromJSON(json['category']),
     };
 }
 export function PatchCategoryWrapperToJSON(json) {
@@ -35,6 +35,6 @@ export function PatchCategoryWrapperToJSONTyped(value, ignoreDiscriminator) {
         return value;
     }
     return {
-        'category': SaveCategoryToJSON(value['category']),
+        'category': ExistingCategoryToJSON(value['category']),
     };
 }