ynab 2.10.0 → 3.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 (320) hide show
  1. package/README.md +50 -42
  2. package/dist/apis/AccountsApi.d.ts +12 -12
  3. package/dist/apis/AccountsApi.js +38 -28
  4. package/dist/apis/CategoriesApi.d.ts +68 -25
  5. package/dist/apis/CategoriesApi.js +176 -46
  6. package/dist/apis/DeprecatedApi.js +17 -7
  7. package/dist/apis/MoneyMovementsApi.d.ts +67 -0
  8. package/dist/apis/MoneyMovementsApi.js +194 -0
  9. package/dist/apis/MonthsApi.d.ts +16 -16
  10. package/dist/apis/MonthsApi.js +38 -28
  11. package/dist/apis/PayeeLocationsApi.d.ts +12 -12
  12. package/dist/apis/PayeeLocationsApi.js +38 -28
  13. package/dist/apis/PayeesApi.d.ts +10 -10
  14. package/dist/apis/PayeesApi.js +36 -26
  15. package/dist/apis/PlansApi.d.ts +53 -0
  16. package/dist/apis/{BudgetsApi.js → PlansApi.js} +50 -40
  17. package/dist/apis/ScheduledTransactionsApi.d.ts +20 -20
  18. package/dist/apis/ScheduledTransactionsApi.js +52 -42
  19. package/dist/apis/TransactionsApi.d.ts +49 -49
  20. package/dist/apis/TransactionsApi.js +99 -89
  21. package/dist/apis/UserApi.d.ts +2 -2
  22. package/dist/apis/UserApi.js +19 -9
  23. package/dist/apis/index.d.ts +2 -1
  24. package/dist/apis/index.js +2 -1
  25. package/dist/browser/ynab.js +1 -1
  26. package/dist/esm/apis/AccountsApi.d.ts +12 -12
  27. package/dist/esm/apis/AccountsApi.js +23 -23
  28. package/dist/esm/apis/CategoriesApi.d.ts +68 -25
  29. package/dist/esm/apis/CategoriesApi.js +228 -42
  30. package/dist/esm/apis/DeprecatedApi.js +2 -2
  31. package/dist/esm/apis/MoneyMovementsApi.d.ts +67 -0
  32. package/dist/esm/apis/MoneyMovementsApi.js +302 -0
  33. package/dist/esm/apis/MonthsApi.d.ts +16 -16
  34. package/dist/esm/apis/MonthsApi.js +23 -23
  35. package/dist/esm/apis/PayeeLocationsApi.d.ts +12 -12
  36. package/dist/esm/apis/PayeeLocationsApi.js +23 -23
  37. package/dist/esm/apis/PayeesApi.d.ts +10 -10
  38. package/dist/esm/apis/PayeesApi.js +21 -21
  39. package/dist/esm/apis/PlansApi.d.ts +53 -0
  40. package/dist/esm/apis/{BudgetsApi.js → PlansApi.js} +38 -38
  41. package/dist/esm/apis/ScheduledTransactionsApi.d.ts +20 -20
  42. package/dist/esm/apis/ScheduledTransactionsApi.js +37 -37
  43. package/dist/esm/apis/TransactionsApi.d.ts +49 -49
  44. package/dist/esm/apis/TransactionsApi.js +84 -84
  45. package/dist/esm/apis/UserApi.d.ts +2 -2
  46. package/dist/esm/apis/UserApi.js +4 -4
  47. package/dist/esm/apis/index.d.ts +2 -1
  48. package/dist/esm/apis/index.js +2 -1
  49. package/dist/esm/index.d.ts +3 -3
  50. package/dist/esm/index.js +5 -5
  51. package/dist/esm/models/Account.d.ts +6 -6
  52. package/dist/esm/models/Category.d.ts +10 -4
  53. package/dist/esm/models/Category.js +2 -0
  54. package/dist/esm/models/CategoryGroupWithCategories.d.ts +1 -1
  55. package/dist/esm/models/CurrencyFormat.d.ts +1 -1
  56. package/dist/esm/models/DateFormat.d.ts +1 -1
  57. package/dist/esm/models/ExistingCategory.d.ts +51 -0
  58. package/dist/esm/models/ExistingCategory.js +45 -0
  59. package/dist/esm/models/ExistingTransaction.d.ts +4 -4
  60. package/dist/esm/models/HybridTransaction.d.ts +12 -12
  61. package/dist/esm/models/MoneyMovement.d.ts +75 -0
  62. package/dist/esm/models/MoneyMovement.js +57 -0
  63. package/dist/esm/models/MoneyMovementGroup.d.ts +51 -0
  64. package/dist/esm/models/MoneyMovementGroup.js +51 -0
  65. package/dist/esm/models/MoneyMovementGroupsResponse.d.ts +28 -0
  66. package/dist/esm/models/MoneyMovementGroupsResponse.js +40 -0
  67. package/dist/esm/models/MoneyMovementGroupsResponseData.d.ts +34 -0
  68. package/dist/esm/models/MoneyMovementGroupsResponseData.js +44 -0
  69. package/dist/esm/models/MoneyMovementsResponse.d.ts +28 -0
  70. package/dist/esm/models/{BudgetSettingsResponse.js → MoneyMovementsResponse.js} +11 -11
  71. package/dist/esm/models/MoneyMovementsResponseData.d.ts +34 -0
  72. package/dist/esm/models/MoneyMovementsResponseData.js +44 -0
  73. package/dist/esm/models/MonthDetail.d.ts +4 -4
  74. package/dist/esm/models/MonthSummary.d.ts +1 -1
  75. package/dist/esm/models/NewCategory.d.ts +51 -0
  76. package/dist/esm/models/NewCategory.js +45 -0
  77. package/dist/esm/models/NewTransaction.d.ts +4 -4
  78. package/dist/esm/models/PatchCategoryGroupWrapper.d.ts +28 -0
  79. package/dist/esm/models/PatchCategoryGroupWrapper.js +40 -0
  80. package/dist/esm/models/PatchCategoryWrapper.d.ts +3 -3
  81. package/dist/esm/models/PatchCategoryWrapper.js +3 -3
  82. package/dist/{models/BudgetDetail.d.ts → esm/models/PlanDetail.d.ts} +30 -30
  83. package/dist/esm/models/{BudgetDetail.js → PlanDetail.js} +8 -8
  84. package/dist/esm/models/PlanDetailResponse.d.ts +28 -0
  85. package/dist/esm/models/PlanDetailResponse.js +40 -0
  86. package/dist/esm/models/PlanDetailResponseData.d.ts +34 -0
  87. package/dist/esm/models/{BudgetDetailResponseData.js → PlanDetailResponseData.js} +11 -11
  88. package/dist/esm/models/PlanSettings.d.ts +35 -0
  89. package/dist/esm/models/{BudgetSettings.js → PlanSettings.js} +8 -8
  90. package/dist/esm/models/PlanSettingsResponse.d.ts +28 -0
  91. package/dist/esm/models/{BudgetDetailResponse.js → PlanSettingsResponse.js} +11 -11
  92. package/dist/esm/models/PlanSettingsResponseData.d.ts +28 -0
  93. package/dist/esm/models/PlanSettingsResponseData.js +40 -0
  94. package/dist/esm/models/PlanSummary.d.ts +72 -0
  95. package/dist/esm/models/{BudgetSummary.js → PlanSummary.js} +8 -8
  96. package/dist/esm/models/PlanSummaryResponse.d.ts +28 -0
  97. package/dist/esm/models/PlanSummaryResponse.js +40 -0
  98. package/dist/esm/models/PlanSummaryResponseData.d.ts +34 -0
  99. package/dist/esm/models/PlanSummaryResponseData.js +42 -0
  100. package/dist/esm/models/PostCategoryGroupWrapper.d.ts +28 -0
  101. package/dist/esm/models/PostCategoryGroupWrapper.js +40 -0
  102. package/dist/esm/models/PostCategoryWrapper.d.ts +28 -0
  103. package/dist/esm/models/PostCategoryWrapper.js +40 -0
  104. package/dist/esm/models/SaveCategory.d.ts +7 -1
  105. package/dist/esm/models/SaveCategory.js +2 -0
  106. package/dist/esm/models/SaveCategoryGroup.d.ts +27 -0
  107. package/dist/esm/models/SaveCategoryGroup.js +39 -0
  108. package/dist/esm/models/SaveCategoryGroupResponse.d.ts +28 -0
  109. package/dist/esm/models/SaveCategoryGroupResponse.js +40 -0
  110. package/dist/esm/models/SaveCategoryGroupResponseData.d.ts +34 -0
  111. package/dist/esm/models/SaveCategoryGroupResponseData.js +44 -0
  112. package/dist/esm/models/SaveMonthCategory.d.ts +1 -1
  113. package/dist/esm/models/SaveTransactionWithIdOrImportId.d.ts +4 -4
  114. package/dist/esm/models/ScheduledTransactionDetail.d.ts +6 -6
  115. package/dist/esm/models/ScheduledTransactionSummary.d.ts +1 -1
  116. package/dist/esm/models/TransactionDetail.d.ts +11 -11
  117. package/dist/esm/models/TransactionSummary.d.ts +1 -1
  118. package/dist/esm/models/index.d.ts +23 -9
  119. package/dist/esm/models/index.js +23 -9
  120. package/dist/esm/runtime.js +3 -3
  121. package/dist/index.d.ts +3 -3
  122. package/dist/index.js +22 -12
  123. package/dist/models/Account.d.ts +6 -6
  124. package/dist/models/Account.js +5 -6
  125. package/dist/models/AccountResponse.js +5 -6
  126. package/dist/models/AccountResponseData.js +5 -6
  127. package/dist/models/AccountType.js +6 -6
  128. package/dist/models/AccountsResponse.js +5 -6
  129. package/dist/models/AccountsResponseData.js +5 -6
  130. package/dist/models/BulkResponse.js +5 -6
  131. package/dist/models/BulkResponseData.js +5 -6
  132. package/dist/models/BulkResponseDataBulk.js +5 -6
  133. package/dist/models/BulkTransactions.js +5 -6
  134. package/dist/models/CategoriesResponse.js +5 -6
  135. package/dist/models/CategoriesResponseData.js +5 -6
  136. package/dist/models/Category.d.ts +10 -4
  137. package/dist/models/Category.js +8 -6
  138. package/dist/models/CategoryGoalType.js +4 -5
  139. package/dist/models/CategoryGroup.js +5 -6
  140. package/dist/models/CategoryGroupWithCategories.d.ts +1 -1
  141. package/dist/models/CategoryGroupWithCategories.js +5 -6
  142. package/dist/models/CategoryGroupWithCategoriesAllOf.js +4 -5
  143. package/dist/models/CategoryResponse.js +5 -6
  144. package/dist/models/CategoryResponseData.js +5 -6
  145. package/dist/models/CurrencyFormat.d.ts +1 -1
  146. package/dist/models/CurrencyFormat.js +5 -6
  147. package/dist/models/DateFormat.d.ts +1 -1
  148. package/dist/models/DateFormat.js +5 -6
  149. package/dist/models/ErrorDetail.js +5 -6
  150. package/dist/models/ErrorResponse.js +5 -6
  151. package/dist/models/ExistingCategory.d.ts +51 -0
  152. package/dist/models/ExistingCategory.js +51 -0
  153. package/dist/models/ExistingTransaction.d.ts +4 -4
  154. package/dist/models/ExistingTransaction.js +5 -6
  155. package/dist/models/HybridTransaction.d.ts +12 -12
  156. package/dist/models/HybridTransaction.js +6 -6
  157. package/dist/models/HybridTransactionAllOf.js +5 -5
  158. package/dist/models/HybridTransactionsResponse.js +5 -6
  159. package/dist/models/HybridTransactionsResponseData.js +5 -6
  160. package/dist/models/MoneyMovement.d.ts +75 -0
  161. package/dist/models/MoneyMovement.js +63 -0
  162. package/dist/models/MoneyMovementGroup.d.ts +51 -0
  163. package/dist/models/MoneyMovementGroup.js +57 -0
  164. package/dist/models/MoneyMovementGroupsResponse.d.ts +28 -0
  165. package/dist/models/MoneyMovementGroupsResponse.js +46 -0
  166. package/dist/models/MoneyMovementGroupsResponseData.d.ts +34 -0
  167. package/dist/models/MoneyMovementGroupsResponseData.js +50 -0
  168. package/dist/models/MoneyMovementsResponse.d.ts +28 -0
  169. package/dist/models/MoneyMovementsResponse.js +46 -0
  170. package/dist/models/MoneyMovementsResponseData.d.ts +34 -0
  171. package/dist/models/MoneyMovementsResponseData.js +50 -0
  172. package/dist/models/MonthDetail.d.ts +4 -4
  173. package/dist/models/MonthDetail.js +5 -6
  174. package/dist/models/MonthDetailAllOf.js +4 -5
  175. package/dist/models/MonthDetailResponse.js +5 -6
  176. package/dist/models/MonthDetailResponseData.js +5 -6
  177. package/dist/models/MonthSummariesResponse.js +5 -6
  178. package/dist/models/MonthSummariesResponseData.js +5 -6
  179. package/dist/models/MonthSummary.d.ts +1 -1
  180. package/dist/models/MonthSummary.js +5 -6
  181. package/dist/models/NewCategory.d.ts +51 -0
  182. package/dist/models/NewCategory.js +51 -0
  183. package/dist/models/NewTransaction.d.ts +4 -4
  184. package/dist/models/NewTransaction.js +5 -6
  185. package/dist/models/PatchCategoryGroupWrapper.d.ts +28 -0
  186. package/dist/models/PatchCategoryGroupWrapper.js +46 -0
  187. package/dist/models/PatchCategoryWrapper.d.ts +3 -3
  188. package/dist/models/PatchCategoryWrapper.js +8 -9
  189. package/dist/models/PatchMonthCategoryWrapper.js +5 -6
  190. package/dist/models/PatchPayeeWrapper.js +5 -6
  191. package/dist/models/PatchTransactionsWrapper.js +5 -6
  192. package/dist/models/Payee.js +5 -6
  193. package/dist/models/PayeeLocation.js +5 -6
  194. package/dist/models/PayeeLocationResponse.js +5 -6
  195. package/dist/models/PayeeLocationResponseData.js +5 -6
  196. package/dist/models/PayeeLocationsResponse.js +5 -6
  197. package/dist/models/PayeeLocationsResponseData.js +5 -6
  198. package/dist/models/PayeeResponse.js +5 -6
  199. package/dist/models/PayeeResponseData.js +5 -6
  200. package/dist/models/PayeesResponse.js +5 -6
  201. package/dist/models/PayeesResponseData.js +5 -6
  202. package/dist/{esm/models/BudgetDetail.d.ts → models/PlanDetail.d.ts} +30 -30
  203. package/dist/models/{BudgetDetail.js → PlanDetail.js} +13 -14
  204. package/dist/models/PlanDetailResponse.d.ts +28 -0
  205. package/dist/models/PlanDetailResponse.js +46 -0
  206. package/dist/models/PlanDetailResponseData.d.ts +34 -0
  207. package/dist/models/PlanDetailResponseData.js +50 -0
  208. package/dist/models/PlanSettings.d.ts +35 -0
  209. package/dist/models/{BudgetSettings.js → PlanSettings.js} +13 -14
  210. package/dist/models/PlanSettingsResponse.d.ts +28 -0
  211. package/dist/models/PlanSettingsResponse.js +46 -0
  212. package/dist/models/PlanSettingsResponseData.d.ts +28 -0
  213. package/dist/models/PlanSettingsResponseData.js +46 -0
  214. package/dist/models/PlanSummary.d.ts +72 -0
  215. package/dist/models/{BudgetSummary.js → PlanSummary.js} +13 -14
  216. package/dist/models/PlanSummaryResponse.d.ts +28 -0
  217. package/dist/models/PlanSummaryResponse.js +46 -0
  218. package/dist/models/PlanSummaryResponseData.d.ts +34 -0
  219. package/dist/models/PlanSummaryResponseData.js +48 -0
  220. package/dist/models/PostAccountWrapper.js +5 -6
  221. package/dist/models/PostCategoryGroupWrapper.d.ts +28 -0
  222. package/dist/models/PostCategoryGroupWrapper.js +46 -0
  223. package/dist/models/PostCategoryWrapper.d.ts +28 -0
  224. package/dist/models/PostCategoryWrapper.js +46 -0
  225. package/dist/models/PostScheduledTransactionWrapper.js +5 -6
  226. package/dist/models/PostTransactionsWrapper.js +5 -6
  227. package/dist/models/PutScheduledTransactionWrapper.js +5 -6
  228. package/dist/models/PutTransactionWrapper.js +5 -6
  229. package/dist/models/SaveAccount.js +5 -6
  230. package/dist/models/SaveCategory.d.ts +7 -1
  231. package/dist/models/SaveCategory.js +7 -6
  232. package/dist/models/SaveCategoryGroup.d.ts +27 -0
  233. package/dist/models/SaveCategoryGroup.js +45 -0
  234. package/dist/models/SaveCategoryGroupResponse.d.ts +28 -0
  235. package/dist/models/SaveCategoryGroupResponse.js +46 -0
  236. package/dist/models/SaveCategoryGroupResponseData.d.ts +34 -0
  237. package/dist/models/SaveCategoryGroupResponseData.js +50 -0
  238. package/dist/models/SaveCategoryResponse.js +5 -6
  239. package/dist/models/SaveCategoryResponseData.js +5 -6
  240. package/dist/models/SaveMonthCategory.d.ts +1 -1
  241. package/dist/models/SaveMonthCategory.js +5 -6
  242. package/dist/models/SavePayee.js +5 -6
  243. package/dist/models/SavePayeeResponse.js +5 -6
  244. package/dist/models/SavePayeeResponseData.js +5 -6
  245. package/dist/models/SaveScheduledTransaction.js +5 -6
  246. package/dist/models/SaveSubTransaction.js +5 -6
  247. package/dist/models/SaveTransaction.js +4 -5
  248. package/dist/models/SaveTransactionWithId.js +4 -5
  249. package/dist/models/SaveTransactionWithIdAllOf.js +4 -5
  250. package/dist/models/SaveTransactionWithIdOrImportId.d.ts +4 -4
  251. package/dist/models/SaveTransactionWithIdOrImportId.js +5 -6
  252. package/dist/models/SaveTransactionWithOptionalFields.js +5 -6
  253. package/dist/models/SaveTransactionWithOptionalFieldsFlagColor.js +4 -5
  254. package/dist/models/SaveTransactionsResponse.js +5 -6
  255. package/dist/models/SaveTransactionsResponseData.js +5 -6
  256. package/dist/models/ScheduledSubTransaction.js +5 -6
  257. package/dist/models/ScheduledTransactionDetail.d.ts +6 -6
  258. package/dist/models/ScheduledTransactionDetail.js +6 -6
  259. package/dist/models/ScheduledTransactionDetailAllOf.js +4 -5
  260. package/dist/models/ScheduledTransactionFrequency.js +6 -6
  261. package/dist/models/ScheduledTransactionResponse.js +5 -6
  262. package/dist/models/ScheduledTransactionResponseData.js +5 -6
  263. package/dist/models/ScheduledTransactionSummary.d.ts +1 -1
  264. package/dist/models/ScheduledTransactionSummary.js +6 -6
  265. package/dist/models/ScheduledTransactionSummaryFlagColor.js +4 -5
  266. package/dist/models/ScheduledTransactionsResponse.js +5 -6
  267. package/dist/models/ScheduledTransactionsResponseData.js +5 -6
  268. package/dist/models/SubTransaction.js +5 -6
  269. package/dist/models/TransactionClearedStatus.js +6 -6
  270. package/dist/models/TransactionDetail.d.ts +11 -11
  271. package/dist/models/TransactionDetail.js +6 -6
  272. package/dist/models/TransactionDetailAllOf.js +4 -5
  273. package/dist/models/TransactionFlagColor.js +6 -6
  274. package/dist/models/TransactionResponse.js +5 -6
  275. package/dist/models/TransactionResponseData.js +5 -6
  276. package/dist/models/TransactionSummary.d.ts +1 -1
  277. package/dist/models/TransactionSummary.js +6 -6
  278. package/dist/models/TransactionSummaryDebtTransactionType.js +4 -5
  279. package/dist/models/TransactionsImportResponse.js +5 -6
  280. package/dist/models/TransactionsImportResponseData.js +5 -6
  281. package/dist/models/TransactionsResponse.js +5 -6
  282. package/dist/models/TransactionsResponseData.js +5 -6
  283. package/dist/models/User.js +5 -6
  284. package/dist/models/UserResponse.js +5 -6
  285. package/dist/models/UserResponseData.js +5 -6
  286. package/dist/models/index.d.ts +23 -9
  287. package/dist/models/index.js +23 -9
  288. package/dist/runtime.js +5 -5
  289. package/package.json +7 -8
  290. package/dist/apis/BudgetsApi.d.ts +0 -53
  291. package/dist/esm/apis/BudgetsApi.d.ts +0 -53
  292. package/dist/esm/models/BudgetDetailAllOf.d.ts +0 -95
  293. package/dist/esm/models/BudgetDetailAllOf.js +0 -71
  294. package/dist/esm/models/BudgetDetailResponse.d.ts +0 -28
  295. package/dist/esm/models/BudgetDetailResponseData.d.ts +0 -34
  296. package/dist/esm/models/BudgetSettings.d.ts +0 -35
  297. package/dist/esm/models/BudgetSettingsResponse.d.ts +0 -28
  298. package/dist/esm/models/BudgetSettingsResponseData.d.ts +0 -28
  299. package/dist/esm/models/BudgetSettingsResponseData.js +0 -40
  300. package/dist/esm/models/BudgetSummary.d.ts +0 -72
  301. package/dist/esm/models/BudgetSummaryResponse.d.ts +0 -28
  302. package/dist/esm/models/BudgetSummaryResponse.js +0 -40
  303. package/dist/esm/models/BudgetSummaryResponseData.d.ts +0 -34
  304. package/dist/esm/models/BudgetSummaryResponseData.js +0 -42
  305. package/dist/models/BudgetDetailAllOf.d.ts +0 -95
  306. package/dist/models/BudgetDetailAllOf.js +0 -78
  307. package/dist/models/BudgetDetailResponse.d.ts +0 -28
  308. package/dist/models/BudgetDetailResponse.js +0 -47
  309. package/dist/models/BudgetDetailResponseData.d.ts +0 -34
  310. package/dist/models/BudgetDetailResponseData.js +0 -51
  311. package/dist/models/BudgetSettings.d.ts +0 -35
  312. package/dist/models/BudgetSettingsResponse.d.ts +0 -28
  313. package/dist/models/BudgetSettingsResponse.js +0 -47
  314. package/dist/models/BudgetSettingsResponseData.d.ts +0 -28
  315. package/dist/models/BudgetSettingsResponseData.js +0 -47
  316. package/dist/models/BudgetSummary.d.ts +0 -72
  317. package/dist/models/BudgetSummaryResponse.d.ts +0 -28
  318. package/dist/models/BudgetSummaryResponse.js +0 -47
  319. package/dist/models/BudgetSummaryResponseData.d.ts +0 -34
  320. package/dist/models/BudgetSummaryResponseData.js +0 -49
@@ -6,12 +6,12 @@
6
6
  */
7
7
  import * as runtime from '../runtime';
8
8
  import type { MonthDetailResponse, MonthSummariesResponse } from '../models/index';
9
- export interface GetBudgetMonthRequest {
10
- budgetId: string;
9
+ export interface GetPlanMonthRequest {
10
+ planId: string;
11
11
  month: string;
12
12
  }
13
- export interface GetBudgetMonthsRequest {
14
- budgetId: string;
13
+ export interface GetPlanMonthsRequest {
14
+ planId: string;
15
15
  lastKnowledgeOfServer?: number;
16
16
  }
17
17
  /**
@@ -19,23 +19,23 @@ export interface GetBudgetMonthsRequest {
19
19
  */
20
20
  export declare class MonthsApi extends runtime.BaseAPI {
21
21
  /**
22
- * Returns a single budget month
23
- * Single budget month
22
+ * Returns a single plan month
23
+ * Get a plan month
24
24
  */
25
- getBudgetMonthRaw(requestParameters: GetBudgetMonthRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MonthDetailResponse>>;
25
+ getPlanMonthRaw(requestParameters: GetPlanMonthRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MonthDetailResponse>>;
26
26
  /**
27
- * Returns a single budget month
28
- * Single budget month
27
+ * Returns a single plan month
28
+ * Get a plan month
29
29
  */
30
- getBudgetMonth(budgetId: string, month: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MonthDetailResponse>;
30
+ getPlanMonth(planId: string, month: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MonthDetailResponse>;
31
31
  /**
32
- * Returns all budget months
33
- * List budget months
32
+ * Returns all plan months
33
+ * Get all plan months
34
34
  */
35
- getBudgetMonthsRaw(requestParameters: GetBudgetMonthsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MonthSummariesResponse>>;
35
+ getPlanMonthsRaw(requestParameters: GetPlanMonthsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MonthSummariesResponse>>;
36
36
  /**
37
- * Returns all budget months
38
- * List budget months
37
+ * Returns all plan months
38
+ * Get all plan months
39
39
  */
40
- getBudgetMonths(budgetId: string, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MonthSummariesResponse>;
40
+ getPlanMonths(planId: string, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MonthSummariesResponse>;
41
41
  }
@@ -23,13 +23,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
23
23
  }) : function(o, v) {
24
24
  o["default"] = v;
25
25
  });
26
- var __importStar = (this && this.__importStar) || function (mod) {
27
- if (mod && mod.__esModule) return mod;
28
- var result = {};
29
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
30
- __setModuleDefault(result, mod);
31
- return result;
32
- };
26
+ var __importStar = (this && this.__importStar) || (function () {
27
+ var ownKeys = function(o) {
28
+ ownKeys = Object.getOwnPropertyNames || function (o) {
29
+ var ar = [];
30
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
31
+ return ar;
32
+ };
33
+ return ownKeys(o);
34
+ };
35
+ return function (mod) {
36
+ if (mod && mod.__esModule) return mod;
37
+ var result = {};
38
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
39
+ __setModuleDefault(result, mod);
40
+ return result;
41
+ };
42
+ })();
33
43
  Object.defineProperty(exports, "__esModule", { value: true });
34
44
  exports.MonthsApi = void 0;
35
45
  const runtime = __importStar(require("../runtime"));
@@ -39,15 +49,15 @@ const index_1 = require("../models/index");
39
49
  */
40
50
  class MonthsApi extends runtime.BaseAPI {
41
51
  /**
42
- * Returns a single budget month
43
- * Single budget month
52
+ * Returns a single plan month
53
+ * Get a plan month
44
54
  */
45
- async getBudgetMonthRaw(requestParameters, initOverrides) {
46
- if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
47
- throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling getBudgetMonth.');
55
+ async getPlanMonthRaw(requestParameters, initOverrides) {
56
+ if (requestParameters.planId === null || requestParameters.planId === undefined) {
57
+ throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling getPlanMonth.');
48
58
  }
49
59
  if (requestParameters.month === null || requestParameters.month === undefined) {
50
- throw new runtime.RequiredError('month', 'Required parameter requestParameters.month was null or undefined when calling getBudgetMonth.');
60
+ throw new runtime.RequiredError('month', 'Required parameter requestParameters.month was null or undefined when calling getPlanMonth.');
51
61
  }
52
62
  const queryParameters = {};
53
63
  const headerParameters = {};
@@ -60,7 +70,7 @@ class MonthsApi extends runtime.BaseAPI {
60
70
  }
61
71
  }
62
72
  const response = await this.request({
63
- path: `/budgets/{budget_id}/months/{month}`.replace(`{${"budget_id"}}`, encodeURIComponent(String(requestParameters.budgetId))).replace(`{${"month"}}`, encodeURIComponent(String(requestParameters.month))),
73
+ path: `/budgets/{plan_id}/months/{month}`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))).replace(`{${"month"}}`, encodeURIComponent(String(requestParameters.month))),
64
74
  method: 'GET',
65
75
  headers: headerParameters,
66
76
  query: queryParameters,
@@ -68,20 +78,20 @@ class MonthsApi extends runtime.BaseAPI {
68
78
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MonthDetailResponseFromJSON)(jsonValue));
69
79
  }
70
80
  /**
71
- * Returns a single budget month
72
- * Single budget month
81
+ * Returns a single plan month
82
+ * Get a plan month
73
83
  */
74
- async getBudgetMonth(budgetId, month, initOverrides) {
75
- const response = await this.getBudgetMonthRaw({ budgetId: budgetId, month: month }, initOverrides);
84
+ async getPlanMonth(planId, month, initOverrides) {
85
+ const response = await this.getPlanMonthRaw({ planId: planId, month: month }, initOverrides);
76
86
  return await response.value();
77
87
  }
78
88
  /**
79
- * Returns all budget months
80
- * List budget months
89
+ * Returns all plan months
90
+ * Get all plan months
81
91
  */
82
- async getBudgetMonthsRaw(requestParameters, initOverrides) {
83
- if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
84
- throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling getBudgetMonths.');
92
+ async getPlanMonthsRaw(requestParameters, initOverrides) {
93
+ if (requestParameters.planId === null || requestParameters.planId === undefined) {
94
+ throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling getPlanMonths.');
85
95
  }
86
96
  const queryParameters = {};
87
97
  if (requestParameters.lastKnowledgeOfServer !== undefined) {
@@ -97,7 +107,7 @@ class MonthsApi extends runtime.BaseAPI {
97
107
  }
98
108
  }
99
109
  const response = await this.request({
100
- path: `/budgets/{budget_id}/months`.replace(`{${"budget_id"}}`, encodeURIComponent(String(requestParameters.budgetId))),
110
+ path: `/budgets/{plan_id}/months`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))),
101
111
  method: 'GET',
102
112
  headers: headerParameters,
103
113
  query: queryParameters,
@@ -105,11 +115,11 @@ class MonthsApi extends runtime.BaseAPI {
105
115
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MonthSummariesResponseFromJSON)(jsonValue));
106
116
  }
107
117
  /**
108
- * Returns all budget months
109
- * List budget months
118
+ * Returns all plan months
119
+ * Get all plan months
110
120
  */
111
- async getBudgetMonths(budgetId, lastKnowledgeOfServer, initOverrides) {
112
- const response = await this.getBudgetMonthsRaw({ budgetId: budgetId, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
121
+ async getPlanMonths(planId, lastKnowledgeOfServer, initOverrides) {
122
+ const response = await this.getPlanMonthsRaw({ planId: planId, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
113
123
  return await response.value();
114
124
  }
115
125
  }
@@ -7,14 +7,14 @@
7
7
  import * as runtime from '../runtime';
8
8
  import type { PayeeLocationResponse, PayeeLocationsResponse } from '../models/index';
9
9
  export interface GetPayeeLocationByIdRequest {
10
- budgetId: string;
10
+ planId: string;
11
11
  payeeLocationId: string;
12
12
  }
13
13
  export interface GetPayeeLocationsRequest {
14
- budgetId: string;
14
+ planId: string;
15
15
  }
16
16
  export interface GetPayeeLocationsByPayeeRequest {
17
- budgetId: string;
17
+ planId: string;
18
18
  payeeId: string;
19
19
  }
20
20
  /**
@@ -23,32 +23,32 @@ export interface GetPayeeLocationsByPayeeRequest {
23
23
  export declare class PayeeLocationsApi extends runtime.BaseAPI {
24
24
  /**
25
25
  * Returns a single payee location
26
- * Single payee location
26
+ * Get a payee location
27
27
  */
28
28
  getPayeeLocationByIdRaw(requestParameters: GetPayeeLocationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PayeeLocationResponse>>;
29
29
  /**
30
30
  * Returns a single payee location
31
- * Single payee location
31
+ * Get a payee location
32
32
  */
33
- getPayeeLocationById(budgetId: string, payeeLocationId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PayeeLocationResponse>;
33
+ getPayeeLocationById(planId: string, payeeLocationId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PayeeLocationResponse>;
34
34
  /**
35
35
  * Returns all payee locations
36
- * List payee locations
36
+ * Get all payee locations
37
37
  */
38
38
  getPayeeLocationsRaw(requestParameters: GetPayeeLocationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PayeeLocationsResponse>>;
39
39
  /**
40
40
  * Returns all payee locations
41
- * List payee locations
41
+ * Get all payee locations
42
42
  */
43
- getPayeeLocations(budgetId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PayeeLocationsResponse>;
43
+ getPayeeLocations(planId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PayeeLocationsResponse>;
44
44
  /**
45
45
  * Returns all payee locations for a specified payee
46
- * List locations for a payee
46
+ * Get all locations for a payee
47
47
  */
48
48
  getPayeeLocationsByPayeeRaw(requestParameters: GetPayeeLocationsByPayeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PayeeLocationsResponse>>;
49
49
  /**
50
50
  * Returns all payee locations for a specified payee
51
- * List locations for a payee
51
+ * Get all locations for a payee
52
52
  */
53
- getPayeeLocationsByPayee(budgetId: string, payeeId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PayeeLocationsResponse>;
53
+ getPayeeLocationsByPayee(planId: string, payeeId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PayeeLocationsResponse>;
54
54
  }
@@ -23,13 +23,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
23
23
  }) : function(o, v) {
24
24
  o["default"] = v;
25
25
  });
26
- var __importStar = (this && this.__importStar) || function (mod) {
27
- if (mod && mod.__esModule) return mod;
28
- var result = {};
29
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
30
- __setModuleDefault(result, mod);
31
- return result;
32
- };
26
+ var __importStar = (this && this.__importStar) || (function () {
27
+ var ownKeys = function(o) {
28
+ ownKeys = Object.getOwnPropertyNames || function (o) {
29
+ var ar = [];
30
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
31
+ return ar;
32
+ };
33
+ return ownKeys(o);
34
+ };
35
+ return function (mod) {
36
+ if (mod && mod.__esModule) return mod;
37
+ var result = {};
38
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
39
+ __setModuleDefault(result, mod);
40
+ return result;
41
+ };
42
+ })();
33
43
  Object.defineProperty(exports, "__esModule", { value: true });
34
44
  exports.PayeeLocationsApi = void 0;
35
45
  const runtime = __importStar(require("../runtime"));
@@ -40,11 +50,11 @@ const index_1 = require("../models/index");
40
50
  class PayeeLocationsApi extends runtime.BaseAPI {
41
51
  /**
42
52
  * Returns a single payee location
43
- * Single payee location
53
+ * Get a payee location
44
54
  */
45
55
  async getPayeeLocationByIdRaw(requestParameters, initOverrides) {
46
- if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
47
- throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling getPayeeLocationById.');
56
+ if (requestParameters.planId === null || requestParameters.planId === undefined) {
57
+ throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling getPayeeLocationById.');
48
58
  }
49
59
  if (requestParameters.payeeLocationId === null || requestParameters.payeeLocationId === undefined) {
50
60
  throw new runtime.RequiredError('payeeLocationId', 'Required parameter requestParameters.payeeLocationId was null or undefined when calling getPayeeLocationById.');
@@ -60,7 +70,7 @@ class PayeeLocationsApi extends runtime.BaseAPI {
60
70
  }
61
71
  }
62
72
  const response = await this.request({
63
- path: `/budgets/{budget_id}/payee_locations/{payee_location_id}`.replace(`{${"budget_id"}}`, encodeURIComponent(String(requestParameters.budgetId))).replace(`{${"payee_location_id"}}`, encodeURIComponent(String(requestParameters.payeeLocationId))),
73
+ path: `/budgets/{plan_id}/payee_locations/{payee_location_id}`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))).replace(`{${"payee_location_id"}}`, encodeURIComponent(String(requestParameters.payeeLocationId))),
64
74
  method: 'GET',
65
75
  headers: headerParameters,
66
76
  query: queryParameters,
@@ -69,19 +79,19 @@ class PayeeLocationsApi extends runtime.BaseAPI {
69
79
  }
70
80
  /**
71
81
  * Returns a single payee location
72
- * Single payee location
82
+ * Get a payee location
73
83
  */
74
- async getPayeeLocationById(budgetId, payeeLocationId, initOverrides) {
75
- const response = await this.getPayeeLocationByIdRaw({ budgetId: budgetId, payeeLocationId: payeeLocationId }, initOverrides);
84
+ async getPayeeLocationById(planId, payeeLocationId, initOverrides) {
85
+ const response = await this.getPayeeLocationByIdRaw({ planId: planId, payeeLocationId: payeeLocationId }, initOverrides);
76
86
  return await response.value();
77
87
  }
78
88
  /**
79
89
  * Returns all payee locations
80
- * List payee locations
90
+ * Get all payee locations
81
91
  */
82
92
  async getPayeeLocationsRaw(requestParameters, initOverrides) {
83
- if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
84
- throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling getPayeeLocations.');
93
+ if (requestParameters.planId === null || requestParameters.planId === undefined) {
94
+ throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling getPayeeLocations.');
85
95
  }
86
96
  const queryParameters = {};
87
97
  const headerParameters = {};
@@ -94,7 +104,7 @@ class PayeeLocationsApi extends runtime.BaseAPI {
94
104
  }
95
105
  }
96
106
  const response = await this.request({
97
- path: `/budgets/{budget_id}/payee_locations`.replace(`{${"budget_id"}}`, encodeURIComponent(String(requestParameters.budgetId))),
107
+ path: `/budgets/{plan_id}/payee_locations`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))),
98
108
  method: 'GET',
99
109
  headers: headerParameters,
100
110
  query: queryParameters,
@@ -103,19 +113,19 @@ class PayeeLocationsApi extends runtime.BaseAPI {
103
113
  }
104
114
  /**
105
115
  * Returns all payee locations
106
- * List payee locations
116
+ * Get all payee locations
107
117
  */
108
- async getPayeeLocations(budgetId, initOverrides) {
109
- const response = await this.getPayeeLocationsRaw({ budgetId: budgetId }, initOverrides);
118
+ async getPayeeLocations(planId, initOverrides) {
119
+ const response = await this.getPayeeLocationsRaw({ planId: planId }, initOverrides);
110
120
  return await response.value();
111
121
  }
112
122
  /**
113
123
  * Returns all payee locations for a specified payee
114
- * List locations for a payee
124
+ * Get all locations for a payee
115
125
  */
116
126
  async getPayeeLocationsByPayeeRaw(requestParameters, initOverrides) {
117
- if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
118
- throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling getPayeeLocationsByPayee.');
127
+ if (requestParameters.planId === null || requestParameters.planId === undefined) {
128
+ throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling getPayeeLocationsByPayee.');
119
129
  }
120
130
  if (requestParameters.payeeId === null || requestParameters.payeeId === undefined) {
121
131
  throw new runtime.RequiredError('payeeId', 'Required parameter requestParameters.payeeId was null or undefined when calling getPayeeLocationsByPayee.');
@@ -131,7 +141,7 @@ class PayeeLocationsApi extends runtime.BaseAPI {
131
141
  }
132
142
  }
133
143
  const response = await this.request({
134
- path: `/budgets/{budget_id}/payees/{payee_id}/payee_locations`.replace(`{${"budget_id"}}`, encodeURIComponent(String(requestParameters.budgetId))).replace(`{${"payee_id"}}`, encodeURIComponent(String(requestParameters.payeeId))),
144
+ path: `/budgets/{plan_id}/payees/{payee_id}/payee_locations`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))).replace(`{${"payee_id"}}`, encodeURIComponent(String(requestParameters.payeeId))),
135
145
  method: 'GET',
136
146
  headers: headerParameters,
137
147
  query: queryParameters,
@@ -140,10 +150,10 @@ class PayeeLocationsApi extends runtime.BaseAPI {
140
150
  }
141
151
  /**
142
152
  * Returns all payee locations for a specified payee
143
- * List locations for a payee
153
+ * Get all locations for a payee
144
154
  */
145
- async getPayeeLocationsByPayee(budgetId, payeeId, initOverrides) {
146
- const response = await this.getPayeeLocationsByPayeeRaw({ budgetId: budgetId, payeeId: payeeId }, initOverrides);
155
+ async getPayeeLocationsByPayee(planId, payeeId, initOverrides) {
156
+ const response = await this.getPayeeLocationsByPayeeRaw({ planId: planId, payeeId: payeeId }, initOverrides);
147
157
  return await response.value();
148
158
  }
149
159
  }
@@ -7,15 +7,15 @@
7
7
  import * as runtime from '../runtime';
8
8
  import type { PatchPayeeWrapper, PayeeResponse, PayeesResponse, SavePayeeResponse } from '../models/index';
9
9
  export interface GetPayeeByIdRequest {
10
- budgetId: string;
10
+ planId: string;
11
11
  payeeId: string;
12
12
  }
13
13
  export interface GetPayeesRequest {
14
- budgetId: string;
14
+ planId: string;
15
15
  lastKnowledgeOfServer?: number;
16
16
  }
17
17
  export interface UpdatePayeeRequest {
18
- budgetId: string;
18
+ planId: string;
19
19
  payeeId: string;
20
20
  data: PatchPayeeWrapper;
21
21
  }
@@ -25,24 +25,24 @@ export interface UpdatePayeeRequest {
25
25
  export declare class PayeesApi extends runtime.BaseAPI {
26
26
  /**
27
27
  * Returns a single payee
28
- * Single payee
28
+ * Get a payee
29
29
  */
30
30
  getPayeeByIdRaw(requestParameters: GetPayeeByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PayeeResponse>>;
31
31
  /**
32
32
  * Returns a single payee
33
- * Single payee
33
+ * Get a payee
34
34
  */
35
- getPayeeById(budgetId: string, payeeId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PayeeResponse>;
35
+ getPayeeById(planId: string, payeeId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PayeeResponse>;
36
36
  /**
37
37
  * Returns all payees
38
- * List payees
38
+ * Get all payees
39
39
  */
40
40
  getPayeesRaw(requestParameters: GetPayeesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PayeesResponse>>;
41
41
  /**
42
42
  * Returns all payees
43
- * List payees
43
+ * Get all payees
44
44
  */
45
- getPayees(budgetId: string, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PayeesResponse>;
45
+ getPayees(planId: string, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PayeesResponse>;
46
46
  /**
47
47
  * Update a payee
48
48
  * Update a payee
@@ -52,5 +52,5 @@ export declare class PayeesApi extends runtime.BaseAPI {
52
52
  * Update a payee
53
53
  * Update a payee
54
54
  */
55
- updatePayee(budgetId: string, payeeId: string, data: PatchPayeeWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SavePayeeResponse>;
55
+ updatePayee(planId: string, payeeId: string, data: PatchPayeeWrapper, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SavePayeeResponse>;
56
56
  }
@@ -23,13 +23,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
23
23
  }) : function(o, v) {
24
24
  o["default"] = v;
25
25
  });
26
- var __importStar = (this && this.__importStar) || function (mod) {
27
- if (mod && mod.__esModule) return mod;
28
- var result = {};
29
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
30
- __setModuleDefault(result, mod);
31
- return result;
32
- };
26
+ var __importStar = (this && this.__importStar) || (function () {
27
+ var ownKeys = function(o) {
28
+ ownKeys = Object.getOwnPropertyNames || function (o) {
29
+ var ar = [];
30
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
31
+ return ar;
32
+ };
33
+ return ownKeys(o);
34
+ };
35
+ return function (mod) {
36
+ if (mod && mod.__esModule) return mod;
37
+ var result = {};
38
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
39
+ __setModuleDefault(result, mod);
40
+ return result;
41
+ };
42
+ })();
33
43
  Object.defineProperty(exports, "__esModule", { value: true });
34
44
  exports.PayeesApi = void 0;
35
45
  const runtime = __importStar(require("../runtime"));
@@ -40,11 +50,11 @@ const index_1 = require("../models/index");
40
50
  class PayeesApi extends runtime.BaseAPI {
41
51
  /**
42
52
  * Returns a single payee
43
- * Single payee
53
+ * Get a payee
44
54
  */
45
55
  async getPayeeByIdRaw(requestParameters, initOverrides) {
46
- if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
47
- throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling getPayeeById.');
56
+ if (requestParameters.planId === null || requestParameters.planId === undefined) {
57
+ throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling getPayeeById.');
48
58
  }
49
59
  if (requestParameters.payeeId === null || requestParameters.payeeId === undefined) {
50
60
  throw new runtime.RequiredError('payeeId', 'Required parameter requestParameters.payeeId was null or undefined when calling getPayeeById.');
@@ -60,7 +70,7 @@ class PayeesApi extends runtime.BaseAPI {
60
70
  }
61
71
  }
62
72
  const response = await this.request({
63
- path: `/budgets/{budget_id}/payees/{payee_id}`.replace(`{${"budget_id"}}`, encodeURIComponent(String(requestParameters.budgetId))).replace(`{${"payee_id"}}`, encodeURIComponent(String(requestParameters.payeeId))),
73
+ path: `/budgets/{plan_id}/payees/{payee_id}`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))).replace(`{${"payee_id"}}`, encodeURIComponent(String(requestParameters.payeeId))),
64
74
  method: 'GET',
65
75
  headers: headerParameters,
66
76
  query: queryParameters,
@@ -69,19 +79,19 @@ class PayeesApi extends runtime.BaseAPI {
69
79
  }
70
80
  /**
71
81
  * Returns a single payee
72
- * Single payee
82
+ * Get a payee
73
83
  */
74
- async getPayeeById(budgetId, payeeId, initOverrides) {
75
- const response = await this.getPayeeByIdRaw({ budgetId: budgetId, payeeId: payeeId }, initOverrides);
84
+ async getPayeeById(planId, payeeId, initOverrides) {
85
+ const response = await this.getPayeeByIdRaw({ planId: planId, payeeId: payeeId }, initOverrides);
76
86
  return await response.value();
77
87
  }
78
88
  /**
79
89
  * Returns all payees
80
- * List payees
90
+ * Get all payees
81
91
  */
82
92
  async getPayeesRaw(requestParameters, initOverrides) {
83
- if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
84
- throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling getPayees.');
93
+ if (requestParameters.planId === null || requestParameters.planId === undefined) {
94
+ throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling getPayees.');
85
95
  }
86
96
  const queryParameters = {};
87
97
  if (requestParameters.lastKnowledgeOfServer !== undefined) {
@@ -97,7 +107,7 @@ class PayeesApi extends runtime.BaseAPI {
97
107
  }
98
108
  }
99
109
  const response = await this.request({
100
- path: `/budgets/{budget_id}/payees`.replace(`{${"budget_id"}}`, encodeURIComponent(String(requestParameters.budgetId))),
110
+ path: `/budgets/{plan_id}/payees`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))),
101
111
  method: 'GET',
102
112
  headers: headerParameters,
103
113
  query: queryParameters,
@@ -106,10 +116,10 @@ class PayeesApi extends runtime.BaseAPI {
106
116
  }
107
117
  /**
108
118
  * Returns all payees
109
- * List payees
119
+ * Get all payees
110
120
  */
111
- async getPayees(budgetId, lastKnowledgeOfServer, initOverrides) {
112
- const response = await this.getPayeesRaw({ budgetId: budgetId, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
121
+ async getPayees(planId, lastKnowledgeOfServer, initOverrides) {
122
+ const response = await this.getPayeesRaw({ planId: planId, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
113
123
  return await response.value();
114
124
  }
115
125
  /**
@@ -117,8 +127,8 @@ class PayeesApi extends runtime.BaseAPI {
117
127
  * Update a payee
118
128
  */
119
129
  async updatePayeeRaw(requestParameters, initOverrides) {
120
- if (requestParameters.budgetId === null || requestParameters.budgetId === undefined) {
121
- throw new runtime.RequiredError('budgetId', 'Required parameter requestParameters.budgetId was null or undefined when calling updatePayee.');
130
+ if (requestParameters.planId === null || requestParameters.planId === undefined) {
131
+ throw new runtime.RequiredError('planId', 'Required parameter requestParameters.planId was null or undefined when calling updatePayee.');
122
132
  }
123
133
  if (requestParameters.payeeId === null || requestParameters.payeeId === undefined) {
124
134
  throw new runtime.RequiredError('payeeId', 'Required parameter requestParameters.payeeId was null or undefined when calling updatePayee.');
@@ -138,7 +148,7 @@ class PayeesApi extends runtime.BaseAPI {
138
148
  }
139
149
  }
140
150
  const response = await this.request({
141
- path: `/budgets/{budget_id}/payees/{payee_id}`.replace(`{${"budget_id"}}`, encodeURIComponent(String(requestParameters.budgetId))).replace(`{${"payee_id"}}`, encodeURIComponent(String(requestParameters.payeeId))),
151
+ path: `/budgets/{plan_id}/payees/{payee_id}`.replace(`{${"plan_id"}}`, encodeURIComponent(String(requestParameters.planId))).replace(`{${"payee_id"}}`, encodeURIComponent(String(requestParameters.payeeId))),
142
152
  method: 'PATCH',
143
153
  headers: headerParameters,
144
154
  query: queryParameters,
@@ -150,8 +160,8 @@ class PayeesApi extends runtime.BaseAPI {
150
160
  * Update a payee
151
161
  * Update a payee
152
162
  */
153
- async updatePayee(budgetId, payeeId, data, initOverrides) {
154
- const response = await this.updatePayeeRaw({ budgetId: budgetId, payeeId: payeeId, data: data }, initOverrides);
163
+ async updatePayee(planId, payeeId, data, initOverrides) {
164
+ const response = await this.updatePayeeRaw({ planId: planId, payeeId: payeeId, data: data }, initOverrides);
155
165
  return await response.value();
156
166
  }
157
167
  }
@@ -0,0 +1,53 @@
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 * as runtime from '../runtime';
8
+ import type { PlanDetailResponse, PlanSettingsResponse, PlanSummaryResponse } from '../models/index';
9
+ export interface GetPlanByIdRequest {
10
+ planId: string;
11
+ lastKnowledgeOfServer?: number;
12
+ }
13
+ export interface GetPlanSettingsByIdRequest {
14
+ planId: string;
15
+ }
16
+ export interface GetPlansRequest {
17
+ includeAccounts?: boolean;
18
+ }
19
+ /**
20
+ *
21
+ */
22
+ export declare class PlansApi extends runtime.BaseAPI {
23
+ /**
24
+ * Returns a single plan with all related entities. This resource is effectively a full plan export.
25
+ * Get a plan
26
+ */
27
+ getPlanByIdRaw(requestParameters: GetPlanByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PlanDetailResponse>>;
28
+ /**
29
+ * Returns a single plan with all related entities. This resource is effectively a full plan export.
30
+ * Get a plan
31
+ */
32
+ getPlanById(planId: string, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PlanDetailResponse>;
33
+ /**
34
+ * Returns settings for a plan
35
+ * Get plan settings
36
+ */
37
+ getPlanSettingsByIdRaw(requestParameters: GetPlanSettingsByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PlanSettingsResponse>>;
38
+ /**
39
+ * Returns settings for a plan
40
+ * Get plan settings
41
+ */
42
+ getPlanSettingsById(planId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PlanSettingsResponse>;
43
+ /**
44
+ * Returns plans list with summary information
45
+ * Get all plans
46
+ */
47
+ getPlansRaw(requestParameters: GetPlansRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PlanSummaryResponse>>;
48
+ /**
49
+ * Returns plans list with summary information
50
+ * Get all plans
51
+ */
52
+ getPlans(includeAccounts?: boolean, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PlanSummaryResponse>;
53
+ }