ynab 2.0.0-rc.1 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/README.md +2 -2
  2. package/dist/apis/CategoriesApi.d.ts +16 -1
  3. package/dist/apis/CategoriesApi.js +42 -0
  4. package/dist/apis/CustomTransactionsApi.d.ts +1 -1
  5. package/dist/apis/TransactionsApi.d.ts +4 -4
  6. package/dist/apis/index.d.ts +0 -1
  7. package/dist/apis/index.js +5 -2
  8. package/dist/browser/ynab.js +1 -1
  9. package/dist/esm/apis/CategoriesApi.d.ts +16 -1
  10. package/dist/esm/apis/CategoriesApi.js +65 -1
  11. package/dist/esm/apis/CustomTransactionsApi.d.ts +1 -1
  12. package/dist/esm/apis/index.d.ts +0 -1
  13. package/dist/esm/apis/index.js +0 -1
  14. package/dist/esm/models/Category.d.ts +0 -1
  15. package/dist/esm/models/Category.js +0 -1
  16. package/dist/esm/models/CategoryGoalType.d.ts +25 -0
  17. package/dist/esm/models/CategoryGoalType.js +29 -0
  18. package/dist/esm/models/HybridTransaction.d.ts +9 -30
  19. package/dist/esm/models/HybridTransaction.js +7 -26
  20. package/dist/esm/models/PatchCategoryWrapper.d.ts +32 -0
  21. package/dist/esm/models/PatchCategoryWrapper.js +44 -0
  22. package/dist/esm/models/SaveCategory.d.ts +43 -0
  23. package/dist/esm/models/SaveCategory.js +47 -0
  24. package/dist/esm/models/SaveTransaction.d.ts +8 -28
  25. package/dist/esm/models/SaveTransaction.js +6 -24
  26. package/dist/esm/models/SaveTransactionWithId.d.ts +8 -28
  27. package/dist/esm/models/SaveTransactionWithId.js +6 -24
  28. package/dist/esm/models/SaveTransactionWithOptionalFields.d.ts +8 -28
  29. package/dist/esm/models/SaveTransactionWithOptionalFields.js +6 -24
  30. package/dist/esm/models/SaveTransactionWithOptionalFieldsFlagColor.d.ts +25 -0
  31. package/dist/esm/models/SaveTransactionWithOptionalFieldsFlagColor.js +29 -0
  32. package/dist/esm/models/ScheduledTransactionDetail.d.ts +4 -16
  33. package/dist/esm/models/ScheduledTransactionDetail.js +3 -14
  34. package/dist/esm/models/ScheduledTransactionSummary.d.ts +4 -16
  35. package/dist/esm/models/ScheduledTransactionSummary.js +3 -14
  36. package/dist/esm/models/ScheduledTransactionSummaryFlagColor.d.ts +25 -0
  37. package/dist/esm/models/ScheduledTransactionSummaryFlagColor.js +29 -0
  38. package/dist/esm/models/TransactionClearedStatus.d.ts +24 -0
  39. package/dist/esm/models/TransactionClearedStatus.js +31 -0
  40. package/dist/esm/models/TransactionDetail.d.ts +9 -30
  41. package/dist/esm/models/TransactionDetail.js +7 -26
  42. package/dist/esm/models/TransactionFlagColor.d.ts +27 -0
  43. package/dist/esm/models/TransactionFlagColor.js +34 -0
  44. package/dist/esm/models/TransactionSummary.d.ts +9 -30
  45. package/dist/esm/models/TransactionSummary.js +7 -26
  46. package/dist/esm/models/TransactionSummaryDebtTransactionType.d.ts +25 -0
  47. package/dist/esm/models/TransactionSummaryDebtTransactionType.js +29 -0
  48. package/dist/esm/models/index.d.ts +4 -0
  49. package/dist/esm/models/index.js +4 -0
  50. package/dist/index.js +5 -1
  51. package/dist/models/AccountType.d.ts +1 -1
  52. package/dist/models/Category.d.ts +1 -2
  53. package/dist/models/Category.js +0 -1
  54. package/dist/models/CategoryGoalType.d.ts +25 -0
  55. package/dist/models/CategoryGoalType.js +36 -0
  56. package/dist/models/HybridTransaction.d.ts +11 -32
  57. package/dist/models/HybridTransaction.js +8 -27
  58. package/dist/models/HybridTransactionAllOf.d.ts +1 -1
  59. package/dist/models/PatchCategoryWrapper.d.ts +32 -0
  60. package/dist/models/PatchCategoryWrapper.js +51 -0
  61. package/dist/models/SaveCategory.d.ts +43 -0
  62. package/dist/models/SaveCategory.js +54 -0
  63. package/dist/models/SaveTransaction.d.ts +8 -28
  64. package/dist/models/SaveTransaction.js +7 -25
  65. package/dist/models/SaveTransactionWithId.d.ts +8 -28
  66. package/dist/models/SaveTransactionWithId.js +7 -25
  67. package/dist/models/SaveTransactionWithOptionalFields.d.ts +8 -28
  68. package/dist/models/SaveTransactionWithOptionalFields.js +7 -25
  69. package/dist/models/SaveTransactionWithOptionalFieldsFlagColor.d.ts +25 -0
  70. package/dist/models/SaveTransactionWithOptionalFieldsFlagColor.js +36 -0
  71. package/dist/models/ScheduledTransactionDetail.d.ts +5 -17
  72. package/dist/models/ScheduledTransactionDetail.js +4 -15
  73. package/dist/models/ScheduledTransactionSummary.d.ts +5 -17
  74. package/dist/models/ScheduledTransactionSummary.js +4 -15
  75. package/dist/models/ScheduledTransactionSummaryFlagColor.d.ts +25 -0
  76. package/dist/models/ScheduledTransactionSummaryFlagColor.js +36 -0
  77. package/dist/models/TransactionClearedStatus.d.ts +24 -0
  78. package/dist/models/TransactionClearedStatus.js +37 -0
  79. package/dist/models/TransactionDetail.d.ts +10 -31
  80. package/dist/models/TransactionDetail.js +8 -27
  81. package/dist/models/TransactionFlagColor.d.ts +27 -0
  82. package/dist/models/TransactionFlagColor.js +40 -0
  83. package/dist/models/TransactionSummary.d.ts +10 -31
  84. package/dist/models/TransactionSummary.js +8 -27
  85. package/dist/models/TransactionSummaryDebtTransactionType.d.ts +25 -0
  86. package/dist/models/TransactionSummaryDebtTransactionType.js +36 -0
  87. package/dist/models/index.d.ts +4 -0
  88. package/dist/models/index.js +9 -1
  89. package/dist/runtime.d.ts +9 -9
  90. package/package.json +6 -7
@@ -0,0 +1,32 @@
1
+ /**
2
+ * YNAB API Endpoints
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { SaveCategory } from './SaveCategory';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface PatchCategoryWrapper
17
+ */
18
+ export interface PatchCategoryWrapper {
19
+ /**
20
+ *
21
+ * @type {SaveCategory}
22
+ * @memberof PatchCategoryWrapper
23
+ */
24
+ category: SaveCategory;
25
+ }
26
+ /**
27
+ * Check if a given object implements the PatchCategoryWrapper interface.
28
+ */
29
+ export declare function instanceOfPatchCategoryWrapper(value: object): boolean;
30
+ export declare function PatchCategoryWrapperFromJSON(json: any): PatchCategoryWrapper;
31
+ export declare function PatchCategoryWrapperFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchCategoryWrapper;
32
+ export declare function PatchCategoryWrapperToJSON(value?: PatchCategoryWrapper | null): any;
@@ -0,0 +1,51 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * YNAB API Endpoints
6
+ * 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
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.PatchCategoryWrapperToJSON = exports.PatchCategoryWrapperFromJSONTyped = exports.PatchCategoryWrapperFromJSON = exports.instanceOfPatchCategoryWrapper = void 0;
17
+ const SaveCategory_1 = require("./SaveCategory");
18
+ /**
19
+ * Check if a given object implements the PatchCategoryWrapper interface.
20
+ */
21
+ function instanceOfPatchCategoryWrapper(value) {
22
+ let isInstance = true;
23
+ isInstance = isInstance && "category" in value;
24
+ return isInstance;
25
+ }
26
+ exports.instanceOfPatchCategoryWrapper = instanceOfPatchCategoryWrapper;
27
+ function PatchCategoryWrapperFromJSON(json) {
28
+ return PatchCategoryWrapperFromJSONTyped(json, false);
29
+ }
30
+ exports.PatchCategoryWrapperFromJSON = PatchCategoryWrapperFromJSON;
31
+ function PatchCategoryWrapperFromJSONTyped(json, ignoreDiscriminator) {
32
+ if ((json === undefined) || (json === null)) {
33
+ return json;
34
+ }
35
+ return {
36
+ 'category': (0, SaveCategory_1.SaveCategoryFromJSON)(json['category']),
37
+ };
38
+ }
39
+ exports.PatchCategoryWrapperFromJSONTyped = PatchCategoryWrapperFromJSONTyped;
40
+ function PatchCategoryWrapperToJSON(value) {
41
+ if (value === undefined) {
42
+ return undefined;
43
+ }
44
+ if (value === null) {
45
+ return null;
46
+ }
47
+ return {
48
+ 'category': (0, SaveCategory_1.SaveCategoryToJSON)(value.category),
49
+ };
50
+ }
51
+ exports.PatchCategoryWrapperToJSON = PatchCategoryWrapperToJSON;
@@ -0,0 +1,43 @@
1
+ /**
2
+ * YNAB API Endpoints
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface SaveCategory
16
+ */
17
+ export interface SaveCategory {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof SaveCategory
22
+ */
23
+ name?: string | null;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof SaveCategory
28
+ */
29
+ note?: string | null;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof SaveCategory
34
+ */
35
+ category_group_id?: string;
36
+ }
37
+ /**
38
+ * Check if a given object implements the SaveCategory interface.
39
+ */
40
+ export declare function instanceOfSaveCategory(value: object): boolean;
41
+ export declare function SaveCategoryFromJSON(json: any): SaveCategory;
42
+ export declare function SaveCategoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): SaveCategory;
43
+ export declare function SaveCategoryToJSON(value?: SaveCategory | null): any;
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * YNAB API Endpoints
6
+ * 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
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SaveCategoryToJSON = exports.SaveCategoryFromJSONTyped = exports.SaveCategoryFromJSON = exports.instanceOfSaveCategory = void 0;
17
+ const runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the SaveCategory interface.
20
+ */
21
+ function instanceOfSaveCategory(value) {
22
+ let isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfSaveCategory = instanceOfSaveCategory;
26
+ function SaveCategoryFromJSON(json) {
27
+ return SaveCategoryFromJSONTyped(json, false);
28
+ }
29
+ exports.SaveCategoryFromJSON = SaveCategoryFromJSON;
30
+ function SaveCategoryFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
36
+ 'note': !(0, runtime_1.exists)(json, 'note') ? undefined : json['note'],
37
+ 'category_group_id': !(0, runtime_1.exists)(json, 'category_group_id') ? undefined : json['category_group_id'],
38
+ };
39
+ }
40
+ exports.SaveCategoryFromJSONTyped = SaveCategoryFromJSONTyped;
41
+ function SaveCategoryToJSON(value) {
42
+ if (value === undefined) {
43
+ return undefined;
44
+ }
45
+ if (value === null) {
46
+ return null;
47
+ }
48
+ return {
49
+ 'name': value.name,
50
+ 'note': value.note,
51
+ 'category_group_id': value.category_group_id,
52
+ };
53
+ }
54
+ exports.SaveCategoryToJSON = SaveCategoryToJSON;
@@ -10,6 +10,8 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { SaveSubTransaction } from './SaveSubTransaction';
13
+ import type { TransactionClearedStatus } from './TransactionClearedStatus';
14
+ import type { TransactionFlagColor } from './TransactionFlagColor';
13
15
  /**
14
16
  *
15
17
  * @export
@@ -59,11 +61,11 @@ export interface SaveTransaction {
59
61
  */
60
62
  memo?: string | null;
61
63
  /**
62
- * The cleared status of the transaction
63
- * @type {string}
64
+ *
65
+ * @type {TransactionClearedStatus}
64
66
  * @memberof SaveTransaction
65
67
  */
66
- cleared?: SaveTransactionClearedEnum;
68
+ cleared?: TransactionClearedStatus;
67
69
  /**
68
70
  * Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
69
71
  * @type {boolean}
@@ -71,11 +73,11 @@ export interface SaveTransaction {
71
73
  */
72
74
  approved?: boolean;
73
75
  /**
74
- * The transaction flag
75
- * @type {string}
76
+ *
77
+ * @type {TransactionFlagColor}
76
78
  * @memberof SaveTransaction
77
79
  */
78
- flag_color?: SaveTransactionFlagColorEnum;
80
+ flag_color?: TransactionFlagColor | null;
79
81
  /**
80
82
  * If specified, the new transaction will be assigned this `import_id` and considered "imported". We will also attempt to match this imported transaction to an existing "user-entered" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in 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'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a "user-entered" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
81
83
  * @type {string}
@@ -89,28 +91,6 @@ export interface SaveTransaction {
89
91
  */
90
92
  subtransactions?: Array<SaveSubTransaction>;
91
93
  }
92
- /**
93
- * @export
94
- */
95
- export declare const SaveTransactionClearedEnum: {
96
- readonly Cleared: "cleared";
97
- readonly Uncleared: "uncleared";
98
- readonly Reconciled: "reconciled";
99
- };
100
- export declare type SaveTransactionClearedEnum = typeof SaveTransactionClearedEnum[keyof typeof SaveTransactionClearedEnum];
101
- /**
102
- * @export
103
- */
104
- export declare const SaveTransactionFlagColorEnum: {
105
- readonly Red: "red";
106
- readonly Orange: "orange";
107
- readonly Yellow: "yellow";
108
- readonly Green: "green";
109
- readonly Blue: "blue";
110
- readonly Purple: "purple";
111
- readonly Null: "null";
112
- };
113
- export declare type SaveTransactionFlagColorEnum = typeof SaveTransactionFlagColorEnum[keyof typeof SaveTransactionFlagColorEnum];
114
94
  /**
115
95
  * Check if a given object implements the SaveTransaction interface.
116
96
  */
@@ -13,29 +13,11 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.SaveTransactionToJSON = exports.SaveTransactionFromJSONTyped = exports.SaveTransactionFromJSON = exports.instanceOfSaveTransaction = exports.SaveTransactionFlagColorEnum = exports.SaveTransactionClearedEnum = void 0;
16
+ exports.SaveTransactionToJSON = exports.SaveTransactionFromJSONTyped = exports.SaveTransactionFromJSON = exports.instanceOfSaveTransaction = void 0;
17
17
  const runtime_1 = require("../runtime");
18
18
  const SaveSubTransaction_1 = require("./SaveSubTransaction");
19
- /**
20
- * @export
21
- */
22
- exports.SaveTransactionClearedEnum = {
23
- Cleared: 'cleared',
24
- Uncleared: 'uncleared',
25
- Reconciled: 'reconciled'
26
- };
27
- /**
28
- * @export
29
- */
30
- exports.SaveTransactionFlagColorEnum = {
31
- Red: 'red',
32
- Orange: 'orange',
33
- Yellow: 'yellow',
34
- Green: 'green',
35
- Blue: 'blue',
36
- Purple: 'purple',
37
- Null: 'null'
38
- };
19
+ const TransactionClearedStatus_1 = require("./TransactionClearedStatus");
20
+ const TransactionFlagColor_1 = require("./TransactionFlagColor");
39
21
  /**
40
22
  * Check if a given object implements the SaveTransaction interface.
41
23
  */
@@ -60,9 +42,9 @@ function SaveTransactionFromJSONTyped(json, ignoreDiscriminator) {
60
42
  'payee_name': !(0, runtime_1.exists)(json, 'payee_name') ? undefined : json['payee_name'],
61
43
  'category_id': !(0, runtime_1.exists)(json, 'category_id') ? undefined : json['category_id'],
62
44
  'memo': !(0, runtime_1.exists)(json, 'memo') ? undefined : json['memo'],
63
- 'cleared': !(0, runtime_1.exists)(json, 'cleared') ? undefined : json['cleared'],
45
+ 'cleared': !(0, runtime_1.exists)(json, 'cleared') ? undefined : (0, TransactionClearedStatus_1.TransactionClearedStatusFromJSON)(json['cleared']),
64
46
  'approved': !(0, runtime_1.exists)(json, 'approved') ? undefined : json['approved'],
65
- 'flag_color': !(0, runtime_1.exists)(json, 'flag_color') ? undefined : json['flag_color'],
47
+ 'flag_color': !(0, runtime_1.exists)(json, 'flag_color') ? undefined : (0, TransactionFlagColor_1.TransactionFlagColorFromJSON)(json['flag_color']),
66
48
  'import_id': !(0, runtime_1.exists)(json, 'import_id') ? undefined : json['import_id'],
67
49
  'subtransactions': !(0, runtime_1.exists)(json, 'subtransactions') ? undefined : (json['subtransactions'].map(SaveSubTransaction_1.SaveSubTransactionFromJSON)),
68
50
  };
@@ -83,9 +65,9 @@ function SaveTransactionToJSON(value) {
83
65
  'payee_name': value.payee_name,
84
66
  'category_id': value.category_id,
85
67
  'memo': value.memo,
86
- 'cleared': value.cleared,
68
+ 'cleared': (0, TransactionClearedStatus_1.TransactionClearedStatusToJSON)(value.cleared),
87
69
  'approved': value.approved,
88
- 'flag_color': value.flag_color,
70
+ 'flag_color': (0, TransactionFlagColor_1.TransactionFlagColorToJSON)(value.flag_color),
89
71
  'import_id': value.import_id,
90
72
  'subtransactions': value.subtransactions === undefined ? undefined : (value.subtransactions.map(SaveSubTransaction_1.SaveSubTransactionToJSON)),
91
73
  };
@@ -10,6 +10,8 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { SaveSubTransaction } from './SaveSubTransaction';
13
+ import type { TransactionClearedStatus } from './TransactionClearedStatus';
14
+ import type { TransactionFlagColor } from './TransactionFlagColor';
13
15
  /**
14
16
  *
15
17
  * @export
@@ -65,11 +67,11 @@ export interface SaveTransactionWithId {
65
67
  */
66
68
  memo?: string | null;
67
69
  /**
68
- * The cleared status of the transaction
69
- * @type {string}
70
+ *
71
+ * @type {TransactionClearedStatus}
70
72
  * @memberof SaveTransactionWithId
71
73
  */
72
- cleared?: SaveTransactionWithIdClearedEnum;
74
+ cleared?: TransactionClearedStatus;
73
75
  /**
74
76
  * Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
75
77
  * @type {boolean}
@@ -77,11 +79,11 @@ export interface SaveTransactionWithId {
77
79
  */
78
80
  approved?: boolean;
79
81
  /**
80
- * The transaction flag
81
- * @type {string}
82
+ *
83
+ * @type {TransactionFlagColor}
82
84
  * @memberof SaveTransactionWithId
83
85
  */
84
- flag_color?: SaveTransactionWithIdFlagColorEnum;
86
+ flag_color?: TransactionFlagColor | null;
85
87
  /**
86
88
  * If specified, the new transaction will be assigned this `import_id` and considered "imported". We will also attempt to match this imported transaction to an existing "user-entered" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in 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'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a "user-entered" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
87
89
  * @type {string}
@@ -95,28 +97,6 @@ export interface SaveTransactionWithId {
95
97
  */
96
98
  subtransactions?: Array<SaveSubTransaction>;
97
99
  }
98
- /**
99
- * @export
100
- */
101
- export declare const SaveTransactionWithIdClearedEnum: {
102
- readonly Cleared: "cleared";
103
- readonly Uncleared: "uncleared";
104
- readonly Reconciled: "reconciled";
105
- };
106
- export declare type SaveTransactionWithIdClearedEnum = typeof SaveTransactionWithIdClearedEnum[keyof typeof SaveTransactionWithIdClearedEnum];
107
- /**
108
- * @export
109
- */
110
- export declare const SaveTransactionWithIdFlagColorEnum: {
111
- readonly Red: "red";
112
- readonly Orange: "orange";
113
- readonly Yellow: "yellow";
114
- readonly Green: "green";
115
- readonly Blue: "blue";
116
- readonly Purple: "purple";
117
- readonly Null: "null";
118
- };
119
- export declare type SaveTransactionWithIdFlagColorEnum = typeof SaveTransactionWithIdFlagColorEnum[keyof typeof SaveTransactionWithIdFlagColorEnum];
120
100
  /**
121
101
  * Check if a given object implements the SaveTransactionWithId interface.
122
102
  */
@@ -13,29 +13,11 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.SaveTransactionWithIdToJSON = exports.SaveTransactionWithIdFromJSONTyped = exports.SaveTransactionWithIdFromJSON = exports.instanceOfSaveTransactionWithId = exports.SaveTransactionWithIdFlagColorEnum = exports.SaveTransactionWithIdClearedEnum = void 0;
16
+ exports.SaveTransactionWithIdToJSON = exports.SaveTransactionWithIdFromJSONTyped = exports.SaveTransactionWithIdFromJSON = exports.instanceOfSaveTransactionWithId = void 0;
17
17
  const runtime_1 = require("../runtime");
18
18
  const SaveSubTransaction_1 = require("./SaveSubTransaction");
19
- /**
20
- * @export
21
- */
22
- exports.SaveTransactionWithIdClearedEnum = {
23
- Cleared: 'cleared',
24
- Uncleared: 'uncleared',
25
- Reconciled: 'reconciled'
26
- };
27
- /**
28
- * @export
29
- */
30
- exports.SaveTransactionWithIdFlagColorEnum = {
31
- Red: 'red',
32
- Orange: 'orange',
33
- Yellow: 'yellow',
34
- Green: 'green',
35
- Blue: 'blue',
36
- Purple: 'purple',
37
- Null: 'null'
38
- };
19
+ const TransactionClearedStatus_1 = require("./TransactionClearedStatus");
20
+ const TransactionFlagColor_1 = require("./TransactionFlagColor");
39
21
  /**
40
22
  * Check if a given object implements the SaveTransactionWithId interface.
41
23
  */
@@ -61,9 +43,9 @@ function SaveTransactionWithIdFromJSONTyped(json, ignoreDiscriminator) {
61
43
  'payee_name': !(0, runtime_1.exists)(json, 'payee_name') ? undefined : json['payee_name'],
62
44
  'category_id': !(0, runtime_1.exists)(json, 'category_id') ? undefined : json['category_id'],
63
45
  'memo': !(0, runtime_1.exists)(json, 'memo') ? undefined : json['memo'],
64
- 'cleared': !(0, runtime_1.exists)(json, 'cleared') ? undefined : json['cleared'],
46
+ 'cleared': !(0, runtime_1.exists)(json, 'cleared') ? undefined : (0, TransactionClearedStatus_1.TransactionClearedStatusFromJSON)(json['cleared']),
65
47
  'approved': !(0, runtime_1.exists)(json, 'approved') ? undefined : json['approved'],
66
- 'flag_color': !(0, runtime_1.exists)(json, 'flag_color') ? undefined : json['flag_color'],
48
+ 'flag_color': !(0, runtime_1.exists)(json, 'flag_color') ? undefined : (0, TransactionFlagColor_1.TransactionFlagColorFromJSON)(json['flag_color']),
67
49
  'import_id': !(0, runtime_1.exists)(json, 'import_id') ? undefined : json['import_id'],
68
50
  'subtransactions': !(0, runtime_1.exists)(json, 'subtransactions') ? undefined : (json['subtransactions'].map(SaveSubTransaction_1.SaveSubTransactionFromJSON)),
69
51
  };
@@ -85,9 +67,9 @@ function SaveTransactionWithIdToJSON(value) {
85
67
  'payee_name': value.payee_name,
86
68
  'category_id': value.category_id,
87
69
  'memo': value.memo,
88
- 'cleared': value.cleared,
70
+ 'cleared': (0, TransactionClearedStatus_1.TransactionClearedStatusToJSON)(value.cleared),
89
71
  'approved': value.approved,
90
- 'flag_color': value.flag_color,
72
+ 'flag_color': (0, TransactionFlagColor_1.TransactionFlagColorToJSON)(value.flag_color),
91
73
  'import_id': value.import_id,
92
74
  'subtransactions': value.subtransactions === undefined ? undefined : (value.subtransactions.map(SaveSubTransaction_1.SaveSubTransactionToJSON)),
93
75
  };
@@ -10,6 +10,8 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { SaveSubTransaction } from './SaveSubTransaction';
13
+ import type { TransactionClearedStatus } from './TransactionClearedStatus';
14
+ import type { TransactionFlagColor } from './TransactionFlagColor';
13
15
  /**
14
16
  *
15
17
  * @export
@@ -59,11 +61,11 @@ export interface SaveTransactionWithOptionalFields {
59
61
  */
60
62
  memo?: string | null;
61
63
  /**
62
- * The cleared status of the transaction
63
- * @type {string}
64
+ *
65
+ * @type {TransactionClearedStatus}
64
66
  * @memberof SaveTransactionWithOptionalFields
65
67
  */
66
- cleared?: SaveTransactionWithOptionalFieldsClearedEnum;
68
+ cleared?: TransactionClearedStatus;
67
69
  /**
68
70
  * Whether or not the transaction is approved. If not supplied, transaction will be unapproved by default.
69
71
  * @type {boolean}
@@ -71,11 +73,11 @@ export interface SaveTransactionWithOptionalFields {
71
73
  */
72
74
  approved?: boolean;
73
75
  /**
74
- * The transaction flag
75
- * @type {string}
76
+ *
77
+ * @type {TransactionFlagColor}
76
78
  * @memberof SaveTransactionWithOptionalFields
77
79
  */
78
- flag_color?: SaveTransactionWithOptionalFieldsFlagColorEnum;
80
+ flag_color?: TransactionFlagColor | null;
79
81
  /**
80
82
  * If specified, the new transaction will be assigned this `import_id` and considered "imported". We will also attempt to match this imported transaction to an existing "user-entered" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in 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'. Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a "user-entered" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
81
83
  * @type {string}
@@ -89,28 +91,6 @@ export interface SaveTransactionWithOptionalFields {
89
91
  */
90
92
  subtransactions?: Array<SaveSubTransaction>;
91
93
  }
92
- /**
93
- * @export
94
- */
95
- export declare const SaveTransactionWithOptionalFieldsClearedEnum: {
96
- readonly Cleared: "cleared";
97
- readonly Uncleared: "uncleared";
98
- readonly Reconciled: "reconciled";
99
- };
100
- export declare type SaveTransactionWithOptionalFieldsClearedEnum = typeof SaveTransactionWithOptionalFieldsClearedEnum[keyof typeof SaveTransactionWithOptionalFieldsClearedEnum];
101
- /**
102
- * @export
103
- */
104
- export declare const SaveTransactionWithOptionalFieldsFlagColorEnum: {
105
- readonly Red: "red";
106
- readonly Orange: "orange";
107
- readonly Yellow: "yellow";
108
- readonly Green: "green";
109
- readonly Blue: "blue";
110
- readonly Purple: "purple";
111
- readonly Null: "null";
112
- };
113
- export declare type SaveTransactionWithOptionalFieldsFlagColorEnum = typeof SaveTransactionWithOptionalFieldsFlagColorEnum[keyof typeof SaveTransactionWithOptionalFieldsFlagColorEnum];
114
94
  /**
115
95
  * Check if a given object implements the SaveTransactionWithOptionalFields interface.
116
96
  */
@@ -13,29 +13,11 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.SaveTransactionWithOptionalFieldsToJSON = exports.SaveTransactionWithOptionalFieldsFromJSONTyped = exports.SaveTransactionWithOptionalFieldsFromJSON = exports.instanceOfSaveTransactionWithOptionalFields = exports.SaveTransactionWithOptionalFieldsFlagColorEnum = exports.SaveTransactionWithOptionalFieldsClearedEnum = void 0;
16
+ exports.SaveTransactionWithOptionalFieldsToJSON = exports.SaveTransactionWithOptionalFieldsFromJSONTyped = exports.SaveTransactionWithOptionalFieldsFromJSON = exports.instanceOfSaveTransactionWithOptionalFields = void 0;
17
17
  const runtime_1 = require("../runtime");
18
18
  const SaveSubTransaction_1 = require("./SaveSubTransaction");
19
- /**
20
- * @export
21
- */
22
- exports.SaveTransactionWithOptionalFieldsClearedEnum = {
23
- Cleared: 'cleared',
24
- Uncleared: 'uncleared',
25
- Reconciled: 'reconciled'
26
- };
27
- /**
28
- * @export
29
- */
30
- exports.SaveTransactionWithOptionalFieldsFlagColorEnum = {
31
- Red: 'red',
32
- Orange: 'orange',
33
- Yellow: 'yellow',
34
- Green: 'green',
35
- Blue: 'blue',
36
- Purple: 'purple',
37
- Null: 'null'
38
- };
19
+ const TransactionClearedStatus_1 = require("./TransactionClearedStatus");
20
+ const TransactionFlagColor_1 = require("./TransactionFlagColor");
39
21
  /**
40
22
  * Check if a given object implements the SaveTransactionWithOptionalFields interface.
41
23
  */
@@ -60,9 +42,9 @@ function SaveTransactionWithOptionalFieldsFromJSONTyped(json, ignoreDiscriminato
60
42
  'payee_name': !(0, runtime_1.exists)(json, 'payee_name') ? undefined : json['payee_name'],
61
43
  'category_id': !(0, runtime_1.exists)(json, 'category_id') ? undefined : json['category_id'],
62
44
  'memo': !(0, runtime_1.exists)(json, 'memo') ? undefined : json['memo'],
63
- 'cleared': !(0, runtime_1.exists)(json, 'cleared') ? undefined : json['cleared'],
45
+ 'cleared': !(0, runtime_1.exists)(json, 'cleared') ? undefined : (0, TransactionClearedStatus_1.TransactionClearedStatusFromJSON)(json['cleared']),
64
46
  'approved': !(0, runtime_1.exists)(json, 'approved') ? undefined : json['approved'],
65
- 'flag_color': !(0, runtime_1.exists)(json, 'flag_color') ? undefined : json['flag_color'],
47
+ 'flag_color': !(0, runtime_1.exists)(json, 'flag_color') ? undefined : (0, TransactionFlagColor_1.TransactionFlagColorFromJSON)(json['flag_color']),
66
48
  'import_id': !(0, runtime_1.exists)(json, 'import_id') ? undefined : json['import_id'],
67
49
  'subtransactions': !(0, runtime_1.exists)(json, 'subtransactions') ? undefined : (json['subtransactions'].map(SaveSubTransaction_1.SaveSubTransactionFromJSON)),
68
50
  };
@@ -83,9 +65,9 @@ function SaveTransactionWithOptionalFieldsToJSON(value) {
83
65
  'payee_name': value.payee_name,
84
66
  'category_id': value.category_id,
85
67
  'memo': value.memo,
86
- 'cleared': value.cleared,
68
+ 'cleared': (0, TransactionClearedStatus_1.TransactionClearedStatusToJSON)(value.cleared),
87
69
  'approved': value.approved,
88
- 'flag_color': value.flag_color,
70
+ 'flag_color': (0, TransactionFlagColor_1.TransactionFlagColorToJSON)(value.flag_color),
89
71
  'import_id': value.import_id,
90
72
  'subtransactions': value.subtransactions === undefined ? undefined : (value.subtransactions.map(SaveSubTransaction_1.SaveSubTransactionToJSON)),
91
73
  };
@@ -0,0 +1,25 @@
1
+ /**
2
+ * YNAB API Endpoints
3
+ * 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
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * The transaction flag
14
+ * @export
15
+ * @interface SaveTransactionWithOptionalFieldsFlagColor
16
+ */
17
+ export interface SaveTransactionWithOptionalFieldsFlagColor {
18
+ }
19
+ /**
20
+ * Check if a given object implements the SaveTransactionWithOptionalFieldsFlagColor interface.
21
+ */
22
+ export declare function instanceOfSaveTransactionWithOptionalFieldsFlagColor(value: object): boolean;
23
+ export declare function SaveTransactionWithOptionalFieldsFlagColorFromJSON(json: any): SaveTransactionWithOptionalFieldsFlagColor;
24
+ export declare function SaveTransactionWithOptionalFieldsFlagColorFromJSONTyped(json: any, ignoreDiscriminator: boolean): SaveTransactionWithOptionalFieldsFlagColor;
25
+ export declare function SaveTransactionWithOptionalFieldsFlagColorToJSON(value?: SaveTransactionWithOptionalFieldsFlagColor | null): any;
@@ -0,0 +1,36 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * YNAB API Endpoints
6
+ * 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
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SaveTransactionWithOptionalFieldsFlagColorToJSON = exports.SaveTransactionWithOptionalFieldsFlagColorFromJSONTyped = exports.SaveTransactionWithOptionalFieldsFlagColorFromJSON = exports.instanceOfSaveTransactionWithOptionalFieldsFlagColor = void 0;
17
+ /**
18
+ * Check if a given object implements the SaveTransactionWithOptionalFieldsFlagColor interface.
19
+ */
20
+ function instanceOfSaveTransactionWithOptionalFieldsFlagColor(value) {
21
+ let isInstance = true;
22
+ return isInstance;
23
+ }
24
+ exports.instanceOfSaveTransactionWithOptionalFieldsFlagColor = instanceOfSaveTransactionWithOptionalFieldsFlagColor;
25
+ function SaveTransactionWithOptionalFieldsFlagColorFromJSON(json) {
26
+ return SaveTransactionWithOptionalFieldsFlagColorFromJSONTyped(json, false);
27
+ }
28
+ exports.SaveTransactionWithOptionalFieldsFlagColorFromJSON = SaveTransactionWithOptionalFieldsFlagColorFromJSON;
29
+ function SaveTransactionWithOptionalFieldsFlagColorFromJSONTyped(json, ignoreDiscriminator) {
30
+ return json;
31
+ }
32
+ exports.SaveTransactionWithOptionalFieldsFlagColorFromJSONTyped = SaveTransactionWithOptionalFieldsFlagColorFromJSONTyped;
33
+ function SaveTransactionWithOptionalFieldsFlagColorToJSON(value) {
34
+ return value;
35
+ }
36
+ exports.SaveTransactionWithOptionalFieldsFlagColorToJSON = SaveTransactionWithOptionalFieldsFlagColorToJSON;