ynab 3.8.0 → 4.9.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 (197) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -0
  3. data/Gemfile.lock +3 -1
  4. data/README.md +48 -40
  5. data/Rakefile +1 -1
  6. data/docs/Account.md +3 -3
  7. data/docs/AccountsApi.md +12 -12
  8. data/docs/CategoriesApi.md +89 -25
  9. data/docs/Category.md +5 -3
  10. data/docs/CategoryGroupWithCategories.md +1 -1
  11. data/docs/ExistingCategory.md +12 -0
  12. data/docs/MoneyMovement.md +16 -0
  13. data/docs/MoneyMovementGroup.md +12 -0
  14. data/docs/MoneyMovementGroupsResponse.md +8 -0
  15. data/docs/MoneyMovementGroupsResponseData.md +9 -0
  16. data/docs/MoneyMovementsApi.md +89 -0
  17. data/docs/{BudgetSettingsResponse.md → MoneyMovementsResponse.md} +2 -2
  18. data/docs/MoneyMovementsResponseData.md +9 -0
  19. data/docs/MonthDetail.md +2 -2
  20. data/docs/MonthSummary.md +1 -1
  21. data/docs/MonthsApi.md +13 -13
  22. data/docs/NewCategory.md +12 -0
  23. data/docs/PatchCategoryGroupWrapper.md +8 -0
  24. data/docs/PatchCategoryWrapper.md +1 -1
  25. data/docs/PayeeLocationsApi.md +12 -12
  26. data/docs/PayeesApi.md +11 -11
  27. data/docs/{BudgetDetail.md → PlanDetail.md} +4 -4
  28. data/docs/PlanDetailResponse.md +8 -0
  29. data/docs/{BudgetDetailResponseData.md → PlanDetailResponseData.md} +2 -2
  30. data/docs/{BudgetSettings.md → PlanSettings.md} +1 -1
  31. data/docs/{BudgetDetailResponse.md → PlanSettingsResponse.md} +2 -2
  32. data/docs/PlanSettingsResponseData.md +8 -0
  33. data/docs/PlanSummary.md +15 -0
  34. data/docs/PlanSummaryResponse.md +8 -0
  35. data/docs/PlanSummaryResponseData.md +9 -0
  36. data/docs/PlansApi.md +68 -0
  37. data/docs/PostCategoryGroupWrapper.md +8 -0
  38. data/docs/PostCategoryWrapper.md +8 -0
  39. data/docs/SaveCategory.md +2 -1
  40. data/docs/SaveCategoryGroup.md +8 -0
  41. data/docs/SaveCategoryGroupResponse.md +8 -0
  42. data/docs/SaveCategoryGroupResponseData.md +9 -0
  43. data/docs/SaveMonthCategory.md +1 -1
  44. data/docs/ScheduledTransactionsApi.md +20 -20
  45. data/docs/TransactionResponseData.md +1 -0
  46. data/docs/TransactionsApi.md +48 -48
  47. data/docs/UserApi.md +2 -2
  48. data/examples/category-balance.rb +2 -2
  49. data/examples/create-multiple-transactions.rb +2 -2
  50. data/examples/create-transaction.rb +2 -2
  51. data/examples/{budget-list.rb → plan-list.rb} +6 -6
  52. data/examples/{budget-month.rb → plan-month.rb} +9 -10
  53. data/examples/update-category-budgeted.rb +2 -2
  54. data/examples/update-multiple-transactions.rb +3 -3
  55. data/lib/ynab/api/accounts_api.rb +33 -34
  56. data/lib/ynab/api/categories_api.rb +293 -66
  57. data/lib/ynab/api/deprecated_api.rb +11 -11
  58. data/lib/ynab/api/money_movements_api.rb +282 -0
  59. data/lib/ynab/api/months_api.rb +35 -36
  60. data/lib/ynab/api/payee_locations_api.rb +33 -34
  61. data/lib/ynab/api/payees_api.rb +31 -32
  62. data/lib/ynab/api/{budgets_api.rb → plans_api.rb} +54 -55
  63. data/lib/ynab/api/scheduled_transactions_api.rb +55 -56
  64. data/lib/ynab/api/transactions_api.rb +130 -131
  65. data/lib/ynab/api/user_api.rb +2 -3
  66. data/lib/ynab/api_client.rb +0 -2
  67. data/lib/ynab/api_model_base.rb +85 -0
  68. data/lib/ynab/models/account.rb +4 -81
  69. data/lib/ynab/models/account_response.rb +1 -75
  70. data/lib/ynab/models/account_response_data.rb +1 -75
  71. data/lib/ynab/models/accounts_response.rb +1 -75
  72. data/lib/ynab/models/accounts_response_data.rb +1 -75
  73. data/lib/ynab/models/bulk_response.rb +1 -75
  74. data/lib/ynab/models/bulk_response_data.rb +1 -75
  75. data/lib/ynab/models/bulk_response_data_bulk.rb +1 -75
  76. data/lib/ynab/models/bulk_transactions.rb +1 -75
  77. data/lib/ynab/models/categories_response.rb +1 -75
  78. data/lib/ynab/models/categories_response_data.rb +1 -75
  79. data/lib/ynab/models/category.rb +27 -79
  80. data/lib/ynab/models/category_group.rb +1 -75
  81. data/lib/ynab/models/category_group_with_categories.rb +2 -76
  82. data/lib/ynab/models/category_response.rb +1 -75
  83. data/lib/ynab/models/category_response_data.rb +1 -75
  84. data/lib/ynab/models/currency_format.rb +2 -76
  85. data/lib/ynab/models/date_format.rb +2 -76
  86. data/lib/ynab/models/error_detail.rb +1 -75
  87. data/lib/ynab/models/error_response.rb +1 -75
  88. data/lib/ynab/models/existing_category.rb +180 -0
  89. data/lib/ynab/models/existing_transaction.rb +1 -79
  90. data/lib/ynab/models/hybrid_transaction.rb +1 -85
  91. data/lib/ynab/models/hybrid_transactions_response.rb +1 -75
  92. data/lib/ynab/models/hybrid_transactions_response_data.rb +1 -75
  93. data/lib/ynab/models/money_movement.rb +223 -0
  94. data/lib/ynab/models/money_movement_group.rb +179 -0
  95. data/lib/ynab/models/{budget_summary_response.rb → money_movement_groups_response.rb} +4 -78
  96. data/lib/ynab/models/money_movement_groups_response_data.rb +149 -0
  97. data/lib/ynab/models/{budget_settings_response.rb → money_movements_response.rb} +4 -78
  98. data/lib/ynab/models/money_movements_response_data.rb +149 -0
  99. data/lib/ynab/models/month_detail.rb +3 -79
  100. data/lib/ynab/models/month_detail_response.rb +1 -75
  101. data/lib/ynab/models/month_detail_response_data.rb +1 -75
  102. data/lib/ynab/models/month_summaries_response.rb +1 -75
  103. data/lib/ynab/models/month_summaries_response_data.rb +1 -75
  104. data/lib/ynab/models/month_summary.rb +2 -76
  105. data/lib/ynab/models/new_category.rb +180 -0
  106. data/lib/ynab/models/new_transaction.rb +1 -79
  107. data/lib/ynab/models/patch_category_group_wrapper.rb +136 -0
  108. data/lib/ynab/models/patch_category_wrapper.rb +2 -76
  109. data/lib/ynab/models/patch_month_category_wrapper.rb +1 -75
  110. data/lib/ynab/models/patch_payee_wrapper.rb +1 -75
  111. data/lib/ynab/models/patch_transactions_wrapper.rb +1 -75
  112. data/lib/ynab/models/payee.rb +1 -75
  113. data/lib/ynab/models/payee_location.rb +1 -75
  114. data/lib/ynab/models/payee_location_response.rb +1 -75
  115. data/lib/ynab/models/payee_location_response_data.rb +1 -75
  116. data/lib/ynab/models/payee_locations_response.rb +1 -75
  117. data/lib/ynab/models/payee_locations_response_data.rb +1 -75
  118. data/lib/ynab/models/payee_response.rb +1 -75
  119. data/lib/ynab/models/payee_response_data.rb +1 -75
  120. data/lib/ynab/models/payees_response.rb +1 -75
  121. data/lib/ynab/models/payees_response_data.rb +1 -75
  122. data/lib/ynab/models/{budget_detail.rb → plan_detail.rb} +7 -83
  123. data/lib/ynab/models/plan_detail_response.rb +136 -0
  124. data/lib/ynab/models/{budget_detail_response_data.rb → plan_detail_response_data.rb} +4 -78
  125. data/lib/ynab/models/{budget_settings.rb → plan_settings.rb} +5 -79
  126. data/lib/ynab/models/{budget_detail_response.rb → plan_settings_response.rb} +4 -78
  127. data/lib/ynab/models/{budget_settings_response_data.rb → plan_settings_response_data.rb} +4 -78
  128. data/lib/ynab/models/{budget_summary.rb → plan_summary.rb} +7 -83
  129. data/lib/ynab/models/plan_summary_response.rb +136 -0
  130. data/lib/ynab/models/{budget_summary_response_data.rb → plan_summary_response_data.rb} +5 -79
  131. data/lib/ynab/models/post_account_wrapper.rb +1 -75
  132. data/lib/ynab/models/post_category_group_wrapper.rb +136 -0
  133. data/lib/ynab/models/post_category_wrapper.rb +136 -0
  134. data/lib/ynab/models/post_scheduled_transaction_wrapper.rb +1 -75
  135. data/lib/ynab/models/post_transactions_wrapper.rb +1 -75
  136. data/lib/ynab/models/put_scheduled_transaction_wrapper.rb +1 -75
  137. data/lib/ynab/models/put_transaction_wrapper.rb +1 -75
  138. data/lib/ynab/models/save_account.rb +1 -75
  139. data/lib/ynab/models/save_category.rb +18 -81
  140. data/lib/ynab/models/save_category_group.rb +148 -0
  141. data/lib/ynab/models/save_category_group_response.rb +136 -0
  142. data/lib/ynab/models/save_category_group_response_data.rb +147 -0
  143. data/lib/ynab/models/save_category_response.rb +1 -75
  144. data/lib/ynab/models/save_category_response_data.rb +1 -75
  145. data/lib/ynab/models/save_month_category.rb +2 -76
  146. data/lib/ynab/models/save_payee.rb +1 -75
  147. data/lib/ynab/models/save_payee_response.rb +1 -75
  148. data/lib/ynab/models/save_payee_response_data.rb +1 -75
  149. data/lib/ynab/models/save_scheduled_transaction.rb +1 -75
  150. data/lib/ynab/models/save_sub_transaction.rb +1 -75
  151. data/lib/ynab/models/save_transaction_with_id_or_import_id.rb +1 -79
  152. data/lib/ynab/models/save_transaction_with_optional_fields.rb +1 -75
  153. data/lib/ynab/models/save_transactions_response.rb +1 -75
  154. data/lib/ynab/models/save_transactions_response_data.rb +1 -75
  155. data/lib/ynab/models/scheduled_sub_transaction.rb +1 -75
  156. data/lib/ynab/models/scheduled_transaction_detail.rb +1 -80
  157. data/lib/ynab/models/scheduled_transaction_response.rb +1 -75
  158. data/lib/ynab/models/scheduled_transaction_response_data.rb +1 -75
  159. data/lib/ynab/models/scheduled_transaction_summary.rb +1 -75
  160. data/lib/ynab/models/scheduled_transactions_response.rb +1 -75
  161. data/lib/ynab/models/scheduled_transactions_response_data.rb +1 -75
  162. data/lib/ynab/models/sub_transaction.rb +1 -75
  163. data/lib/ynab/models/transaction_detail.rb +1 -85
  164. data/lib/ynab/models/transaction_flag_color.rb +2 -1
  165. data/lib/ynab/models/transaction_response.rb +1 -75
  166. data/lib/ynab/models/transaction_response_data.rb +16 -79
  167. data/lib/ynab/models/transaction_summary.rb +1 -75
  168. data/lib/ynab/models/transactions_import_response.rb +1 -75
  169. data/lib/ynab/models/transactions_import_response_data.rb +1 -75
  170. data/lib/ynab/models/transactions_response.rb +1 -75
  171. data/lib/ynab/models/transactions_response_data.rb +1 -75
  172. data/lib/ynab/models/user.rb +1 -75
  173. data/lib/ynab/models/user_response.rb +1 -75
  174. data/lib/ynab/models/user_response_data.rb +1 -75
  175. data/lib/ynab/overrides/transactions_api.rb +6 -6
  176. data/lib/ynab/version.rb +1 -1
  177. data/lib/ynab.rb +28 -13
  178. data/open_api_spec.yaml +1163 -905
  179. data/spec/api/accounts_spec.rb +9 -9
  180. data/spec/api/categories_spec.rb +9 -9
  181. data/spec/api/months_spec.rb +7 -7
  182. data/spec/api/payee_locations_spec.rb +7 -7
  183. data/spec/api/payees_spec.rb +7 -7
  184. data/spec/api/{budgets_spec.rb → plans_spec.rb} +12 -12
  185. data/spec/api/scheduled_transactions_spec.rb +9 -9
  186. data/spec/api/transactions_spec.rb +28 -28
  187. data/spec/fixtures/vcr_cassettes/plans.yml +49 -0
  188. data/spec/fixtures/vcr_cassettes/plans_unauthorized.yml +49 -0
  189. data/templates/gem.mustache +3 -2
  190. data/templates/partial_model_generic.mustache +1 -1
  191. data/ynab.gemspec +1 -2
  192. metadata +94 -59
  193. data/docs/BudgetSettingsResponseData.md +0 -8
  194. data/docs/BudgetSummary.md +0 -15
  195. data/docs/BudgetSummaryResponse.md +0 -8
  196. data/docs/BudgetSummaryResponseData.md +0 -9
  197. data/docs/BudgetsApi.md +0 -68
data/docs/MoneyMovementsApi.md ADDED
@@ -0,0 +1,89 @@
1
+ # YNAB::MoneyMovementsApi
2
+
3
+ All URIs are relative to *https://api.ynab.com/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_money_movement_groups**](MoneyMovementsApi.md#get_money_movement_groups) | **GET** /budgets/{plan_id}/money_movement_groups | Get all money movement groups |
8
+ | [**get_money_movement_groups_by_month**](MoneyMovementsApi.md#get_money_movement_groups_by_month) | **GET** /budgets/{plan_id}/months/{month}/money_movement_groups | Get money movement groups for a plan month |
9
+ | [**get_money_movements**](MoneyMovementsApi.md#get_money_movements) | **GET** /budgets/{plan_id}/money_movements | Get all money movements |
10
+ | [**get_money_movements_by_month**](MoneyMovementsApi.md#get_money_movements_by_month) | **GET** /budgets/{plan_id}/months/{month}/money_movements | Get money movements for a plan month |
11
+
12
+
13
+ ## get_money_movement_groups
14
+
15
+ > <MoneyMovementGroupsResponse> get_money_movement_groups(plan_id)
16
+
17
+ Get all money movement groups
18
+
19
+ Returns all money movement groups
20
+
21
+ ### Parameters
22
+
23
+ | Name | Type | Description | Notes |
24
+ | ---- | ---- | ----------- | ----- |
25
+ | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
26
+
27
+ ### Return type
28
+
29
+ [**MoneyMovementGroupsResponse**](MoneyMovementGroupsResponse.md)
30
+
31
+
32
+ ## get_money_movement_groups_by_month
33
+
34
+ > <MoneyMovementGroupsResponse> get_money_movement_groups_by_month(plan_id, month)
35
+
36
+ Get money movement groups for a plan month
37
+
38
+ Returns all money movement groups for a specific month
39
+
40
+ ### Parameters
41
+
42
+ | Name | Type | Description | Notes |
43
+ | ---- | ---- | ----------- | ----- |
44
+ | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
45
+ | **month** | **Date** | The plan month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC)) | |
46
+
47
+ ### Return type
48
+
49
+ [**MoneyMovementGroupsResponse**](MoneyMovementGroupsResponse.md)
50
+
51
+
52
+ ## get_money_movements
53
+
54
+ > <MoneyMovementsResponse> get_money_movements(plan_id)
55
+
56
+ Get all money movements
57
+
58
+ Returns all money movements
59
+
60
+ ### Parameters
61
+
62
+ | Name | Type | Description | Notes |
63
+ | ---- | ---- | ----------- | ----- |
64
+ | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
65
+
66
+ ### Return type
67
+
68
+ [**MoneyMovementsResponse**](MoneyMovementsResponse.md)
69
+
70
+
71
+ ## get_money_movements_by_month
72
+
73
+ > <MoneyMovementsResponse> get_money_movements_by_month(plan_id, month)
74
+
75
+ Get money movements for a plan month
76
+
77
+ Returns all money movements for a specific month
78
+
79
+ ### Parameters
80
+
81
+ | Name | Type | Description | Notes |
82
+ | ---- | ---- | ----------- | ----- |
83
+ | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
84
+ | **month** | **Date** | The plan month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC)) | |
85
+
86
+ ### Return type
87
+
88
+ [**MoneyMovementsResponse**](MoneyMovementsResponse.md)
89
+
data/docs/{BudgetSettingsResponse.md → MoneyMovementsResponse.md} RENAMED
@@ -1,8 +1,8 @@
1
- # YNAB::BudgetSettingsResponse
1
+ # YNAB::MoneyMovementsResponse
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **data** | [**BudgetSettingsResponseData**](BudgetSettingsResponseData.md) | | |
7
+ | **data** | [**MoneyMovementsResponseData**](MoneyMovementsResponseData.md) | | |
8
8
 
data/docs/MoneyMovementsResponseData.md ADDED
@@ -0,0 +1,9 @@
1
+ # YNAB::MoneyMovementsResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **money_movements** | [**Array&lt;MoneyMovement&gt;**](MoneyMovement.md) | | |
8
+ | **server_knowledge** | **Integer** | The knowledge of the server | |
9
+
data/docs/MonthDetail.md CHANGED
@@ -7,10 +7,10 @@
7
7
  | **month** | **Date** | | |
8
8
  | **note** | **String** | | [optional] |
9
9
  | **income** | **Integer** | The total amount of transactions categorized to &#39;Inflow: Ready to Assign&#39; in the month | |
10
- | **budgeted** | **Integer** | The total amount budgeted in the month | |
10
+ | **budgeted** | **Integer** | The total amount assigned (budgeted) in the month | |
11
11
  | **activity** | **Integer** | The total amount of transactions in the month, excluding those categorized to &#39;Inflow: Ready to Assign&#39; | |
12
12
  | **to_be_budgeted** | **Integer** | The available amount for &#39;Ready to Assign&#39; | |
13
13
  | **age_of_money** | **Integer** | The Age of Money as of the month | [optional] |
14
14
  | **deleted** | **Boolean** | Whether or not the month has been deleted. Deleted months will only be included in delta requests. | |
15
- | **categories** | [**Array&lt;Category&gt;**](Category.md) | The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified. | |
15
+ | **categories** | [**Array&lt;Category&gt;**](Category.md) | The plan month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified. | |
16
16
 
data/docs/MonthSummary.md CHANGED
@@ -7,7 +7,7 @@
7
7
  | **month** | **Date** | | |
8
8
  | **note** | **String** | | [optional] |
9
9
  | **income** | **Integer** | The total amount of transactions categorized to &#39;Inflow: Ready to Assign&#39; in the month | |
10
- | **budgeted** | **Integer** | The total amount budgeted in the month | |
10
+ | **budgeted** | **Integer** | The total amount assigned (budgeted) in the month | |
11
11
  | **activity** | **Integer** | The total amount of transactions in the month, excluding those categorized to &#39;Inflow: Ready to Assign&#39; | |
12
12
  | **to_be_budgeted** | **Integer** | The available amount for &#39;Ready to Assign&#39; | |
13
13
  | **age_of_money** | **Integer** | The Age of Money as of the month | [optional] |
data/docs/MonthsApi.md CHANGED
@@ -4,43 +4,43 @@ All URIs are relative to *https://api.ynab.com/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**get_budget_month**](MonthsApi.md#get_budget_month) | **GET** /budgets/{budget_id}/months/{month} | Single budget month |
8
- | [**get_budget_months**](MonthsApi.md#get_budget_months) | **GET** /budgets/{budget_id}/months | List budget months |
7
+ | [**get_plan_month**](MonthsApi.md#get_plan_month) | **GET** /budgets/{plan_id}/months/{month} | Get a plan month |
8
+ | [**get_plan_months**](MonthsApi.md#get_plan_months) | **GET** /budgets/{plan_id}/months | Get all plan months |
9
9
 
10
10
 
11
- ## get_budget_month
11
+ ## get_plan_month
12
12
 
13
- > <MonthDetailResponse> get_budget_month(budget_id, month)
13
+ > <MonthDetailResponse> get_plan_month(plan_id, month)
14
14
 
15
- Single budget month
15
+ Get a plan month
16
16
 
17
- Returns a single budget month
17
+ Returns a single plan month
18
18
 
19
19
  ### Parameters
20
20
 
21
21
  | Name | Type | Description | Notes |
22
22
  | ---- | ---- | ----------- | ----- |
23
- | **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). | |
24
- | **month** | **Date** | The budget month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC)) | |
23
+ | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
24
+ | **month** | **Date** | The plan month in ISO format (e.g. 2016-12-01) (\&quot;current\&quot; can also be used to specify the current calendar month (UTC)) | |
25
25
 
26
26
  ### Return type
27
27
 
28
28
  [**MonthDetailResponse**](MonthDetailResponse.md)
29
29
 
30
30
 
31
- ## get_budget_months
31
+ ## get_plan_months
32
32
 
33
- > <MonthSummariesResponse> get_budget_months(budget_id, opts)
33
+ > <MonthSummariesResponse> get_plan_months(plan_id, opts)
34
34
 
35
- List budget months
35
+ Get all plan months
36
36
 
37
- Returns all budget months
37
+ Returns all plan months
38
38
 
39
39
  ### Parameters
40
40
 
41
41
  | Name | Type | Description | Notes |
42
42
  | ---- | ---- | ----------- | ----- |
43
- | **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). | |
43
+ | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
44
44
  | **last_knowledge_of_server** | **Integer** | The starting server knowledge. If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included. | [optional] |
45
45
 
46
46
  ### Return type
data/docs/NewCategory.md ADDED
@@ -0,0 +1,12 @@
1
+ # YNAB::NewCategory
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | [optional] |
8
+ | **note** | **String** | | [optional] |
9
+ | **category_group_id** | **String** | | [optional] |
10
+ | **goal_target** | **Integer** | The goal target amount in milliunits format. If value is specified and goal has not already been configured for category, a monthly &#39;Needed for Spending&#39; goal will be created for the category with this target amount. | [optional] |
11
+ | **goal_target_date** | **Date** | The goal target date in ISO format (e.g. 2016-12-01). | [optional] |
12
+
data/docs/PatchCategoryGroupWrapper.md ADDED
@@ -0,0 +1,8 @@
1
+ # YNAB::PatchCategoryGroupWrapper
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **category_group** | [**SaveCategoryGroup**](SaveCategoryGroup.md) | | |
8
+
data/docs/PatchCategoryWrapper.md CHANGED
@@ -4,5 +4,5 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **category** | [**SaveCategory**](SaveCategory.md) | | |
7
+ | **category** | [**ExistingCategory**](ExistingCategory.md) | | |
8
8
 
data/docs/PayeeLocationsApi.md CHANGED
@@ -4,16 +4,16 @@ All URIs are relative to *https://api.ynab.com/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**get_payee_location_by_id**](PayeeLocationsApi.md#get_payee_location_by_id) | **GET** /budgets/{budget_id}/payee_locations/{payee_location_id} | Single payee location |
8
- | [**get_payee_locations**](PayeeLocationsApi.md#get_payee_locations) | **GET** /budgets/{budget_id}/payee_locations | List payee locations |
9
- | [**get_payee_locations_by_payee**](PayeeLocationsApi.md#get_payee_locations_by_payee) | **GET** /budgets/{budget_id}/payees/{payee_id}/payee_locations | List locations for a payee |
7
+ | [**get_payee_location_by_id**](PayeeLocationsApi.md#get_payee_location_by_id) | **GET** /budgets/{plan_id}/payee_locations/{payee_location_id} | Get a payee location |
8
+ | [**get_payee_locations**](PayeeLocationsApi.md#get_payee_locations) | **GET** /budgets/{plan_id}/payee_locations | Get all payee locations |
9
+ | [**get_payee_locations_by_payee**](PayeeLocationsApi.md#get_payee_locations_by_payee) | **GET** /budgets/{plan_id}/payees/{payee_id}/payee_locations | Get all locations for a payee |
10
10
 
11
11
 
12
12
  ## get_payee_location_by_id
13
13
 
14
- > <PayeeLocationResponse> get_payee_location_by_id(budget_id, payee_location_id)
14
+ > <PayeeLocationResponse> get_payee_location_by_id(plan_id, payee_location_id)
15
15
 
16
- Single payee location
16
+ Get a payee location
17
17
 
18
18
  Returns a single payee location
19
19
 
@@ -21,7 +21,7 @@ Returns a single payee location
21
21
 
22
22
  | Name | Type | Description | Notes |
23
23
  | ---- | ---- | ----------- | ----- |
24
- | **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). | |
24
+ | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
25
25
  | **payee_location_id** | **String** | id of payee location | |
26
26
 
27
27
  ### Return type
@@ -31,9 +31,9 @@ Returns a single payee location
31
31
 
32
32
  ## get_payee_locations
33
33
 
34
- > <PayeeLocationsResponse> get_payee_locations(budget_id)
34
+ > <PayeeLocationsResponse> get_payee_locations(plan_id)
35
35
 
36
- List payee locations
36
+ Get all payee locations
37
37
 
38
38
  Returns all payee locations
39
39
 
@@ -41,7 +41,7 @@ Returns all payee locations
41
41
 
42
42
  | Name | Type | Description | Notes |
43
43
  | ---- | ---- | ----------- | ----- |
44
- | **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). | |
44
+ | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
45
45
 
46
46
  ### Return type
47
47
 
@@ -50,9 +50,9 @@ Returns all payee locations
50
50
 
51
51
  ## get_payee_locations_by_payee
52
52
 
53
- > <PayeeLocationsResponse> get_payee_locations_by_payee(budget_id, payee_id)
53
+ > <PayeeLocationsResponse> get_payee_locations_by_payee(plan_id, payee_id)
54
54
 
55
- List locations for a payee
55
+ Get all locations for a payee
56
56
 
57
57
  Returns all payee locations for a specified payee
58
58
 
@@ -60,7 +60,7 @@ Returns all payee locations for a specified payee
60
60
 
61
61
  | Name | Type | Description | Notes |
62
62
  | ---- | ---- | ----------- | ----- |
63
- | **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). | |
63
+ | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
64
64
  | **payee_id** | **String** | id of payee | |
65
65
 
66
66
  ### Return type
data/docs/PayeesApi.md CHANGED
@@ -4,16 +4,16 @@ All URIs are relative to *https://api.ynab.com/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**get_payee_by_id**](PayeesApi.md#get_payee_by_id) | **GET** /budgets/{budget_id}/payees/{payee_id} | Single payee |
8
- | [**get_payees**](PayeesApi.md#get_payees) | **GET** /budgets/{budget_id}/payees | List payees |
9
- | [**update_payee**](PayeesApi.md#update_payee) | **PATCH** /budgets/{budget_id}/payees/{payee_id} | Update a payee |
7
+ | [**get_payee_by_id**](PayeesApi.md#get_payee_by_id) | **GET** /budgets/{plan_id}/payees/{payee_id} | Get a payee |
8
+ | [**get_payees**](PayeesApi.md#get_payees) | **GET** /budgets/{plan_id}/payees | Get all payees |
9
+ | [**update_payee**](PayeesApi.md#update_payee) | **PATCH** /budgets/{plan_id}/payees/{payee_id} | Update a payee |
10
10
 
11
11
 
12
12
  ## get_payee_by_id
13
13
 
14
- > <PayeeResponse> get_payee_by_id(budget_id, payee_id)
14
+ > <PayeeResponse> get_payee_by_id(plan_id, payee_id)
15
15
 
16
- Single payee
16
+ Get a payee
17
17
 
18
18
  Returns a single payee
19
19
 
@@ -21,7 +21,7 @@ Returns a single payee
21
21
 
22
22
  | Name | Type | Description | Notes |
23
23
  | ---- | ---- | ----------- | ----- |
24
- | **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). | |
24
+ | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
25
25
  | **payee_id** | **String** | The id of the payee | |
26
26
 
27
27
  ### Return type
@@ -31,9 +31,9 @@ Returns a single payee
31
31
 
32
32
  ## get_payees
33
33
 
34
- > <PayeesResponse> get_payees(budget_id, opts)
34
+ > <PayeesResponse> get_payees(plan_id, opts)
35
35
 
36
- List payees
36
+ Get all payees
37
37
 
38
38
  Returns all payees
39
39
 
@@ -41,7 +41,7 @@ Returns all payees
41
41
 
42
42
  | Name | Type | Description | Notes |
43
43
  | ---- | ---- | ----------- | ----- |
44
- | **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). | |
44
+ | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
45
45
  | **last_knowledge_of_server** | **Integer** | The starting server knowledge. If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included. | [optional] |
46
46
 
47
47
  ### Return type
@@ -51,7 +51,7 @@ Returns all payees
51
51
 
52
52
  ## update_payee
53
53
 
54
- > <SavePayeeResponse> update_payee(budget_id, payee_id, data)
54
+ > <SavePayeeResponse> update_payee(plan_id, payee_id, data)
55
55
 
56
56
  Update a payee
57
57
 
@@ -61,7 +61,7 @@ Update a payee
61
61
 
62
62
  | Name | Type | Description | Notes |
63
63
  | ---- | ---- | ----------- | ----- |
64
- | **budget_id** | **String** | The id of the budget. \&quot;last-used\&quot; can be used to specify the last used budget and \&quot;default\&quot; can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). | |
64
+ | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
65
65
  | **payee_id** | **String** | The id of the payee | |
66
66
  | **data** | [**PatchPayeeWrapper**](PatchPayeeWrapper.md) | The payee to update | |
67
67
 
data/docs/{BudgetDetail.md → PlanDetail.md} RENAMED
@@ -1,4 +1,4 @@
1
- # YNAB::BudgetDetail
1
+ # YNAB::PlanDetail
2
2
 
3
3
  ## Properties
4
4
 
@@ -6,9 +6,9 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | |
8
8
  | **name** | **String** | | |
9
- | **last_modified_on** | **Time** | The last time any changes were made to the budget from either a web or mobile client | [optional] |
10
- | **first_month** | **Date** | The earliest budget month | [optional] |
11
- | **last_month** | **Date** | The latest budget month | [optional] |
9
+ | **last_modified_on** | **Time** | The last time any changes were made to the plan from either a web or mobile client | [optional] |
10
+ | **first_month** | **Date** | The earliest plan month | [optional] |
11
+ | **last_month** | **Date** | The latest plan month | [optional] |
12
12
  | **date_format** | [**DateFormat**](DateFormat.md) | | [optional] |
13
13
  | **currency_format** | [**CurrencyFormat**](CurrencyFormat.md) | | [optional] |
14
14
  | **accounts** | [**Array&lt;Account&gt;**](Account.md) | | [optional] |
data/docs/PlanDetailResponse.md ADDED
@@ -0,0 +1,8 @@
1
+ # YNAB::PlanDetailResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**PlanDetailResponseData**](PlanDetailResponseData.md) | | |
8
+
data/docs/{BudgetDetailResponseData.md → PlanDetailResponseData.md} RENAMED
@@ -1,9 +1,9 @@
1
- # YNAB::BudgetDetailResponseData
1
+ # YNAB::PlanDetailResponseData
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **budget** | [**BudgetDetail**](BudgetDetail.md) | | |
7
+ | **budget** | [**PlanDetail**](PlanDetail.md) | | |
8
8
  | **server_knowledge** | **Integer** | The knowledge of the server | |
9
9
 
data/docs/{BudgetSettings.md → PlanSettings.md} RENAMED
@@ -1,4 +1,4 @@
1
- # YNAB::BudgetSettings
1
+ # YNAB::PlanSettings
2
2
 
3
3
  ## Properties
4
4
 
data/docs/{BudgetDetailResponse.md → PlanSettingsResponse.md} RENAMED
@@ -1,8 +1,8 @@
1
- # YNAB::BudgetDetailResponse
1
+ # YNAB::PlanSettingsResponse
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **data** | [**BudgetDetailResponseData**](BudgetDetailResponseData.md) | | |
7
+ | **data** | [**PlanSettingsResponseData**](PlanSettingsResponseData.md) | | |
8
8
 
data/docs/PlanSettingsResponseData.md ADDED
@@ -0,0 +1,8 @@
1
+ # YNAB::PlanSettingsResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **settings** | [**PlanSettings**](PlanSettings.md) | | |
8
+
data/docs/PlanSummary.md ADDED
@@ -0,0 +1,15 @@
1
+ # YNAB::PlanSummary
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **name** | **String** | | |
9
+ | **last_modified_on** | **Time** | The last time any changes were made to the plan from either a web or mobile client | [optional] |
10
+ | **first_month** | **Date** | The earliest plan month | [optional] |
11
+ | **last_month** | **Date** | The latest plan month | [optional] |
12
+ | **date_format** | [**DateFormat**](DateFormat.md) | | [optional] |
13
+ | **currency_format** | [**CurrencyFormat**](CurrencyFormat.md) | | [optional] |
14
+ | **accounts** | [**Array&lt;Account&gt;**](Account.md) | The plan accounts (only included if &#x60;include_accounts&#x3D;true&#x60; specified as query parameter) | [optional] |
15
+
data/docs/PlanSummaryResponse.md ADDED
@@ -0,0 +1,8 @@
1
+ # YNAB::PlanSummaryResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**PlanSummaryResponseData**](PlanSummaryResponseData.md) | | |
8
+
data/docs/PlanSummaryResponseData.md ADDED
@@ -0,0 +1,9 @@
1
+ # YNAB::PlanSummaryResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **budgets** | [**Array&lt;PlanSummary&gt;**](PlanSummary.md) | | |
8
+ | **default_budget** | [**PlanSummary**](PlanSummary.md) | | [optional] |
9
+
data/docs/PlansApi.md ADDED
@@ -0,0 +1,68 @@
1
+ # YNAB::PlansApi
2
+
3
+ All URIs are relative to *https://api.ynab.com/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_plan_by_id**](PlansApi.md#get_plan_by_id) | **GET** /budgets/{plan_id} | Get a plan |
8
+ | [**get_plan_settings_by_id**](PlansApi.md#get_plan_settings_by_id) | **GET** /budgets/{plan_id}/settings | Get plan settings |
9
+ | [**get_plans**](PlansApi.md#get_plans) | **GET** /budgets | Get all plans |
10
+
11
+
12
+ ## get_plan_by_id
13
+
14
+ > <PlanDetailResponse> get_plan_by_id(plan_id, opts)
15
+
16
+ Get a plan
17
+
18
+ Returns a single plan with all related entities. This resource is effectively a full plan export.
19
+
20
+ ### Parameters
21
+
22
+ | Name | Type | Description | Notes |
23
+ | ---- | ---- | ----------- | ----- |
24
+ | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
25
+ | **last_knowledge_of_server** | **Integer** | The starting server knowledge. If provided, only entities that have changed since &#x60;last_knowledge_of_server&#x60; will be included. | [optional] |
26
+
27
+ ### Return type
28
+
29
+ [**PlanDetailResponse**](PlanDetailResponse.md)
30
+
31
+
32
+ ## get_plan_settings_by_id
33
+
34
+ > <PlanSettingsResponse> get_plan_settings_by_id(plan_id)
35
+
36
+ Get plan settings
37
+
38
+ Returns settings for a plan
39
+
40
+ ### Parameters
41
+
42
+ | Name | Type | Description | Notes |
43
+ | ---- | ---- | ----------- | ----- |
44
+ | **plan_id** | **String** | The id of the plan. \&quot;last-used\&quot; can be used to specify the last used plan and \&quot;default\&quot; can be used if default plan selection is enabled (see: https://api.ynab.com/#oauth-default-plan). | |
45
+
46
+ ### Return type
47
+
48
+ [**PlanSettingsResponse**](PlanSettingsResponse.md)
49
+
50
+
51
+ ## get_plans
52
+
53
+ > <PlanSummaryResponse> get_plans(opts)
54
+
55
+ Get all plans
56
+
57
+ Returns plans list with summary information
58
+
59
+ ### Parameters
60
+
61
+ | Name | Type | Description | Notes |
62
+ | ---- | ---- | ----------- | ----- |
63
+ | **include_accounts** | **Boolean** | Whether to include the list of plan accounts | [optional] |
64
+
65
+ ### Return type
66
+
67
+ [**PlanSummaryResponse**](PlanSummaryResponse.md)
68
+
data/docs/PostCategoryGroupWrapper.md ADDED
@@ -0,0 +1,8 @@
1
+ # YNAB::PostCategoryGroupWrapper
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **category_group** | [**SaveCategoryGroup**](SaveCategoryGroup.md) | | |
8
+
data/docs/PostCategoryWrapper.md ADDED
@@ -0,0 +1,8 @@
1
+ # YNAB::PostCategoryWrapper
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **category** | [**NewCategory**](NewCategory.md) | | |
8
+
data/docs/SaveCategory.md CHANGED
@@ -7,5 +7,6 @@
7
7
  | **name** | **String** | | [optional] |
8
8
  | **note** | **String** | | [optional] |
9
9
  | **category_group_id** | **String** | | [optional] |
10
- | **goal_target** | **Integer** | The goal target amount in milliunits format. This amount can only be changed if the category already has a configured goal (goal_type !&#x3D; null). | [optional] |
10
+ | **goal_target** | **Integer** | The goal target amount in milliunits format. If value is specified and goal has not already been configured for category, a monthly &#39;Needed for Spending&#39; goal will be created for the category with this target amount. | [optional] |
11
+ | **goal_target_date** | **Date** | The goal target date in ISO format (e.g. 2016-12-01). | [optional] |
11
12
 
data/docs/SaveCategoryGroup.md ADDED
@@ -0,0 +1,8 @@
1
+ # YNAB::SaveCategoryGroup
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The name of the category group. The name must be a maximum of 50 characters. | |
8
+
data/docs/SaveCategoryGroupResponse.md ADDED
@@ -0,0 +1,8 @@
1
+ # YNAB::SaveCategoryGroupResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**SaveCategoryGroupResponseData**](SaveCategoryGroupResponseData.md) | | |
8
+
data/docs/SaveCategoryGroupResponseData.md ADDED
@@ -0,0 +1,9 @@
1
+ # YNAB::SaveCategoryGroupResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **category_group** | [**CategoryGroup**](CategoryGroup.md) | | |
8
+ | **server_knowledge** | **Integer** | The knowledge of the server | |
9
+
data/docs/SaveMonthCategory.md CHANGED
@@ -4,5 +4,5 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **budgeted** | **Integer** | Budgeted amount in milliunits format | |
7
+ | **budgeted** | **Integer** | Assigned (budgeted) amount in milliunits format | |
8
8