ynab 0.6.0 → 0.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (98) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +24 -24
  4. data/Rakefile +1 -1
  5. data/config.json +1 -1
  6. data/docs/AccountsApi.md +0 -76
  7. data/docs/BudgetsApi.md +0 -74
  8. data/docs/CategoriesApi.md +0 -76
  9. data/docs/CurrencyFormat.md +8 -1
  10. data/docs/DateFormat.md +1 -1
  11. data/docs/HybridTransaction.md +3 -0
  12. data/docs/MonthsApi.md +0 -76
  13. data/docs/PayeeLocationsApi.md +0 -115
  14. data/docs/PayeesApi.md +0 -76
  15. data/docs/ScheduledTransactionsApi.md +0 -76
  16. data/docs/TransactionsApi.md +0 -325
  17. data/docs/UserApi.md +0 -34
  18. data/lib/ynab/api/accounts_api.rb +8 -10
  19. data/lib/ynab/api/budgets_api.rb +8 -10
  20. data/lib/ynab/api/categories_api.rb +8 -10
  21. data/lib/ynab/api/months_api.rb +8 -10
  22. data/lib/ynab/api/payee_locations_api.rb +11 -14
  23. data/lib/ynab/api/payees_api.rb +8 -10
  24. data/lib/ynab/api/scheduled_transactions_api.rb +8 -10
  25. data/lib/ynab/api/transactions_api.rb +26 -34
  26. data/lib/ynab/api/user_api.rb +5 -6
  27. data/lib/ynab/api_client.rb +1 -1
  28. data/lib/ynab/api_error.rb +1 -1
  29. data/lib/ynab/configuration.rb +2 -2
  30. data/lib/ynab/models/account.rb +18 -22
  31. data/lib/ynab/models/account_response.rb +7 -12
  32. data/lib/ynab/models/account_wrapper.rb +7 -12
  33. data/lib/ynab/models/accounts_response.rb +7 -12
  34. data/lib/ynab/models/accounts_wrapper.rb +7 -12
  35. data/lib/ynab/models/budget_detail.rb +8 -13
  36. data/lib/ynab/models/budget_detail_response.rb +7 -12
  37. data/lib/ynab/models/budget_detail_wrapper.rb +8 -13
  38. data/lib/ynab/models/budget_summary.rb +8 -13
  39. data/lib/ynab/models/budget_summary_response.rb +7 -12
  40. data/lib/ynab/models/budget_summary_wrapper.rb +7 -12
  41. data/lib/ynab/models/bulk_id_wrapper.rb +7 -12
  42. data/lib/ynab/models/bulk_ids.rb +8 -13
  43. data/lib/ynab/models/bulk_response.rb +7 -12
  44. data/lib/ynab/models/bulk_transactions.rb +7 -12
  45. data/lib/ynab/models/categories_response.rb +7 -12
  46. data/lib/ynab/models/category.rb +14 -19
  47. data/lib/ynab/models/category_group.rb +9 -14
  48. data/lib/ynab/models/category_group_with_categories.rb +10 -15
  49. data/lib/ynab/models/category_groups_wrapper.rb +7 -12
  50. data/lib/ynab/models/category_response.rb +7 -12
  51. data/lib/ynab/models/category_wrapper.rb +7 -12
  52. data/lib/ynab/models/currency_format.rb +112 -19
  53. data/lib/ynab/models/date_format.rb +16 -21
  54. data/lib/ynab/models/error_detail.rb +9 -14
  55. data/lib/ynab/models/error_response.rb +7 -12
  56. data/lib/ynab/models/hybrid_transaction.rb +74 -36
  57. data/lib/ynab/models/hybrid_transactions_response.rb +7 -12
  58. data/lib/ynab/models/hybrid_transactions_wrapper.rb +7 -12
  59. data/lib/ynab/models/month_detail.rb +11 -16
  60. data/lib/ynab/models/month_detail_response.rb +7 -12
  61. data/lib/ynab/models/month_detail_wrapper.rb +7 -12
  62. data/lib/ynab/models/month_summaries_response.rb +7 -12
  63. data/lib/ynab/models/month_summaries_wrapper.rb +7 -12
  64. data/lib/ynab/models/month_summary.rb +10 -15
  65. data/lib/ynab/models/payee.rb +9 -14
  66. data/lib/ynab/models/payee_location.rb +10 -15
  67. data/lib/ynab/models/payee_location_response.rb +7 -12
  68. data/lib/ynab/models/payee_location_wrapper.rb +7 -12
  69. data/lib/ynab/models/payee_locations_response.rb +7 -12
  70. data/lib/ynab/models/payee_locations_wrapper.rb +7 -12
  71. data/lib/ynab/models/payee_response.rb +7 -12
  72. data/lib/ynab/models/payee_wrapper.rb +7 -12
  73. data/lib/ynab/models/payees_response.rb +7 -12
  74. data/lib/ynab/models/payees_wrapper.rb +7 -12
  75. data/lib/ynab/models/save_transaction.rb +15 -19
  76. data/lib/ynab/models/save_transaction_wrapper.rb +7 -12
  77. data/lib/ynab/models/scheduled_sub_transaction.rb +13 -18
  78. data/lib/ynab/models/scheduled_transaction_detail.rb +27 -31
  79. data/lib/ynab/models/scheduled_transaction_response.rb +7 -12
  80. data/lib/ynab/models/scheduled_transaction_summary.rb +23 -27
  81. data/lib/ynab/models/scheduled_transaction_wrapper.rb +7 -12
  82. data/lib/ynab/models/scheduled_transactions_response.rb +7 -12
  83. data/lib/ynab/models/scheduled_transactions_wrapper.rb +7 -12
  84. data/lib/ynab/models/sub_transaction.rb +13 -18
  85. data/lib/ynab/models/transaction_detail.rb +28 -32
  86. data/lib/ynab/models/transaction_response.rb +7 -12
  87. data/lib/ynab/models/transaction_summary.rb +24 -28
  88. data/lib/ynab/models/transaction_wrapper.rb +7 -12
  89. data/lib/ynab/models/transactions_response.rb +7 -12
  90. data/lib/ynab/models/transactions_wrapper.rb +7 -12
  91. data/lib/ynab/models/user.rb +7 -12
  92. data/lib/ynab/models/user_response.rb +7 -12
  93. data/lib/ynab/models/user_wrapper.rb +7 -12
  94. data/lib/ynab/version.rb +2 -2
  95. data/spec-v1-swagger.json +50 -5
  96. data/swagger-templates/api_doc.mustache +32 -0
  97. data/ynab.gemspec +1 -1
  98. metadata +4 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f7d7da4f24baccaa3813fd7579e074138cf03410
4
- data.tar.gz: d60194b11d71357bd19ad03786cc162064e43dbe
3
+ metadata.gz: 311e29f4028a2e5f62f1063d1f4ab93f80b7a84c
4
+ data.tar.gz: bf1f7c152d6fd1b47f6d5579d3db4d4382c427d9
5
5
  SHA512:
6
- metadata.gz: c59b23d133e8b97acb3dc0b7eb6f7c2e3c64cb6dc0970d3020f590273766142a3ef3999b48e4c36cdaa3c0243000425f678f26e9194cfa11db86ddac3caccd17
7
- data.tar.gz: 9df41334d96ca6bfadc98dd1277b86396a52ff847f048dda358a105205a660c4c19ff203bf2b1dfc8dca5571bdd066e4063fb3dad8894e1c2179e07fde6f9e4e
6
+ metadata.gz: ef7959d67c285d6f7afceed65bc2b44e3dcb8fa8fd730033142a8b1f08447579bc9b415779a43adff38b34f772b1a37b1f10f8c4d70373e3a6c9afb60473528c
7
+ data.tar.gz: b7454f90ce3c7a7e5b81f9403983d7bf81a8d42c8a26f311502734f849c83a1fdf17ca71634cd0f45dc8017437cf497a0826d418e7233bde8a6036912cf56414
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- ynab (0.6.0)
4
+ ynab (0.7.0)
5
5
  json (~> 2.1, >= 2.1.0)
6
6
  typhoeus (~> 1.0, >= 1.0.1)
7
7
 
data/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  # YNAB API Ruby Library
2
2
 
3
3
  [![Build Status](https://travis-ci.org/ynab/ynab-sdk-ruby.svg?branch=master)](https://travis-ci.org/ynab/ynab-sdk-ruby)
4
- [![RubyGem](https://img.shields.io/gem/v/ynab.svg)](https://rubygems.org/gems/ynab)
4
+ [![Gem Version](https://badge.fury.io/rb/ynab.svg)](https://rubygems.org/gems/ynab)
5
5
 
6
6
  **NOTE: The YNAB API is currently only available to Early Access users. If you are interested in requesting access before the API is generally available, please fill out [this form](https://docs.google.com/forms/d/17plY-CE39Xl3pe2GqyVH1Unre8TjYKs-tkI6jVC4ko4/edit).**
7
7
 
@@ -50,29 +50,29 @@ The following methods are available in this library.
50
50
 
51
51
  | | Method | Description |
52
52
  |------------------------|-------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
53
- | **User** | `budgets.get_user()` | Returns authenticated user information
54
- | **Budgets** | `budgets.get_budgets()` | Returns budgets list with summary information |
55
- | | `budgets.get_budget_by_id(id)` | Returns a single budget with all related entities |
56
- | **Accounts** | `accounts.get_accounts(budget_id)` | Returns all accounts |
57
- | | `accounts.get_account_by_id(budget_id, id)` | Returns a single account |
58
- | **Categories** | `categories.get_categories(budget_id)` | Returns all categories grouped by category group. |
59
- | | `categories.get_category_by_id(budget_id, id)` | Returns a single category |
60
- | **Payees** | `payees.get_payees(budget_id)` | Returns all payees |
61
- | | `payees.get_payee_by_id(budget_id, id)` | Returns single payee |
62
- | **Payee Locations** | `payee_locations.get_payee_locations(budget_id)` | Returns all payee locations |
63
- | | `payee_locations.get_payee_location_by_id(budget_id, id)` | Returns a single payee location |
64
- | | `payee_locations.get_payee_locations_by_payee(budget_id, id)` | Returns all payee locations for the specified payee |
65
- | **Months** | `months.get_budget_months(budget_id)` | Returns all budget months |
66
- | | `months.get_budget_month(budget_id, month)` | Returns a single budget month |
67
- | **Transactions** | `transactions.get_transactions(budget_id)` | Returns budget transactions |
68
- | | `transactions.get_transactions_by_account(budget_id, id)` | Returns all transactions for a specified account |
69
- | | `transactions.get_transactions_by_category(budget_id, id)` | Returns all transactions for a specified category |
70
- | | `transactions.get_transactions_by_id(budget_id, id)` | Returns a single transaction |
71
- | | `transactions.update_transaction(budget_id, id, transaction)` | Updates a transaction |
72
- | | `transactions.create_transaction(budget_id, transaction)` | Creates a new transaction |
73
- | | `transactions.bulk_create_transactions(budget_id, transactions)` | Creates multiple transactions |
74
- | **Scheduled Transactions** | `scheduled_transactions.get_scheduled_transactions(budget_id)` | Returns all scheduled transactions |
75
- | | `scheduled_transactions.get_scheduled_transaction_by_id(budget_id, id)` | Returns a single scheduled transaction |
53
+ | **User** | [budgets.get_user()](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/UserApi.md#get_user) | Returns authenticated user information
54
+ | **Budgets** | [budgets.get_budgets()](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/BudgetsApi.md#get_budgets) | Returns budgets list with summary information |
55
+ | | [budgets.get_budget_by_id(id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/BudgetsApi.md#get_budget_by_id) | Returns a single budget with all related entities |
56
+ | **Accounts** | [accounts.get_accounts(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/AccountsApi.md#get_accounts) | Returns all accounts |
57
+ | | [accounts.get_account_by_id(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/AccountsApi.md#get_account_by_id) | Returns a single account |
58
+ | **Categories** | [categories.get_categories(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/CategoriesApi.md#get_categories) | Returns all categories grouped by category group. |
59
+ | | [categories.get_category_by_id(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/CategoriesApi.md#get_category_by_id) | Returns a single category |
60
+ | **Payees** | [payees.get_payees(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeesApi.md#get_payees) | Returns all payees |
61
+ | | [payees.get_payee_by_id(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeesApi.md#get_payee_by_id) | Returns single payee |
62
+ | **Payee Locations** | [payee_locations.get_payee_locations(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeeLocationsApi.md#get_payee_locations) | Returns all payee locations |
63
+ | | [payee_locations.get_payee_location_by_id(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeeLocationsApi.md#get_payee_location_by_id) | Returns a single payee location |
64
+ | | [payee_locations.get_payee_locations_by_payee(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/PayeeLocationsApi.md#get_payee_locations_by_payee) | Returns all payee locations for the specified payee |
65
+ | **Months** | [months.get_budget_months(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/MonthsApi.md#get_budget_months) | Returns all budget months |
66
+ | | [months.get_budget_month(budget_id, month)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/MonthsApi.md#get_budget_month) | Returns a single budget month |
67
+ | **Transactions** | [transactions.get_transactions(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transactions) | Returns budget transactions |
68
+ | | [transactions.get_transactions_by_account(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transactions_by_account) | Returns all transactions for a specified account |
69
+ | | [transactions.get_transactions_by_category(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transactions_by_category) | Returns all transactions for a specified category |
70
+ | | [transactions.get_transactions_by_id(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#get_transactions_by_id) | Returns a single transaction |
71
+ | | [transactions.update_transaction(budget_id, id, transaction)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#update_transaction) | Updates a transaction |
72
+ | | [transactions.create_transaction(budget_id, transaction)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#create_transaction) | Creates a new transaction |
73
+ | | [transactions.bulk_create_transactions(budget_id, transactions)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/TransactionsApi.md#bulk_create_transactions) | Creates multiple transactions |
74
+ | **Scheduled Transactions** | [scheduled_transactions.get_scheduled_transactions(budget_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#get_scheduled_transactions) | Returns all scheduled transactions |
75
+ | | [scheduled_transactions.get_scheduled_transaction_by_id(budget_id, id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | Returns a single scheduled transaction |
76
76
 
77
77
  ## Development
78
78
 
data/Rakefile CHANGED
@@ -14,7 +14,7 @@ desc "Run Swagger Code Generator to update the client from the Swagger spec"
14
14
  task :generate do
15
15
  # Download latest swagger spec
16
16
  spec_filename = 'spec-v1-swagger.json'
17
- sh "rm #{spec_filename} && wget https://api.youneedabudget.com/papi/#{spec_filename}"
17
+ #sh "rm #{spec_filename} && wget https://api.youneedabudget.com/papi/#{spec_filename}"
18
18
 
19
19
  # Replace nullable types defined as i.e. ["string", "null"] in the spec to simply "string" as the generator does not understand the nullable format.
20
20
  # Examples:
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "gemName": "ynab",
3
3
  "moduleName": "YnabApi",
4
- "gemVersion": "0.6.0",
4
+ "gemVersion": "0.7.0",
5
5
  "gemDescription": "Ruby gem wrapper for the YNAB API. Read the documentation at https://api.youneedabudget.com",
6
6
  "gemHomepage": "https://github.com/ynab/ynab-sdk-ruby",
7
7
  "gemLicense": "Apache-2.0",
@@ -15,34 +15,6 @@ Single account
15
15
 
16
16
  Returns a single account
17
17
 
18
- ### Example
19
- ```ruby
20
- # load the gem
21
- require 'ynab'
22
- # setup authorization
23
- YnabApi.configure do |config|
24
- # Configure API key authorization: bearer
25
- config.api_key['Authorization'] = 'YOUR API KEY'
26
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
27
- #config.api_key_prefix['Authorization'] = 'Bearer'
28
- end
29
-
30
- api_instance = YnabApi::AccountsApi.new
31
-
32
- budget_id = "budget_id_example" # String | The ID of the Budget.
33
-
34
- account_id = "account_id_example" # String | The ID of the Account.
35
-
36
-
37
- begin
38
- #Single account
39
- result = api_instance.get_account_by_id(budget_id, account_id)
40
- p result
41
- rescue YnabApi::ApiError => e
42
- puts "Exception when calling AccountsApi->get_account_by_id: #{e}"
43
- end
44
- ```
45
-
46
18
  ### Parameters
47
19
 
48
20
  Name | Type | Description | Notes
@@ -54,17 +26,6 @@ Name | Type | Description | Notes
54
26
 
55
27
  [**AccountResponse**](AccountResponse.md)
56
28
 
57
- ### Authorization
58
-
59
- [bearer](../README.md#bearer)
60
-
61
- ### HTTP request headers
62
-
63
- - **Content-Type**: Not defined
64
- - **Accept**: application/json
65
-
66
-
67
-
68
29
  # **get_accounts**
69
30
  > AccountsResponse get_accounts(budget_id)
70
31
 
@@ -72,32 +33,6 @@ Account list
72
33
 
73
34
  Returns all accounts
74
35
 
75
- ### Example
76
- ```ruby
77
- # load the gem
78
- require 'ynab'
79
- # setup authorization
80
- YnabApi.configure do |config|
81
- # Configure API key authorization: bearer
82
- config.api_key['Authorization'] = 'YOUR API KEY'
83
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
84
- #config.api_key_prefix['Authorization'] = 'Bearer'
85
- end
86
-
87
- api_instance = YnabApi::AccountsApi.new
88
-
89
- budget_id = "budget_id_example" # String | The ID of the Budget.
90
-
91
-
92
- begin
93
- #Account list
94
- result = api_instance.get_accounts(budget_id)
95
- p result
96
- rescue YnabApi::ApiError => e
97
- puts "Exception when calling AccountsApi->get_accounts: #{e}"
98
- end
99
- ```
100
-
101
36
  ### Parameters
102
37
 
103
38
  Name | Type | Description | Notes
@@ -108,14 +43,3 @@ Name | Type | Description | Notes
108
43
 
109
44
  [**AccountsResponse**](AccountsResponse.md)
110
45
 
111
- ### Authorization
112
-
113
- [bearer](../README.md#bearer)
114
-
115
- ### HTTP request headers
116
-
117
- - **Content-Type**: Not defined
118
- - **Accept**: application/json
119
-
120
-
121
-
@@ -15,35 +15,6 @@ Single budget
15
15
 
16
16
  Returns a single budget with all related entities. This resource is effectively a full budget export.
17
17
 
18
- ### Example
19
- ```ruby
20
- # load the gem
21
- require 'ynab'
22
- # setup authorization
23
- YnabApi.configure do |config|
24
- # Configure API key authorization: bearer
25
- config.api_key['Authorization'] = 'YOUR API KEY'
26
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
27
- #config.api_key_prefix['Authorization'] = 'Bearer'
28
- end
29
-
30
- api_instance = YnabApi::BudgetsApi.new
31
-
32
- budget_id = "budget_id_example" # String | The ID of the Budget.
33
-
34
- opts = {
35
- last_knowledge_of_server: 8.14 # Float | The starting server knowledge. If provided, only entities that have changed since last_knowledge_of_server will be included.
36
- }
37
-
38
- begin
39
- #Single budget
40
- result = api_instance.get_budget_by_id(budget_id, opts)
41
- p result
42
- rescue YnabApi::ApiError => e
43
- puts "Exception when calling BudgetsApi->get_budget_by_id: #{e}"
44
- end
45
- ```
46
-
47
18
  ### Parameters
48
19
 
49
20
  Name | Type | Description | Notes
@@ -55,17 +26,6 @@ Name | Type | Description | Notes
55
26
 
56
27
  [**BudgetDetailResponse**](BudgetDetailResponse.md)
57
28
 
58
- ### Authorization
59
-
60
- [bearer](../README.md#bearer)
61
-
62
- ### HTTP request headers
63
-
64
- - **Content-Type**: Not defined
65
- - **Accept**: application/json
66
-
67
-
68
-
69
29
  # **get_budgets**
70
30
  > BudgetSummaryResponse get_budgets
71
31
 
@@ -73,29 +33,6 @@ List budgets
73
33
 
74
34
  Returns budgets list with summary information.
75
35
 
76
- ### Example
77
- ```ruby
78
- # load the gem
79
- require 'ynab'
80
- # setup authorization
81
- YnabApi.configure do |config|
82
- # Configure API key authorization: bearer
83
- config.api_key['Authorization'] = 'YOUR API KEY'
84
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
85
- #config.api_key_prefix['Authorization'] = 'Bearer'
86
- end
87
-
88
- api_instance = YnabApi::BudgetsApi.new
89
-
90
- begin
91
- #List budgets
92
- result = api_instance.get_budgets
93
- p result
94
- rescue YnabApi::ApiError => e
95
- puts "Exception when calling BudgetsApi->get_budgets: #{e}"
96
- end
97
- ```
98
-
99
36
  ### Parameters
100
37
  This endpoint does not need any parameter.
101
38
 
@@ -103,14 +40,3 @@ This endpoint does not need any parameter.
103
40
 
104
41
  [**BudgetSummaryResponse**](BudgetSummaryResponse.md)
105
42
 
106
- ### Authorization
107
-
108
- [bearer](../README.md#bearer)
109
-
110
- ### HTTP request headers
111
-
112
- - **Content-Type**: Not defined
113
- - **Accept**: application/json
114
-
115
-
116
-
@@ -15,32 +15,6 @@ List categories
15
15
 
16
16
  Returns all categories grouped by category group.
17
17
 
18
- ### Example
19
- ```ruby
20
- # load the gem
21
- require 'ynab'
22
- # setup authorization
23
- YnabApi.configure do |config|
24
- # Configure API key authorization: bearer
25
- config.api_key['Authorization'] = 'YOUR API KEY'
26
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
27
- #config.api_key_prefix['Authorization'] = 'Bearer'
28
- end
29
-
30
- api_instance = YnabApi::CategoriesApi.new
31
-
32
- budget_id = "budget_id_example" # String | The ID of the Budget.
33
-
34
-
35
- begin
36
- #List categories
37
- result = api_instance.get_categories(budget_id)
38
- p result
39
- rescue YnabApi::ApiError => e
40
- puts "Exception when calling CategoriesApi->get_categories: #{e}"
41
- end
42
- ```
43
-
44
18
  ### Parameters
45
19
 
46
20
  Name | Type | Description | Notes
@@ -51,17 +25,6 @@ Name | Type | Description | Notes
51
25
 
52
26
  [**CategoriesResponse**](CategoriesResponse.md)
53
27
 
54
- ### Authorization
55
-
56
- [bearer](../README.md#bearer)
57
-
58
- ### HTTP request headers
59
-
60
- - **Content-Type**: Not defined
61
- - **Accept**: application/json
62
-
63
-
64
-
65
28
  # **get_category_by_id**
66
29
  > CategoryResponse get_category_by_id(budget_id, category_id)
67
30
 
@@ -69,34 +32,6 @@ Single category
69
32
 
70
33
  Returns a single category
71
34
 
72
- ### Example
73
- ```ruby
74
- # load the gem
75
- require 'ynab'
76
- # setup authorization
77
- YnabApi.configure do |config|
78
- # Configure API key authorization: bearer
79
- config.api_key['Authorization'] = 'YOUR API KEY'
80
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
81
- #config.api_key_prefix['Authorization'] = 'Bearer'
82
- end
83
-
84
- api_instance = YnabApi::CategoriesApi.new
85
-
86
- budget_id = "budget_id_example" # String | The ID of the Budget.
87
-
88
- category_id = "category_id_example" # String | The ID of the Category.
89
-
90
-
91
- begin
92
- #Single category
93
- result = api_instance.get_category_by_id(budget_id, category_id)
94
- p result
95
- rescue YnabApi::ApiError => e
96
- puts "Exception when calling CategoriesApi->get_category_by_id: #{e}"
97
- end
98
- ```
99
-
100
35
  ### Parameters
101
36
 
102
37
  Name | Type | Description | Notes
@@ -108,14 +43,3 @@ Name | Type | Description | Notes
108
43
 
109
44
  [**CategoryResponse**](CategoryResponse.md)
110
45
 
111
- ### Authorization
112
-
113
- [bearer](../README.md#bearer)
114
-
115
- ### HTTP request headers
116
-
117
- - **Content-Type**: Not defined
118
- - **Accept**: application/json
119
-
120
-
121
-
@@ -3,6 +3,13 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **locale** | **String** | |
6
+ **iso_code** | **String** | |
7
+ **example_format** | **String** | |
8
+ **decimal_digits** | **String** | |
9
+ **decimal_separator** | **String** | |
10
+ **symbol_first** | **BOOLEAN** | |
11
+ **group_separator** | **String** | |
12
+ **currency_symbol** | **String** | |
13
+ **display_symbol** | **BOOLEAN** | |
7
14
 
8
15
 
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **locale** | **String** | |
6
+ **format** | **String** | |
7
7
 
8
8
 
@@ -17,5 +17,8 @@ Name | Type | Description | Notes
17
17
  **import_id** | **String** | If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'. |
18
18
  **type** | **String** | Whether the hybrid transaction represents a regular transaction or a subtransaction |
19
19
  **parent_transaction_id** | **String** | For subtransaction types, this is the id of the pararent transaction. For transaction types, this id will be always be null. |
20
+ **account_name** | **String** | |
21
+ **payee_name** | **String** | |
22
+ **category_name** | **String** | |
20
23
 
21
24
 
@@ -15,34 +15,6 @@ Single budget month
15
15
 
16
16
  Returns a single budget month
17
17
 
18
- ### Example
19
- ```ruby
20
- # load the gem
21
- require 'ynab'
22
- # setup authorization
23
- YnabApi.configure do |config|
24
- # Configure API key authorization: bearer
25
- config.api_key['Authorization'] = 'YOUR API KEY'
26
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
27
- #config.api_key_prefix['Authorization'] = 'Bearer'
28
- end
29
-
30
- api_instance = YnabApi::MonthsApi.new
31
-
32
- budget_id = "budget_id_example" # String | The ID of the Budget.
33
-
34
- month = Date.parse("2013-10-20") # Date | The Budget Month. \"current\" can also be used to specify the current calendar month (UTC).
35
-
36
-
37
- begin
38
- #Single budget month
39
- result = api_instance.get_budget_month(budget_id, month)
40
- p result
41
- rescue YnabApi::ApiError => e
42
- puts "Exception when calling MonthsApi->get_budget_month: #{e}"
43
- end
44
- ```
45
-
46
18
  ### Parameters
47
19
 
48
20
  Name | Type | Description | Notes
@@ -54,17 +26,6 @@ Name | Type | Description | Notes
54
26
 
55
27
  [**MonthDetailResponse**](MonthDetailResponse.md)
56
28
 
57
- ### Authorization
58
-
59
- [bearer](../README.md#bearer)
60
-
61
- ### HTTP request headers
62
-
63
- - **Content-Type**: Not defined
64
- - **Accept**: application/json
65
-
66
-
67
-
68
29
  # **get_budget_months**
69
30
  > MonthSummariesResponse get_budget_months(budget_id)
70
31
 
@@ -72,32 +33,6 @@ List budget months
72
33
 
73
34
  Returns all budget months
74
35
 
75
- ### Example
76
- ```ruby
77
- # load the gem
78
- require 'ynab'
79
- # setup authorization
80
- YnabApi.configure do |config|
81
- # Configure API key authorization: bearer
82
- config.api_key['Authorization'] = 'YOUR API KEY'
83
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
84
- #config.api_key_prefix['Authorization'] = 'Bearer'
85
- end
86
-
87
- api_instance = YnabApi::MonthsApi.new
88
-
89
- budget_id = "budget_id_example" # String | The ID of the Budget.
90
-
91
-
92
- begin
93
- #List budget months
94
- result = api_instance.get_budget_months(budget_id)
95
- p result
96
- rescue YnabApi::ApiError => e
97
- puts "Exception when calling MonthsApi->get_budget_months: #{e}"
98
- end
99
- ```
100
-
101
36
  ### Parameters
102
37
 
103
38
  Name | Type | Description | Notes
@@ -108,14 +43,3 @@ Name | Type | Description | Notes
108
43
 
109
44
  [**MonthSummariesResponse**](MonthSummariesResponse.md)
110
45
 
111
- ### Authorization
112
-
113
- [bearer](../README.md#bearer)
114
-
115
- ### HTTP request headers
116
-
117
- - **Content-Type**: Not defined
118
- - **Accept**: application/json
119
-
120
-
121
-