ynab 3.1.0 → 4.1.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 (153) hide show
  1. package/README.md +1 -1
  2. package/dist/apis/AccountsApi.js +3 -3
  3. package/dist/apis/CategoriesApi.js +8 -8
  4. package/dist/apis/MoneyMovementsApi.js +4 -4
  5. package/dist/apis/MonthsApi.js +2 -2
  6. package/dist/apis/PayeeLocationsApi.js +3 -3
  7. package/dist/apis/PayeesApi.d.ts +15 -1
  8. package/dist/apis/PayeesApi.js +42 -3
  9. package/dist/apis/PlansApi.js +3 -3
  10. package/dist/apis/ScheduledTransactionsApi.js +5 -5
  11. package/dist/apis/TransactionsApi.js +11 -11
  12. package/dist/browser/ynab.js +1 -1
  13. package/dist/esm/apis/AccountsApi.js +3 -3
  14. package/dist/esm/apis/CategoriesApi.js +8 -8
  15. package/dist/esm/apis/MoneyMovementsApi.js +4 -4
  16. package/dist/esm/apis/MonthsApi.js +2 -2
  17. package/dist/esm/apis/PayeeLocationsApi.js +3 -3
  18. package/dist/esm/apis/PayeesApi.d.ts +15 -1
  19. package/dist/esm/apis/PayeesApi.js +65 -4
  20. package/dist/esm/apis/PlansApi.js +3 -3
  21. package/dist/esm/apis/ScheduledTransactionsApi.js +5 -5
  22. package/dist/esm/apis/TransactionsApi.js +11 -11
  23. package/dist/esm/models/Account.d.ts +40 -4
  24. package/dist/esm/models/Account.js +12 -0
  25. package/dist/esm/models/AccountBase.d.ts +136 -0
  26. package/dist/esm/models/AccountBase.js +92 -0
  27. package/dist/esm/models/Category.d.ts +100 -16
  28. package/dist/esm/models/Category.js +28 -0
  29. package/dist/esm/models/CategoryBase.d.ts +188 -0
  30. package/dist/esm/models/CategoryBase.js +113 -0
  31. package/dist/esm/models/ExistingCategory.d.ts +7 -1
  32. package/dist/esm/models/ExistingCategory.js +2 -0
  33. package/dist/esm/models/HybridTransaction.d.ts +12 -0
  34. package/dist/esm/models/HybridTransaction.js +4 -0
  35. package/dist/esm/models/MoneyMovement.d.ts +19 -7
  36. package/dist/esm/models/MoneyMovement.js +4 -0
  37. package/dist/esm/models/MoneyMovementBase.d.ts +75 -0
  38. package/dist/esm/models/MoneyMovementBase.js +57 -0
  39. package/dist/esm/models/MonthDetail.d.ts +48 -0
  40. package/dist/esm/models/MonthDetail.js +16 -0
  41. package/dist/esm/models/MonthDetailBase.d.ts +76 -0
  42. package/dist/esm/models/MonthDetailBase.js +68 -0
  43. package/dist/esm/models/MonthSummary.d.ts +50 -2
  44. package/dist/esm/models/MonthSummary.js +16 -0
  45. package/dist/esm/models/MonthSummaryBase.d.ts +69 -0
  46. package/dist/esm/models/MonthSummaryBase.js +63 -0
  47. package/dist/esm/models/NewCategory.d.ts +7 -1
  48. package/dist/esm/models/NewCategory.js +2 -0
  49. package/dist/esm/models/PlanDetail.d.ts +21 -21
  50. package/dist/esm/models/PlanDetail.js +21 -21
  51. package/dist/esm/models/PlanDetailResponseData.d.ts +1 -1
  52. package/dist/esm/models/PlanDetailResponseData.js +3 -3
  53. package/dist/esm/models/PlanSummaryResponseData.d.ts +2 -2
  54. package/dist/esm/models/PlanSummaryResponseData.js +5 -5
  55. package/dist/esm/models/PostPayee.d.ts +27 -0
  56. package/dist/esm/models/PostPayee.js +39 -0
  57. package/dist/esm/models/PostPayeeWrapper.d.ts +28 -0
  58. package/dist/esm/models/PostPayeeWrapper.js +40 -0
  59. package/dist/esm/models/SaveAccount.d.ts +3 -3
  60. package/dist/esm/models/SaveAccount.js +3 -3
  61. package/dist/esm/models/SaveAccountType.d.ts +24 -0
  62. package/dist/esm/models/SaveAccountType.js +42 -0
  63. package/dist/esm/models/SaveCategory.d.ts +7 -1
  64. package/dist/esm/models/SaveCategory.js +2 -0
  65. package/dist/esm/models/SavePayee.d.ts +1 -1
  66. package/dist/esm/models/ScheduledSubTransaction.d.ts +18 -6
  67. package/dist/esm/models/ScheduledSubTransaction.js +4 -0
  68. package/dist/esm/models/ScheduledSubTransactionBase.d.ts +81 -0
  69. package/dist/esm/models/ScheduledSubTransactionBase.js +63 -0
  70. package/dist/esm/models/ScheduledTransactionDetail.d.ts +12 -0
  71. package/dist/esm/models/ScheduledTransactionDetail.js +4 -0
  72. package/dist/esm/models/ScheduledTransactionSummary.d.ts +17 -5
  73. package/dist/esm/models/ScheduledTransactionSummary.js +4 -0
  74. package/dist/esm/models/ScheduledTransactionSummaryBase.d.ts +119 -0
  75. package/dist/esm/models/ScheduledTransactionSummaryBase.js +94 -0
  76. package/dist/esm/models/SubTransaction.d.ts +19 -7
  77. package/dist/esm/models/SubTransaction.js +4 -0
  78. package/dist/esm/models/SubTransactionBase.d.ts +87 -0
  79. package/dist/esm/models/SubTransactionBase.js +65 -0
  80. package/dist/esm/models/TransactionDetail.d.ts +12 -0
  81. package/dist/esm/models/TransactionDetail.js +4 -0
  82. package/dist/esm/models/TransactionSummary.d.ts +22 -10
  83. package/dist/esm/models/TransactionSummary.js +4 -0
  84. package/dist/esm/models/TransactionSummaryBase.d.ts +151 -0
  85. package/dist/esm/models/TransactionSummaryBase.js +102 -0
  86. package/dist/esm/models/index.d.ts +12 -0
  87. package/dist/esm/models/index.js +12 -0
  88. package/dist/models/Account.d.ts +40 -4
  89. package/dist/models/Account.js +12 -0
  90. package/dist/models/AccountBase.d.ts +136 -0
  91. package/dist/models/AccountBase.js +98 -0
  92. package/dist/models/Category.d.ts +100 -16
  93. package/dist/models/Category.js +28 -0
  94. package/dist/models/CategoryBase.d.ts +188 -0
  95. package/dist/models/CategoryBase.js +120 -0
  96. package/dist/models/ExistingCategory.d.ts +7 -1
  97. package/dist/models/ExistingCategory.js +2 -0
  98. package/dist/models/HybridTransaction.d.ts +12 -0
  99. package/dist/models/HybridTransaction.js +4 -0
  100. package/dist/models/MoneyMovement.d.ts +19 -7
  101. package/dist/models/MoneyMovement.js +4 -0
  102. package/dist/models/MoneyMovementBase.d.ts +75 -0
  103. package/dist/models/MoneyMovementBase.js +63 -0
  104. package/dist/models/MonthDetail.d.ts +48 -0
  105. package/dist/models/MonthDetail.js +16 -0
  106. package/dist/models/MonthDetailBase.d.ts +76 -0
  107. package/dist/models/MonthDetailBase.js +74 -0
  108. package/dist/models/MonthSummary.d.ts +50 -2
  109. package/dist/models/MonthSummary.js +16 -0
  110. package/dist/models/MonthSummaryBase.d.ts +69 -0
  111. package/dist/models/MonthSummaryBase.js +69 -0
  112. package/dist/models/NewCategory.d.ts +7 -1
  113. package/dist/models/NewCategory.js +2 -0
  114. package/dist/models/PlanDetail.d.ts +21 -21
  115. package/dist/models/PlanDetail.js +21 -21
  116. package/dist/models/PlanDetailResponseData.d.ts +1 -1
  117. package/dist/models/PlanDetailResponseData.js +3 -3
  118. package/dist/models/PlanSummaryResponseData.d.ts +2 -2
  119. package/dist/models/PlanSummaryResponseData.js +5 -5
  120. package/dist/models/PostPayee.d.ts +27 -0
  121. package/dist/models/PostPayee.js +45 -0
  122. package/dist/models/PostPayeeWrapper.d.ts +28 -0
  123. package/dist/models/PostPayeeWrapper.js +46 -0
  124. package/dist/models/SaveAccount.d.ts +3 -3
  125. package/dist/models/SaveAccount.js +3 -3
  126. package/dist/models/SaveAccountType.d.ts +24 -0
  127. package/dist/models/SaveAccountType.js +50 -0
  128. package/dist/models/SaveCategory.d.ts +7 -1
  129. package/dist/models/SaveCategory.js +2 -0
  130. package/dist/models/SavePayee.d.ts +1 -1
  131. package/dist/models/ScheduledSubTransaction.d.ts +18 -6
  132. package/dist/models/ScheduledSubTransaction.js +4 -0
  133. package/dist/models/ScheduledSubTransactionBase.d.ts +81 -0
  134. package/dist/models/ScheduledSubTransactionBase.js +69 -0
  135. package/dist/models/ScheduledTransactionDetail.d.ts +12 -0
  136. package/dist/models/ScheduledTransactionDetail.js +4 -0
  137. package/dist/models/ScheduledTransactionSummary.d.ts +17 -5
  138. package/dist/models/ScheduledTransactionSummary.js +4 -0
  139. package/dist/models/ScheduledTransactionSummaryBase.d.ts +119 -0
  140. package/dist/models/ScheduledTransactionSummaryBase.js +101 -0
  141. package/dist/models/SubTransaction.d.ts +19 -7
  142. package/dist/models/SubTransaction.js +4 -0
  143. package/dist/models/SubTransactionBase.d.ts +87 -0
  144. package/dist/models/SubTransactionBase.js +71 -0
  145. package/dist/models/TransactionDetail.d.ts +12 -0
  146. package/dist/models/TransactionDetail.js +4 -0
  147. package/dist/models/TransactionSummary.d.ts +22 -10
  148. package/dist/models/TransactionSummary.js +4 -0
  149. package/dist/models/TransactionSummaryBase.d.ts +151 -0
  150. package/dist/models/TransactionSummaryBase.js +109 -0
  151. package/dist/models/index.d.ts +12 -0
  152. package/dist/models/index.js +12 -0
  153. package/package.json +2 -2
@@ -0,0 +1,40 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * YNAB API Endpoints
5
+ * 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
6
+ *
7
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
8
+ */
9
+ import { PostPayeeFromJSON, PostPayeeToJSON, } from './PostPayee';
10
+ /**
11
+ * Check if a given object implements the PostPayeeWrapper interface.
12
+ */
13
+ export function instanceOfPostPayeeWrapper(value) {
14
+ if (!('payee' in value) || value['payee'] === undefined)
15
+ return false;
16
+ return true;
17
+ }
18
+ export function PostPayeeWrapperFromJSON(json) {
19
+ return PostPayeeWrapperFromJSONTyped(json, false);
20
+ }
21
+ export function PostPayeeWrapperFromJSONTyped(json, ignoreDiscriminator) {
22
+ if (json == null) {
23
+ return json;
24
+ }
25
+ return {
26
+ 'payee': PostPayeeFromJSON(json['payee']),
27
+ };
28
+ }
29
+ export function PostPayeeWrapperToJSON(json) {
30
+ return PostPayeeWrapperToJSONTyped(json, false);
31
+ }
32
+ export function PostPayeeWrapperToJSONTyped(value, ignoreDiscriminator) {
33
+ if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
34
+ if (value == null) {
35
+ return value;
36
+ }
37
+ return {
38
+ 'payee': PostPayeeToJSON(value['payee']),
39
+ };
40
+ }
@@ -4,7 +4,7 @@
4
4
  *
5
5
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)
6
6
  */
7
- import type { AccountType } from './AccountType';
7
+ import type { SaveAccountType } from './SaveAccountType';
8
8
  /**
9
9
  *
10
10
  * @export
@@ -19,10 +19,10 @@ export interface SaveAccount {
19
19
  name: string;
20
20
  /**
21
21
  *
22
- * @type {AccountType}
22
+ * @type {SaveAccountType}
23
23
  * @memberof SaveAccount
24
24
  */
25
- type: AccountType;
25
+ type: SaveAccountType;
26
26
  /**
27
27
  * The current balance of the account in milliunits format
28
28
  * @type {number}
@@ -6,7 +6,7 @@
6
6
  *
7
7
  * Generated by: OpenAPI Generator (https://openapi-generator.tech)
8
8
  */
9
- import { AccountTypeFromJSON, AccountTypeToJSON, } from './AccountType';
9
+ import { SaveAccountTypeFromJSON, SaveAccountTypeToJSON, } from './SaveAccountType';
10
10
  /**
11
11
  * Check if a given object implements the SaveAccount interface.
12
12
  */
@@ -28,7 +28,7 @@ export function SaveAccountFromJSONTyped(json, ignoreDiscriminator) {
28
28
  }
29
29
  return {
30
30
  'name': json['name'],
31
- 'type': AccountTypeFromJSON(json['type']),
31
+ 'type': SaveAccountTypeFromJSON(json['type']),
32
32
  'balance': json['balance'],
33
33
  };
34
34
  }
@@ -42,7 +42,7 @@ export function SaveAccountToJSONTyped(value, ignoreDiscriminator) {
42
42
  }
43
43
  return {
44
44
  'name': value['name'],
45
- 'type': AccountTypeToJSON(value['type']),
45
+ 'type': SaveAccountTypeToJSON(value['type']),
46
46
  'balance': value['balance'],
47
47
  };
48
48
  }
@@ -0,0 +1,24 @@
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
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
6
+ */
7
+ /**
8
+ * The type of account to create or update
9
+ * @export
10
+ */
11
+ export declare const SaveAccountType: {
12
+ readonly Checking: "checking";
13
+ readonly Savings: "savings";
14
+ readonly Cash: "cash";
15
+ readonly CreditCard: "creditCard";
16
+ readonly OtherAsset: "otherAsset";
17
+ readonly OtherLiability: "otherLiability";
18
+ };
19
+ export type SaveAccountType = typeof SaveAccountType[keyof typeof SaveAccountType];
20
+ export declare function instanceOfSaveAccountType(value: any): boolean;
21
+ export declare function SaveAccountTypeFromJSON(json: any): SaveAccountType;
22
+ export declare function SaveAccountTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SaveAccountType;
23
+ export declare function SaveAccountTypeToJSON(value?: SaveAccountType | null): any;
24
+ export declare function SaveAccountTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): SaveAccountType;
@@ -0,0 +1,42 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * YNAB API Endpoints
5
+ * 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
6
+ *
7
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
8
+ */
9
+ /**
10
+ * The type of account to create or update
11
+ * @export
12
+ */
13
+ export var SaveAccountType = {
14
+ Checking: 'checking',
15
+ Savings: 'savings',
16
+ Cash: 'cash',
17
+ CreditCard: 'creditCard',
18
+ OtherAsset: 'otherAsset',
19
+ OtherLiability: 'otherLiability'
20
+ };
21
+ export function instanceOfSaveAccountType(value) {
22
+ for (var key in SaveAccountType) {
23
+ if (Object.prototype.hasOwnProperty.call(SaveAccountType, key)) {
24
+ if (SaveAccountType[key] === value) {
25
+ return true;
26
+ }
27
+ }
28
+ }
29
+ return false;
30
+ }
31
+ export function SaveAccountTypeFromJSON(json) {
32
+ return SaveAccountTypeFromJSONTyped(json, false);
33
+ }
34
+ export function SaveAccountTypeFromJSONTyped(json, ignoreDiscriminator) {
35
+ return json;
36
+ }
37
+ export function SaveAccountTypeToJSON(value) {
38
+ return value;
39
+ }
40
+ export function SaveAccountTypeToJSONTyped(value, ignoreDiscriminator) {
41
+ return value;
42
+ }
@@ -29,7 +29,7 @@ export interface SaveCategory {
29
29
  */
30
30
  category_group_id?: string;
31
31
  /**
32
- * 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.
32
+ * The goal target amount in milliunits format. If value is specified and goal has not already been configured for category, a monthly goal will be created for the category with this target amount. If goal_type is not specified, it will default to 'NEED' or 'MF' for Credit Card Payment categories.
33
33
  * @type {number}
34
34
  * @memberof SaveCategory
35
35
  */
@@ -40,6 +40,12 @@ export interface SaveCategory {
40
40
  * @memberof SaveCategory
41
41
  */
42
42
  goal_target_date?: string | null;
43
+ /**
44
+ * Whether the goal requires the full target amount each period. Only supported for 'NEED' goals. When true, the goal is configured as 'Set aside another...'. When false, the goal is configured as 'Refill up to...'.
45
+ * @type {boolean}
46
+ * @memberof SaveCategory
47
+ */
48
+ goal_needs_whole_amount?: boolean | null;
43
49
  }
44
50
  /**
45
51
  * Check if a given object implements the SaveCategory interface.
@@ -25,6 +25,7 @@ export function SaveCategoryFromJSONTyped(json, ignoreDiscriminator) {
25
25
  'category_group_id': json['category_group_id'] == null ? undefined : json['category_group_id'],
26
26
  'goal_target': json['goal_target'] == null ? undefined : json['goal_target'],
27
27
  'goal_target_date': json['goal_target_date'] == null ? undefined : json['goal_target_date'],
28
+ 'goal_needs_whole_amount': json['goal_needs_whole_amount'] == null ? undefined : json['goal_needs_whole_amount'],
28
29
  };
29
30
  }
30
31
  export function SaveCategoryToJSON(json) {
@@ -41,5 +42,6 @@ export function SaveCategoryToJSONTyped(value, ignoreDiscriminator) {
41
42
  'category_group_id': value['category_group_id'],
42
43
  'goal_target': value['goal_target'],
43
44
  'goal_target_date': value['goal_target_date'],
45
+ 'goal_needs_whole_amount': value['goal_needs_whole_amount'],
44
46
  };
45
47
  }
@@ -11,7 +11,7 @@
11
11
  */
12
12
  export interface SavePayee {
13
13
  /**
14
- * The name of the payee. The name must be a maximum of 500 characters.
14
+ * The name of the payee.
15
15
  * @type {string}
16
16
  * @memberof SavePayee
17
17
  */
@@ -33,43 +33,55 @@ export interface ScheduledSubTransaction {
33
33
  * @type {string}
34
34
  * @memberof ScheduledSubTransaction
35
35
  */
36
- memo?: string | null;
36
+ memo?: string;
37
37
  /**
38
38
  *
39
39
  * @type {string}
40
40
  * @memberof ScheduledSubTransaction
41
41
  */
42
- payee_id?: string | null;
42
+ payee_id?: string;
43
43
  /**
44
44
  *
45
45
  * @type {string}
46
46
  * @memberof ScheduledSubTransaction
47
47
  */
48
- payee_name?: string | null;
48
+ payee_name?: string;
49
49
  /**
50
50
  *
51
51
  * @type {string}
52
52
  * @memberof ScheduledSubTransaction
53
53
  */
54
- category_id?: string | null;
54
+ category_id?: string;
55
55
  /**
56
56
  *
57
57
  * @type {string}
58
58
  * @memberof ScheduledSubTransaction
59
59
  */
60
- category_name?: string | null;
60
+ category_name?: string;
61
61
  /**
62
62
  * If a transfer, the account_id which the scheduled subtransaction transfers to
63
63
  * @type {string}
64
64
  * @memberof ScheduledSubTransaction
65
65
  */
66
- transfer_account_id?: string | null;
66
+ transfer_account_id?: string;
67
67
  /**
68
68
  * Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests.
69
69
  * @type {boolean}
70
70
  * @memberof ScheduledSubTransaction
71
71
  */
72
72
  deleted: boolean;
73
+ /**
74
+ * The scheduled subtransaction amount formatted in the plan's currency format
75
+ * @type {string}
76
+ * @memberof ScheduledSubTransaction
77
+ */
78
+ amount_formatted?: string;
79
+ /**
80
+ * The scheduled subtransaction amount as a decimal currency amount
81
+ * @type {number}
82
+ * @memberof ScheduledSubTransaction
83
+ */
84
+ amount_currency?: number;
73
85
  }
74
86
  /**
75
87
  * Check if a given object implements the ScheduledSubTransaction interface.
@@ -38,6 +38,8 @@ export function ScheduledSubTransactionFromJSONTyped(json, ignoreDiscriminator)
38
38
  'category_name': json['category_name'] == null ? undefined : json['category_name'],
39
39
  'transfer_account_id': json['transfer_account_id'] == null ? undefined : json['transfer_account_id'],
40
40
  'deleted': json['deleted'],
41
+ 'amount_formatted': json['amount_formatted'] == null ? undefined : json['amount_formatted'],
42
+ 'amount_currency': json['amount_currency'] == null ? undefined : json['amount_currency'],
41
43
  };
42
44
  }
43
45
  export function ScheduledSubTransactionToJSON(json) {
@@ -59,5 +61,7 @@ export function ScheduledSubTransactionToJSONTyped(value, ignoreDiscriminator) {
59
61
  'category_name': value['category_name'],
60
62
  'transfer_account_id': value['transfer_account_id'],
61
63
  'deleted': value['deleted'],
64
+ 'amount_formatted': value['amount_formatted'],
65
+ 'amount_currency': value['amount_currency'],
62
66
  };
63
67
  }
@@ -0,0 +1,81 @@
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
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
6
+ */
7
+ /**
8
+ *
9
+ * @export
10
+ * @interface ScheduledSubTransactionBase
11
+ */
12
+ export interface ScheduledSubTransactionBase {
13
+ /**
14
+ *
15
+ * @type {string}
16
+ * @memberof ScheduledSubTransactionBase
17
+ */
18
+ id: string;
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof ScheduledSubTransactionBase
23
+ */
24
+ scheduled_transaction_id: string;
25
+ /**
26
+ * The scheduled subtransaction amount in milliunits format
27
+ * @type {number}
28
+ * @memberof ScheduledSubTransactionBase
29
+ */
30
+ amount: number;
31
+ /**
32
+ *
33
+ * @type {string}
34
+ * @memberof ScheduledSubTransactionBase
35
+ */
36
+ memo?: string | null;
37
+ /**
38
+ *
39
+ * @type {string}
40
+ * @memberof ScheduledSubTransactionBase
41
+ */
42
+ payee_id?: string | null;
43
+ /**
44
+ *
45
+ * @type {string}
46
+ * @memberof ScheduledSubTransactionBase
47
+ */
48
+ payee_name?: string | null;
49
+ /**
50
+ *
51
+ * @type {string}
52
+ * @memberof ScheduledSubTransactionBase
53
+ */
54
+ category_id?: string | null;
55
+ /**
56
+ *
57
+ * @type {string}
58
+ * @memberof ScheduledSubTransactionBase
59
+ */
60
+ category_name?: string | null;
61
+ /**
62
+ * If a transfer, the account_id which the scheduled subtransaction transfers to
63
+ * @type {string}
64
+ * @memberof ScheduledSubTransactionBase
65
+ */
66
+ transfer_account_id?: string | null;
67
+ /**
68
+ * Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests.
69
+ * @type {boolean}
70
+ * @memberof ScheduledSubTransactionBase
71
+ */
72
+ deleted: boolean;
73
+ }
74
+ /**
75
+ * Check if a given object implements the ScheduledSubTransactionBase interface.
76
+ */
77
+ export declare function instanceOfScheduledSubTransactionBase(value: object): value is ScheduledSubTransactionBase;
78
+ export declare function ScheduledSubTransactionBaseFromJSON(json: any): ScheduledSubTransactionBase;
79
+ export declare function ScheduledSubTransactionBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScheduledSubTransactionBase;
80
+ export declare function ScheduledSubTransactionBaseToJSON(json: any): ScheduledSubTransactionBase;
81
+ export declare function ScheduledSubTransactionBaseToJSONTyped(value?: ScheduledSubTransactionBase | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,63 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * YNAB API Endpoints
5
+ * 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
6
+ *
7
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
8
+ */
9
+ /**
10
+ * Check if a given object implements the ScheduledSubTransactionBase interface.
11
+ */
12
+ export function instanceOfScheduledSubTransactionBase(value) {
13
+ if (!('id' in value) || value['id'] === undefined)
14
+ return false;
15
+ if (!('scheduled_transaction_id' in value) || value['scheduled_transaction_id'] === undefined)
16
+ return false;
17
+ if (!('amount' in value) || value['amount'] === undefined)
18
+ return false;
19
+ if (!('deleted' in value) || value['deleted'] === undefined)
20
+ return false;
21
+ return true;
22
+ }
23
+ export function ScheduledSubTransactionBaseFromJSON(json) {
24
+ return ScheduledSubTransactionBaseFromJSONTyped(json, false);
25
+ }
26
+ export function ScheduledSubTransactionBaseFromJSONTyped(json, ignoreDiscriminator) {
27
+ if (json == null) {
28
+ return json;
29
+ }
30
+ return {
31
+ 'id': json['id'],
32
+ 'scheduled_transaction_id': json['scheduled_transaction_id'],
33
+ 'amount': json['amount'],
34
+ 'memo': json['memo'] == null ? undefined : json['memo'],
35
+ 'payee_id': json['payee_id'] == null ? undefined : json['payee_id'],
36
+ 'payee_name': json['payee_name'] == null ? undefined : json['payee_name'],
37
+ 'category_id': json['category_id'] == null ? undefined : json['category_id'],
38
+ 'category_name': json['category_name'] == null ? undefined : json['category_name'],
39
+ 'transfer_account_id': json['transfer_account_id'] == null ? undefined : json['transfer_account_id'],
40
+ 'deleted': json['deleted'],
41
+ };
42
+ }
43
+ export function ScheduledSubTransactionBaseToJSON(json) {
44
+ return ScheduledSubTransactionBaseToJSONTyped(json, false);
45
+ }
46
+ export function ScheduledSubTransactionBaseToJSONTyped(value, ignoreDiscriminator) {
47
+ if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
48
+ if (value == null) {
49
+ return value;
50
+ }
51
+ return {
52
+ 'id': value['id'],
53
+ 'scheduled_transaction_id': value['scheduled_transaction_id'],
54
+ 'amount': value['amount'],
55
+ 'memo': value['memo'],
56
+ 'payee_id': value['payee_id'],
57
+ 'payee_name': value['payee_name'],
58
+ 'category_id': value['category_id'],
59
+ 'category_name': value['category_name'],
60
+ 'transfer_account_id': value['transfer_account_id'],
61
+ 'deleted': value['deleted'],
62
+ };
63
+ }
@@ -90,6 +90,18 @@ export interface ScheduledTransactionDetail {
90
90
  * @memberof ScheduledTransactionDetail
91
91
  */
92
92
  deleted: boolean;
93
+ /**
94
+ * The scheduled transaction amount formatted in the plan's currency format
95
+ * @type {string}
96
+ * @memberof ScheduledTransactionDetail
97
+ */
98
+ amount_formatted?: string;
99
+ /**
100
+ * The scheduled transaction amount as a decimal currency amount
101
+ * @type {number}
102
+ * @memberof ScheduledTransactionDetail
103
+ */
104
+ amount_currency?: number;
93
105
  /**
94
106
  *
95
107
  * @type {string}
@@ -71,6 +71,8 @@ export function ScheduledTransactionDetailFromJSONTyped(json, ignoreDiscriminato
71
71
  'category_id': json['category_id'] == null ? undefined : json['category_id'],
72
72
  'transfer_account_id': json['transfer_account_id'] == null ? undefined : json['transfer_account_id'],
73
73
  'deleted': json['deleted'],
74
+ 'amount_formatted': json['amount_formatted'] == null ? undefined : json['amount_formatted'],
75
+ 'amount_currency': json['amount_currency'] == null ? undefined : json['amount_currency'],
74
76
  'account_name': json['account_name'],
75
77
  'payee_name': json['payee_name'] == null ? undefined : json['payee_name'],
76
78
  'category_name': json['category_name'] == null ? undefined : json['category_name'],
@@ -99,6 +101,8 @@ export function ScheduledTransactionDetailToJSONTyped(value, ignoreDiscriminator
99
101
  'category_id': value['category_id'],
100
102
  'transfer_account_id': value['transfer_account_id'],
101
103
  'deleted': value['deleted'],
104
+ 'amount_formatted': value['amount_formatted'],
105
+ 'amount_currency': value['amount_currency'],
102
106
  'account_name': value['account_name'],
103
107
  'payee_name': value['payee_name'],
104
108
  'category_name': value['category_name'],
@@ -46,7 +46,7 @@ export interface ScheduledTransactionSummary {
46
46
  * @type {string}
47
47
  * @memberof ScheduledTransactionSummary
48
48
  */
49
- memo?: string | null;
49
+ memo?: string;
50
50
  /**
51
51
  *
52
52
  * @type {TransactionFlagColor}
@@ -58,7 +58,7 @@ export interface ScheduledTransactionSummary {
58
58
  * @type {string}
59
59
  * @memberof ScheduledTransactionSummary
60
60
  */
61
- flag_name?: string | null;
61
+ flag_name?: string;
62
62
  /**
63
63
  *
64
64
  * @type {string}
@@ -70,25 +70,37 @@ export interface ScheduledTransactionSummary {
70
70
  * @type {string}
71
71
  * @memberof ScheduledTransactionSummary
72
72
  */
73
- payee_id?: string | null;
73
+ payee_id?: string;
74
74
  /**
75
75
  *
76
76
  * @type {string}
77
77
  * @memberof ScheduledTransactionSummary
78
78
  */
79
- category_id?: string | null;
79
+ category_id?: string;
80
80
  /**
81
81
  * If a transfer, the account_id which the scheduled transaction transfers to
82
82
  * @type {string}
83
83
  * @memberof ScheduledTransactionSummary
84
84
  */
85
- transfer_account_id?: string | null;
85
+ transfer_account_id?: string;
86
86
  /**
87
87
  * Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests.
88
88
  * @type {boolean}
89
89
  * @memberof ScheduledTransactionSummary
90
90
  */
91
91
  deleted: boolean;
92
+ /**
93
+ * The scheduled transaction amount formatted in the plan's currency format
94
+ * @type {string}
95
+ * @memberof ScheduledTransactionSummary
96
+ */
97
+ amount_formatted?: string;
98
+ /**
99
+ * The scheduled transaction amount as a decimal currency amount
100
+ * @type {number}
101
+ * @memberof ScheduledTransactionSummary
102
+ */
103
+ amount_currency?: number;
92
104
  }
93
105
  /**
94
106
  * @export
@@ -66,6 +66,8 @@ export function ScheduledTransactionSummaryFromJSONTyped(json, ignoreDiscriminat
66
66
  'category_id': json['category_id'] == null ? undefined : json['category_id'],
67
67
  'transfer_account_id': json['transfer_account_id'] == null ? undefined : json['transfer_account_id'],
68
68
  'deleted': json['deleted'],
69
+ 'amount_formatted': json['amount_formatted'] == null ? undefined : json['amount_formatted'],
70
+ 'amount_currency': json['amount_currency'] == null ? undefined : json['amount_currency'],
69
71
  };
70
72
  }
71
73
  export function ScheduledTransactionSummaryToJSON(json) {
@@ -90,5 +92,7 @@ export function ScheduledTransactionSummaryToJSONTyped(value, ignoreDiscriminato
90
92
  'category_id': value['category_id'],
91
93
  'transfer_account_id': value['transfer_account_id'],
92
94
  'deleted': value['deleted'],
95
+ 'amount_formatted': value['amount_formatted'],
96
+ 'amount_currency': value['amount_currency'],
93
97
  };
94
98
  }
@@ -0,0 +1,119 @@
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
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
6
+ */
7
+ import type { TransactionFlagColor } from './TransactionFlagColor';
8
+ /**
9
+ *
10
+ * @export
11
+ * @interface ScheduledTransactionSummaryBase
12
+ */
13
+ export interface ScheduledTransactionSummaryBase {
14
+ /**
15
+ *
16
+ * @type {string}
17
+ * @memberof ScheduledTransactionSummaryBase
18
+ */
19
+ id: string;
20
+ /**
21
+ * The first date for which the Scheduled Transaction was scheduled.
22
+ * @type {string}
23
+ * @memberof ScheduledTransactionSummaryBase
24
+ */
25
+ date_first: string;
26
+ /**
27
+ * The next date for which the Scheduled Transaction is scheduled.
28
+ * @type {string}
29
+ * @memberof ScheduledTransactionSummaryBase
30
+ */
31
+ date_next: string;
32
+ /**
33
+ *
34
+ * @type {ScheduledTransactionSummaryBaseFrequencyEnum}
35
+ * @memberof ScheduledTransactionSummaryBase
36
+ */
37
+ frequency: ScheduledTransactionSummaryBaseFrequencyEnum;
38
+ /**
39
+ * The scheduled transaction amount in milliunits format
40
+ * @type {number}
41
+ * @memberof ScheduledTransactionSummaryBase
42
+ */
43
+ amount: number;
44
+ /**
45
+ *
46
+ * @type {string}
47
+ * @memberof ScheduledTransactionSummaryBase
48
+ */
49
+ memo?: string | null;
50
+ /**
51
+ *
52
+ * @type {TransactionFlagColor}
53
+ * @memberof ScheduledTransactionSummaryBase
54
+ */
55
+ flag_color?: TransactionFlagColor | null;
56
+ /**
57
+ * The customized name of a transaction flag
58
+ * @type {string}
59
+ * @memberof ScheduledTransactionSummaryBase
60
+ */
61
+ flag_name?: string | null;
62
+ /**
63
+ *
64
+ * @type {string}
65
+ * @memberof ScheduledTransactionSummaryBase
66
+ */
67
+ account_id: string;
68
+ /**
69
+ *
70
+ * @type {string}
71
+ * @memberof ScheduledTransactionSummaryBase
72
+ */
73
+ payee_id?: string | null;
74
+ /**
75
+ *
76
+ * @type {string}
77
+ * @memberof ScheduledTransactionSummaryBase
78
+ */
79
+ category_id?: string | null;
80
+ /**
81
+ * If a transfer, the account_id which the scheduled transaction transfers to
82
+ * @type {string}
83
+ * @memberof ScheduledTransactionSummaryBase
84
+ */
85
+ transfer_account_id?: string | null;
86
+ /**
87
+ * Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests.
88
+ * @type {boolean}
89
+ * @memberof ScheduledTransactionSummaryBase
90
+ */
91
+ deleted: boolean;
92
+ }
93
+ /**
94
+ * @export
95
+ */
96
+ export declare const ScheduledTransactionSummaryBaseFrequencyEnum: {
97
+ readonly Never: "never";
98
+ readonly Daily: "daily";
99
+ readonly Weekly: "weekly";
100
+ readonly EveryOtherWeek: "everyOtherWeek";
101
+ readonly TwiceAMonth: "twiceAMonth";
102
+ readonly Every4Weeks: "every4Weeks";
103
+ readonly Monthly: "monthly";
104
+ readonly EveryOtherMonth: "everyOtherMonth";
105
+ readonly Every3Months: "every3Months";
106
+ readonly Every4Months: "every4Months";
107
+ readonly TwiceAYear: "twiceAYear";
108
+ readonly Yearly: "yearly";
109
+ readonly EveryOtherYear: "everyOtherYear";
110
+ };
111
+ export type ScheduledTransactionSummaryBaseFrequencyEnum = typeof ScheduledTransactionSummaryBaseFrequencyEnum[keyof typeof ScheduledTransactionSummaryBaseFrequencyEnum];
112
+ /**
113
+ * Check if a given object implements the ScheduledTransactionSummaryBase interface.
114
+ */
115
+ export declare function instanceOfScheduledTransactionSummaryBase(value: object): value is ScheduledTransactionSummaryBase;
116
+ export declare function ScheduledTransactionSummaryBaseFromJSON(json: any): ScheduledTransactionSummaryBase;
117
+ export declare function ScheduledTransactionSummaryBaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScheduledTransactionSummaryBase;
118
+ export declare function ScheduledTransactionSummaryBaseToJSON(json: any): ScheduledTransactionSummaryBase;
119
+ export declare function ScheduledTransactionSummaryBaseToJSONTyped(value?: ScheduledTransactionSummaryBase | null, ignoreDiscriminator?: boolean): any;