ynab 2.2.0 → 2.4.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 (215) hide show
  1. package/README.md +2 -0
  2. package/dist/apis/AccountsApi.d.ts +1 -6
  3. package/dist/apis/AccountsApi.js +1 -6
  4. package/dist/apis/BudgetsApi.d.ts +1 -6
  5. package/dist/apis/BudgetsApi.js +1 -6
  6. package/dist/apis/CategoriesApi.d.ts +1 -6
  7. package/dist/apis/CategoriesApi.js +1 -6
  8. package/dist/apis/MonthsApi.d.ts +1 -6
  9. package/dist/apis/MonthsApi.js +1 -6
  10. package/dist/apis/PayeeLocationsApi.d.ts +1 -6
  11. package/dist/apis/PayeeLocationsApi.js +1 -6
  12. package/dist/apis/PayeesApi.d.ts +17 -7
  13. package/dist/apis/PayeesApi.js +43 -6
  14. package/dist/apis/ScheduledTransactionsApi.d.ts +16 -7
  15. package/dist/apis/ScheduledTransactionsApi.js +40 -6
  16. package/dist/apis/TransactionsApi.d.ts +36 -16
  17. package/dist/apis/TransactionsApi.js +65 -17
  18. package/dist/apis/UserApi.d.ts +1 -6
  19. package/dist/apis/UserApi.js +1 -6
  20. package/dist/browser/ynab.js +1 -1
  21. package/dist/models/Account.d.ts +2 -7
  22. package/dist/models/Account.js +51 -51
  23. package/dist/models/AccountResponse.d.ts +2 -7
  24. package/dist/models/AccountResponse.js +8 -16
  25. package/dist/models/AccountResponseData.d.ts +2 -7
  26. package/dist/models/AccountResponseData.js +8 -16
  27. package/dist/models/AccountType.d.ts +2 -6
  28. package/dist/models/AccountType.js +13 -7
  29. package/dist/models/AccountsResponse.d.ts +2 -7
  30. package/dist/models/AccountsResponse.js +8 -16
  31. package/dist/models/AccountsResponseData.d.ts +2 -7
  32. package/dist/models/AccountsResponseData.js +11 -18
  33. package/dist/models/BudgetDetail.d.ts +6 -11
  34. package/dist/models/BudgetDetail.js +45 -53
  35. package/dist/models/BudgetDetailResponse.d.ts +2 -7
  36. package/dist/models/BudgetDetailResponse.js +8 -16
  37. package/dist/models/BudgetDetailResponseData.d.ts +2 -7
  38. package/dist/models/BudgetDetailResponseData.js +11 -18
  39. package/dist/models/BudgetSettings.d.ts +2 -7
  40. package/dist/models/BudgetSettings.js +11 -18
  41. package/dist/models/BudgetSettingsResponse.d.ts +2 -7
  42. package/dist/models/BudgetSettingsResponse.js +8 -16
  43. package/dist/models/BudgetSettingsResponseData.d.ts +2 -7
  44. package/dist/models/BudgetSettingsResponseData.js +8 -16
  45. package/dist/models/BudgetSummary.d.ts +2 -7
  46. package/dist/models/BudgetSummary.js +23 -31
  47. package/dist/models/BudgetSummaryResponse.d.ts +2 -7
  48. package/dist/models/BudgetSummaryResponse.js +8 -16
  49. package/dist/models/BudgetSummaryResponseData.d.ts +2 -7
  50. package/dist/models/BudgetSummaryResponseData.js +10 -19
  51. package/dist/models/BulkResponse.d.ts +2 -7
  52. package/dist/models/BulkResponse.js +8 -16
  53. package/dist/models/BulkResponseData.d.ts +2 -7
  54. package/dist/models/BulkResponseData.js +8 -16
  55. package/dist/models/BulkResponseDataBulk.d.ts +2 -7
  56. package/dist/models/BulkResponseDataBulk.js +11 -18
  57. package/dist/models/BulkTransactions.d.ts +5 -10
  58. package/dist/models/BulkTransactions.js +10 -18
  59. package/dist/models/CategoriesResponse.d.ts +2 -7
  60. package/dist/models/CategoriesResponse.js +8 -16
  61. package/dist/models/CategoriesResponseData.d.ts +2 -7
  62. package/dist/models/CategoriesResponseData.js +11 -18
  63. package/dist/models/Category.d.ts +9 -8
  64. package/dist/models/Category.js +61 -61
  65. package/dist/models/CategoryGroup.d.ts +2 -7
  66. package/dist/models/CategoryGroup.js +17 -22
  67. package/dist/models/CategoryGroupWithCategories.d.ts +2 -7
  68. package/dist/models/CategoryGroupWithCategories.js +20 -24
  69. package/dist/models/CategoryResponse.d.ts +2 -7
  70. package/dist/models/CategoryResponse.js +8 -16
  71. package/dist/models/CategoryResponseData.d.ts +2 -7
  72. package/dist/models/CategoryResponseData.js +8 -16
  73. package/dist/models/CurrencyFormat.d.ts +2 -7
  74. package/dist/models/CurrencyFormat.js +29 -30
  75. package/dist/models/DateFormat.d.ts +2 -7
  76. package/dist/models/DateFormat.js +8 -16
  77. package/dist/models/ErrorDetail.d.ts +2 -7
  78. package/dist/models/ErrorDetail.js +14 -20
  79. package/dist/models/ErrorResponse.d.ts +2 -7
  80. package/dist/models/ErrorResponse.js +8 -16
  81. package/dist/models/ExistingTransaction.d.ts +89 -0
  82. package/dist/models/ExistingTransaction.js +63 -0
  83. package/dist/models/HybridTransaction.d.ts +10 -9
  84. package/dist/models/HybridTransaction.js +63 -62
  85. package/dist/models/HybridTransactionsResponse.d.ts +2 -7
  86. package/dist/models/HybridTransactionsResponse.js +8 -16
  87. package/dist/models/HybridTransactionsResponseData.d.ts +2 -7
  88. package/dist/models/HybridTransactionsResponseData.js +10 -19
  89. package/dist/models/MonthDetail.d.ts +2 -7
  90. package/dist/models/MonthDetail.js +30 -33
  91. package/dist/models/MonthDetailResponse.d.ts +2 -7
  92. package/dist/models/MonthDetailResponse.js +8 -16
  93. package/dist/models/MonthDetailResponseData.d.ts +2 -7
  94. package/dist/models/MonthDetailResponseData.js +8 -16
  95. package/dist/models/MonthSummariesResponse.d.ts +2 -7
  96. package/dist/models/MonthSummariesResponse.js +8 -16
  97. package/dist/models/MonthSummariesResponseData.d.ts +2 -7
  98. package/dist/models/MonthSummariesResponseData.js +11 -18
  99. package/dist/models/MonthSummary.d.ts +2 -7
  100. package/dist/models/MonthSummary.js +27 -31
  101. package/dist/models/NewTransaction.d.ts +95 -0
  102. package/dist/models/NewTransaction.js +65 -0
  103. package/dist/models/PatchCategoryWrapper.d.ts +2 -7
  104. package/dist/models/PatchCategoryWrapper.js +8 -16
  105. package/dist/models/PatchMonthCategoryWrapper.d.ts +2 -7
  106. package/dist/models/PatchMonthCategoryWrapper.js +8 -16
  107. package/dist/models/PatchPayeeWrapper.d.ts +27 -0
  108. package/dist/models/PatchPayeeWrapper.js +43 -0
  109. package/dist/models/PatchTransactionsWrapper.d.ts +5 -10
  110. package/dist/models/PatchTransactionsWrapper.js +10 -18
  111. package/dist/models/Payee.d.ts +2 -7
  112. package/dist/models/Payee.js +16 -23
  113. package/dist/models/PayeeLocation.d.ts +2 -7
  114. package/dist/models/PayeeLocation.js +20 -24
  115. package/dist/models/PayeeLocationResponse.d.ts +2 -7
  116. package/dist/models/PayeeLocationResponse.js +8 -16
  117. package/dist/models/PayeeLocationResponseData.d.ts +2 -7
  118. package/dist/models/PayeeLocationResponseData.js +8 -16
  119. package/dist/models/PayeeLocationsResponse.d.ts +2 -7
  120. package/dist/models/PayeeLocationsResponse.js +8 -16
  121. package/dist/models/PayeeLocationsResponseData.d.ts +2 -7
  122. package/dist/models/PayeeLocationsResponseData.js +8 -16
  123. package/dist/models/PayeeResponse.d.ts +2 -7
  124. package/dist/models/PayeeResponse.js +8 -16
  125. package/dist/models/PayeeResponseData.d.ts +2 -7
  126. package/dist/models/PayeeResponseData.js +8 -16
  127. package/dist/models/PayeesResponse.d.ts +2 -7
  128. package/dist/models/PayeesResponse.js +8 -16
  129. package/dist/models/PayeesResponseData.d.ts +2 -7
  130. package/dist/models/PayeesResponseData.js +11 -18
  131. package/dist/models/PostAccountWrapper.d.ts +2 -7
  132. package/dist/models/PostAccountWrapper.js +8 -16
  133. package/dist/models/PostScheduledTransactionWrapper.d.ts +27 -0
  134. package/dist/models/PostScheduledTransactionWrapper.js +43 -0
  135. package/dist/models/PostTransactionsWrapper.d.ts +7 -12
  136. package/dist/models/PostTransactionsWrapper.js +10 -20
  137. package/dist/models/PutTransactionWrapper.d.ts +5 -10
  138. package/dist/models/PutTransactionWrapper.js +10 -18
  139. package/dist/models/SaveAccount.d.ts +2 -7
  140. package/dist/models/SaveAccount.js +14 -20
  141. package/dist/models/SaveCategory.d.ts +2 -7
  142. package/dist/models/SaveCategory.js +11 -21
  143. package/dist/models/SaveCategoryResponse.d.ts +2 -7
  144. package/dist/models/SaveCategoryResponse.js +8 -16
  145. package/dist/models/SaveCategoryResponseData.d.ts +2 -7
  146. package/dist/models/SaveCategoryResponseData.js +11 -18
  147. package/dist/models/SaveMonthCategory.d.ts +2 -7
  148. package/dist/models/SaveMonthCategory.js +8 -16
  149. package/dist/models/SavePayee.d.ts +26 -0
  150. package/dist/models/SavePayee.js +40 -0
  151. package/dist/models/SavePayeeResponse.d.ts +27 -0
  152. package/dist/models/SavePayeeResponse.js +43 -0
  153. package/dist/models/SavePayeeResponseData.d.ts +33 -0
  154. package/dist/models/SavePayeeResponseData.js +47 -0
  155. package/dist/models/SaveScheduledTransaction.d.ts +76 -0
  156. package/dist/models/SaveScheduledTransaction.js +62 -0
  157. package/dist/models/SaveSubTransaction.d.ts +2 -7
  158. package/dist/models/SaveSubTransaction.js +16 -25
  159. package/dist/models/SaveTransactionWithIdOrImportId.d.ts +101 -0
  160. package/dist/models/SaveTransactionWithIdOrImportId.js +67 -0
  161. package/dist/models/SaveTransactionWithOptionalFields.d.ts +5 -16
  162. package/dist/models/SaveTransactionWithOptionalFields.js +29 -41
  163. package/dist/models/SaveTransactionsResponse.d.ts +2 -7
  164. package/dist/models/SaveTransactionsResponse.js +8 -16
  165. package/dist/models/SaveTransactionsResponseData.d.ts +2 -7
  166. package/dist/models/SaveTransactionsResponseData.js +17 -25
  167. package/dist/models/ScheduledSubTransaction.d.ts +2 -7
  168. package/dist/models/ScheduledSubTransaction.js +25 -31
  169. package/dist/models/ScheduledTransactionDetail.d.ts +9 -8
  170. package/dist/models/ScheduledTransactionDetail.js +49 -48
  171. package/dist/models/ScheduledTransactionFrequency.d.ts +30 -0
  172. package/dist/models/ScheduledTransactionFrequency.js +53 -0
  173. package/dist/models/ScheduledTransactionResponse.d.ts +2 -7
  174. package/dist/models/ScheduledTransactionResponse.js +8 -16
  175. package/dist/models/ScheduledTransactionResponseData.d.ts +2 -7
  176. package/dist/models/ScheduledTransactionResponseData.js +8 -16
  177. package/dist/models/ScheduledTransactionSummary.d.ts +8 -7
  178. package/dist/models/ScheduledTransactionSummary.js +38 -39
  179. package/dist/models/ScheduledTransactionsResponse.d.ts +2 -7
  180. package/dist/models/ScheduledTransactionsResponse.js +8 -16
  181. package/dist/models/ScheduledTransactionsResponseData.d.ts +2 -7
  182. package/dist/models/ScheduledTransactionsResponseData.js +11 -18
  183. package/dist/models/SubTransaction.d.ts +2 -7
  184. package/dist/models/SubTransaction.js +31 -37
  185. package/dist/models/TransactionClearedStatus.d.ts +2 -6
  186. package/dist/models/TransactionClearedStatus.js +13 -7
  187. package/dist/models/TransactionDetail.d.ts +11 -10
  188. package/dist/models/TransactionDetail.js +62 -61
  189. package/dist/models/TransactionFlagColor.d.ts +2 -6
  190. package/dist/models/TransactionFlagColor.js +13 -7
  191. package/dist/models/TransactionResponse.d.ts +2 -7
  192. package/dist/models/TransactionResponse.js +8 -16
  193. package/dist/models/TransactionResponseData.d.ts +2 -7
  194. package/dist/models/TransactionResponseData.js +8 -16
  195. package/dist/models/TransactionSummary.d.ts +10 -9
  196. package/dist/models/TransactionSummary.js +51 -52
  197. package/dist/models/TransactionsImportResponse.d.ts +2 -7
  198. package/dist/models/TransactionsImportResponse.js +8 -16
  199. package/dist/models/TransactionsImportResponseData.d.ts +2 -7
  200. package/dist/models/TransactionsImportResponseData.js +8 -16
  201. package/dist/models/TransactionsResponse.d.ts +2 -7
  202. package/dist/models/TransactionsResponse.js +8 -16
  203. package/dist/models/TransactionsResponseData.d.ts +2 -7
  204. package/dist/models/TransactionsResponseData.js +11 -18
  205. package/dist/models/User.d.ts +2 -7
  206. package/dist/models/User.js +8 -16
  207. package/dist/models/UserResponse.d.ts +2 -7
  208. package/dist/models/UserResponse.js +8 -16
  209. package/dist/models/UserResponseData.d.ts +2 -7
  210. package/dist/models/UserResponseData.js +8 -16
  211. package/dist/models/index.d.ts +10 -9
  212. package/dist/models/index.js +10 -9
  213. package/dist/runtime.d.ts +1 -6
  214. package/dist/runtime.js +1 -6
  215. package/package.json +1 -1
package/README.md CHANGED
@@ -142,6 +142,7 @@ The following methods are available in this library.
142
142
  | **Transactions** | [transactions.getTransactions(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/TransactionsApi.d.ts) | Returns budget transactions |
143
143
  | | [transactions.getTransactionsByAccount(budget_id, account_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/TransactionsApi.d.ts) | Returns all transactions for a specified account |
144
144
  | | [transactions.getTransactionsByCategory(budget_id, category_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/TransactionsApi.d.ts) | Returns all transactions for a specified category |
145
+ | | [transactions.getTransactionsByMonth(budget_id, month)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/TransactionsApi.d.ts) | Returns all transactions for a specified month |
145
146
  | | [transactions.getTransactionsByType(budget_id, type)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/TransactionsApi.d.ts) | Returns all transactions of a specified type ("unapproved" or "uncategorized") |
146
147
  | | [transactions.getTransactionById(budget_id, transaction_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/TransactionsApi.d.ts) | Returns a single transaction |
147
148
  | | [transactions.createTransaction(budget_id, data)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/TransactionsApi.d.ts) | Creates a single transaction |
@@ -152,6 +153,7 @@ The following methods are available in this library.
152
153
  | | [transactions.importTransactions(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/TransactionsApi.d.ts) | Imports transactions |
153
154
  | **Scheduled Transactions** | [scheduled_transactions.getScheduledTransactions(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/ScheduledTransactionsApi.d.ts) | Returns all scheduled transactions |
154
155
  | | [scheduled_transactions.getScheduledTransactionById(budget_id, scheduled_transaction_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/ScheduledTransactionsApi.d.ts) | Returns a single scheduled transaction |
156
+ | | [scheduled_transactions.createScheduledTransaction(budget_id, data)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/apis/ScheduledTransactionsApi.d.ts) | Creates a single scheduled transaction |
155
157
 
156
158
  ### Utilities
157
159
 
@@ -2,12 +2,7 @@
2
2
  * YNAB API Endpoints
3
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
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.
5
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
11
6
  */
12
7
  import * as runtime from '../runtime';
13
8
  import type { AccountResponse, AccountsResponse, PostAccountWrapper } from '../models/index';
@@ -5,12 +5,7 @@
5
5
  * YNAB API Endpoints
6
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
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.
8
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
14
9
  */
15
10
  Object.defineProperty(exports, "__esModule", { value: true });
16
11
  exports.AccountsApi = void 0;
@@ -2,12 +2,7 @@
2
2
  * YNAB API Endpoints
3
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
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.
5
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
11
6
  */
12
7
  import * as runtime from '../runtime';
13
8
  import type { BudgetDetailResponse, BudgetSettingsResponse, BudgetSummaryResponse } from '../models/index';
@@ -5,12 +5,7 @@
5
5
  * YNAB API Endpoints
6
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
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.
8
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
14
9
  */
15
10
  Object.defineProperty(exports, "__esModule", { value: true });
16
11
  exports.BudgetsApi = void 0;
@@ -2,12 +2,7 @@
2
2
  * YNAB API Endpoints
3
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
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.
5
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
11
6
  */
12
7
  import * as runtime from '../runtime';
13
8
  import type { CategoriesResponse, CategoryResponse, PatchCategoryWrapper, PatchMonthCategoryWrapper, SaveCategoryResponse } from '../models/index';
@@ -5,12 +5,7 @@
5
5
  * YNAB API Endpoints
6
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
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.
8
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
14
9
  */
15
10
  Object.defineProperty(exports, "__esModule", { value: true });
16
11
  exports.CategoriesApi = void 0;
@@ -2,12 +2,7 @@
2
2
  * YNAB API Endpoints
3
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
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.
5
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
11
6
  */
12
7
  import * as runtime from '../runtime';
13
8
  import type { MonthDetailResponse, MonthSummariesResponse } from '../models/index';
@@ -5,12 +5,7 @@
5
5
  * YNAB API Endpoints
6
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
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.
8
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
14
9
  */
15
10
  Object.defineProperty(exports, "__esModule", { value: true });
16
11
  exports.MonthsApi = void 0;
@@ -2,12 +2,7 @@
2
2
  * YNAB API Endpoints
3
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
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.
5
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
11
6
  */
12
7
  import * as runtime from '../runtime';
13
8
  import type { PayeeLocationResponse, PayeeLocationsResponse } from '../models/index';
@@ -5,12 +5,7 @@
5
5
  * YNAB API Endpoints
6
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
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.
8
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
14
9
  */
15
10
  Object.defineProperty(exports, "__esModule", { value: true });
16
11
  exports.PayeeLocationsApi = void 0;
@@ -2,15 +2,10 @@
2
2
  * YNAB API Endpoints
3
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
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.
5
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
11
6
  */
12
7
  import * as runtime from '../runtime';
13
- import type { PayeeResponse, PayeesResponse } from '../models/index';
8
+ import type { PatchPayeeWrapper, PayeeResponse, PayeesResponse, SavePayeeResponse } from '../models/index';
14
9
  export interface GetPayeeByIdRequest {
15
10
  budgetId: string;
16
11
  payeeId: string;
@@ -19,6 +14,11 @@ export interface GetPayeesRequest {
19
14
  budgetId: string;
20
15
  lastKnowledgeOfServer?: number;
21
16
  }
17
+ export interface UpdatePayeeRequest {
18
+ budgetId: string;
19
+ payeeId: string;
20
+ data: PatchPayeeWrapper;
21
+ }
22
22
  /**
23
23
  *
24
24
  */
@@ -43,4 +43,14 @@ export declare class PayeesApi extends runtime.BaseAPI {
43
43
  * List payees
44
44
  */
45
45
  getPayees(budgetId: string, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PayeesResponse>;
46
+ /**
47
+ * Update a payee
48
+ * Update a payee
49
+ */
50
+ updatePayeeRaw(requestParameters: UpdatePayeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SavePayeeResponse>>;
51
+ /**
52
+ * Update a payee
53
+ * Update a payee
54
+ */
55
+ updatePayee(budgetId: string, payeeId: string, data: PatchPayeeWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SavePayeeResponse>;
46
56
  }
@@ -5,12 +5,7 @@
5
5
  * YNAB API Endpoints
6
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
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.
8
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
14
9
  */
15
10
  Object.defineProperty(exports, "__esModule", { value: true });
16
11
  exports.PayeesApi = void 0;
@@ -94,5 +89,47 @@ class PayeesApi extends runtime.BaseAPI {
94
89
  const response = await this.getPayeesRaw({ budgetId: budgetId, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
95
90
  return await response.value();
96
91
  }
92
+ /**
93
+ * Update a payee
94
+ * Update a payee
95
+ */
96
+ async updatePayeeRaw(requestParameters, initOverrides) {
97
+ if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
98
+ throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling updatePayee.');
99
+ }
100
+ if (requestParameters.payeeId === null || requestParameters.payeeId === undefined) {
101
+ throw new runtime.RequiredError('payeeId', 'Required parameter requestParameters.payeeId was null or undefined when calling updatePayee.');
102
+ }
103
+ if (requestParameters.data === null || requestParameters.data === undefined) {
104
+ throw new runtime.RequiredError('data', 'Required parameter requestParameters.data was null or undefined when calling updatePayee.');
105
+ }
106
+ const queryParameters = {};
107
+ const headerParameters = {};
108
+ headerParameters['Accept'] = 'application/json';
109
+ headerParameters['Content-Type'] = 'application/json';
110
+ if (this.configuration && this.configuration.accessToken) {
111
+ const token = this.configuration.accessToken;
112
+ const tokenString = await token("bearer", []);
113
+ if (tokenString) {
114
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
115
+ }
116
+ }
117
+ const response = await this.request({
118
+ path: `/budgets/{budget_id}/payees/{payee_id}`.replace(`{${"budget_id"}}`, encodeURIComponent(String(requestParameters.budgetId))).replace(`{${"payee_id"}}`, encodeURIComponent(String(requestParameters.payeeId))),
119
+ method: 'PATCH',
120
+ headers: headerParameters,
121
+ query: queryParameters,
122
+ body: (0, index_1.PatchPayeeWrapperToJSON)(requestParameters.data),
123
+ }, initOverrides);
124
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SavePayeeResponseFromJSON)(jsonValue));
125
+ }
126
+ /**
127
+ * Update a payee
128
+ * Update a payee
129
+ */
130
+ async updatePayee(budgetId, payeeId, data, initOverrides) {
131
+ const response = await this.updatePayeeRaw({ budgetId: budgetId, payeeId: payeeId, data: data }, initOverrides);
132
+ return await response.value();
133
+ }
97
134
  }
98
135
  exports.PayeesApi = PayeesApi;
@@ -2,15 +2,14 @@
2
2
  * YNAB API Endpoints
3
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
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.
5
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
11
6
  */
12
7
  import * as runtime from '../runtime';
13
- import type { ScheduledTransactionResponse, ScheduledTransactionsResponse } from '../models/index';
8
+ import type { PostScheduledTransactionWrapper, ScheduledTransactionResponse, ScheduledTransactionsResponse } from '../models/index';
9
+ export interface CreateScheduledTransactionRequest {
10
+ budgetId: string;
11
+ data: PostScheduledTransactionWrapper;
12
+ }
14
13
  export interface GetScheduledTransactionByIdRequest {
15
14
  budgetId: string;
16
15
  scheduledTransactionId: string;
@@ -23,6 +22,16 @@ export interface GetScheduledTransactionsRequest {
23
22
  *
24
23
  */
25
24
  export declare class ScheduledTransactionsApi extends runtime.BaseAPI {
25
+ /**
26
+ * Creates a single scheduled transaction.
27
+ * Create a single scheduled transaction
28
+ */
29
+ createScheduledTransactionRaw(requestParameters: CreateScheduledTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScheduledTransactionResponse>>;
30
+ /**
31
+ * Creates a single scheduled transaction.
32
+ * Create a single scheduled transaction
33
+ */
34
+ createScheduledTransaction(budgetId: string, data: PostScheduledTransactionWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScheduledTransactionResponse>;
26
35
  /**
27
36
  * Returns a single scheduled transaction
28
37
  * Single scheduled transaction
@@ -5,12 +5,7 @@
5
5
  * YNAB API Endpoints
6
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
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.
8
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
14
9
  */
15
10
  Object.defineProperty(exports, "__esModule", { value: true });
16
11
  exports.ScheduledTransactionsApi = void 0;
@@ -20,6 +15,45 @@ const index_1 = require("../models/index");
20
15
  *
21
16
  */
22
17
  class ScheduledTransactionsApi extends runtime.BaseAPI {
18
+ /**
19
+ * Creates a single scheduled transaction.
20
+ * Create a single scheduled transaction
21
+ */
22
+ async createScheduledTransactionRaw(requestParameters, initOverrides) {
23
+ if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
24
+ throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling createScheduledTransaction.');
25
+ }
26
+ if (requestParameters.data === null || requestParameters.data === undefined) {
27
+ throw new runtime.RequiredError('data', 'Required parameter requestParameters.data was null or undefined when calling createScheduledTransaction.');
28
+ }
29
+ const queryParameters = {};
30
+ const headerParameters = {};
31
+ headerParameters['Accept'] = 'application/json';
32
+ headerParameters['Content-Type'] = 'application/json';
33
+ if (this.configuration && this.configuration.accessToken) {
34
+ const token = this.configuration.accessToken;
35
+ const tokenString = await token("bearer", []);
36
+ if (tokenString) {
37
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
38
+ }
39
+ }
40
+ const response = await this.request({
41
+ path: `/budgets/{budget_id}/scheduled_transactions`.replace(`{${"budget_id"}}`, encodeURIComponent(String(requestParameters.budgetId))),
42
+ method: 'POST',
43
+ headers: headerParameters,
44
+ query: queryParameters,
45
+ body: (0, index_1.PostScheduledTransactionWrapperToJSON)(requestParameters.data),
46
+ }, initOverrides);
47
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ScheduledTransactionResponseFromJSON)(jsonValue));
48
+ }
49
+ /**
50
+ * Creates a single scheduled transaction.
51
+ * Create a single scheduled transaction
52
+ */
53
+ async createScheduledTransaction(budgetId, data, initOverrides) {
54
+ const response = await this.createScheduledTransactionRaw({ budgetId: budgetId, data: data }, initOverrides);
55
+ return await response.value();
56
+ }
23
57
  /**
24
58
  * Returns a single scheduled transaction
25
59
  * Single scheduled transaction
@@ -2,12 +2,7 @@
2
2
  * YNAB API Endpoints
3
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
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.
5
+ * Generated by: OpenAPI Generator (https://openapi-generator.tech)
11
6
  */
12
7
  import * as runtime from '../runtime';
13
8
  import type { HybridTransactionsResponse, PatchTransactionsWrapper, PostTransactionsWrapper, PutTransactionWrapper, SaveTransactionsResponse, TransactionResponse, TransactionsImportResponse, TransactionsResponse } from '../models/index';
@@ -43,6 +38,13 @@ export interface GetTransactionsByCategoryRequest {
43
38
  type?: GetTransactionsByCategoryTypeEnum;
44
39
  lastKnowledgeOfServer?: number;
45
40
  }
41
+ export interface GetTransactionsByMonthRequest {
42
+ budgetId: string;
43
+ month: string;
44
+ sinceDate?: string;
45
+ type?: GetTransactionsByMonthTypeEnum;
46
+ lastKnowledgeOfServer?: number;
47
+ }
46
48
  export interface GetTransactionsByPayeeRequest {
47
49
  budgetId: string;
48
50
  payeeId: string;
@@ -67,12 +69,12 @@ export interface UpdateTransactionsRequest {
67
69
  */
68
70
  export declare class TransactionsApi extends runtime.BaseAPI {
69
71
  /**
70
- * Creates a single transaction or multiple transactions. If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint.
72
+ * Creates a single transaction or multiple transactions. If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created. Scheduled transactions (transactions with a future date) cannot be created on this endpoint.
71
73
  * Create a single transaction or multiple transactions
72
74
  */
73
75
  createTransactionRaw(requestParameters: CreateTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SaveTransactionsResponse>>;
74
76
  /**
75
- * Creates a single transaction or multiple transactions. If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint.
77
+ * Creates a single transaction or multiple transactions. If you provide a body containing a `transaction` object, a single transaction will be created and if you provide a body containing a `transactions` array, multiple transactions will be created. Scheduled transactions (transactions with a future date) cannot be created on this endpoint.
76
78
  * Create a single transaction or multiple transactions
77
79
  */
78
80
  createTransaction(budgetId: string, data: PostTransactionsWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SaveTransactionsResponse>;
@@ -97,43 +99,53 @@ export declare class TransactionsApi extends runtime.BaseAPI {
97
99
  */
98
100
  getTransactionById(budgetId: string, transactionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionResponse>;
99
101
  /**
100
- * Returns budget transactions
102
+ * Returns budget transactions, excluding any pending transactions
101
103
  * List transactions
102
104
  */
103
105
  getTransactionsRaw(requestParameters: GetTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionsResponse>>;
104
106
  /**
105
- * Returns budget transactions
107
+ * Returns budget transactions, excluding any pending transactions
106
108
  * List transactions
107
109
  */
108
110
  getTransactions(budgetId: string, sinceDate?: string, type?: GetTransactionsTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
109
111
  /**
110
- * Returns all transactions for a specified account
112
+ * Returns all transactions for a specified account, excluding any pending transactions
111
113
  * List account transactions
112
114
  */
113
115
  getTransactionsByAccountRaw(requestParameters: GetTransactionsByAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionsResponse>>;
114
116
  /**
115
- * Returns all transactions for a specified account
117
+ * Returns all transactions for a specified account, excluding any pending transactions
116
118
  * List account transactions
117
119
  */
118
120
  getTransactionsByAccount(budgetId: string, accountId: string, sinceDate?: string, type?: GetTransactionsByAccountTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
119
121
  /**
120
122
  * Returns all transactions for a specified category
121
- * List category transactions
123
+ * List category transactions, excluding any pending transactions
122
124
  */
123
125
  getTransactionsByCategoryRaw(requestParameters: GetTransactionsByCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HybridTransactionsResponse>>;
124
126
  /**
125
127
  * Returns all transactions for a specified category
126
- * List category transactions
128
+ * List category transactions, excluding any pending transactions
127
129
  */
128
130
  getTransactionsByCategory(budgetId: string, categoryId: string, sinceDate?: string, type?: GetTransactionsByCategoryTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
131
+ /**
132
+ * Returns all transactions for a specified month
133
+ * List transactions in month, excluding any pending transactions
134
+ */
135
+ getTransactionsByMonthRaw(requestParameters: GetTransactionsByMonthRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HybridTransactionsResponse>>;
136
+ /**
137
+ * Returns all transactions for a specified month
138
+ * List transactions in month, excluding any pending transactions
139
+ */
140
+ getTransactionsByMonth(budgetId: string, month: string, sinceDate?: string, type?: GetTransactionsByMonthTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
129
141
  /**
130
142
  * Returns all transactions for a specified payee
131
- * List payee transactions
143
+ * List payee transactions, excluding any pending transactions
132
144
  */
133
145
  getTransactionsByPayeeRaw(requestParameters: GetTransactionsByPayeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HybridTransactionsResponse>>;
134
146
  /**
135
147
  * Returns all transactions for a specified payee
136
- * List payee transactions
148
+ * List payee transactions, excluding any pending transactions
137
149
  */
138
150
  getTransactionsByPayee(budgetId: string, payeeId: string, sinceDate?: string, type?: GetTransactionsByPayeeTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
139
151
  /**
@@ -191,6 +203,14 @@ export declare const GetTransactionsByCategoryTypeEnum: {
191
203
  readonly Unapproved: "unapproved";
192
204
  };
193
205
  export type GetTransactionsByCategoryTypeEnum = typeof GetTransactionsByCategoryTypeEnum[keyof typeof GetTransactionsByCategoryTypeEnum];
206
+ /**
207
+ * @export
208
+ */
209
+ export declare const GetTransactionsByMonthTypeEnum: {
210
+ readonly Uncategorized: "uncategorized";
211
+ readonly Unapproved: "unapproved";
212
+ };
213
+ export type GetTransactionsByMonthTypeEnum = typeof GetTransactionsByMonthTypeEnum[keyof typeof GetTransactionsByMonthTypeEnum];
194
214
  /**
195
215
  * @export
196
216
  */