ynab 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69ec9bd6f5c67e0bbb248e2334e3754e345a604e
-  data.tar.gz: 76aa486bdad86177ec11d9043d0195d288cbdeb1
+  metadata.gz: 9bd84a797b63ba035bd3404cf239c4c81b241ac7
+  data.tar.gz: 9136bb84708e63f404ead2e3932535df971cee12
 SHA512:
-  metadata.gz: 68679167f76ff3eefc8f80e3330ad4df2559a48576b8d1933c84eb81c777ae623138e007e4094e6fb2db3f7d7a0a8a82e3b045318365c3f443d1e3e751eee225
-  data.tar.gz: eb0a9f8d73d96658f15f2d01f19da3edfd064ad800f06456eaecaf485235f1fe1b4e5d4fd4441d1f278c32331a32c955107b4a03f959e70858005313a477d279
+  metadata.gz: 9c5c7f98ef3cc5eed77c746c4bfc296ade067cf4f83014d4403b191bb62bc00a653c2fc4162ae63d81c0f3ad8cef273b932e6fe8f1592c737fea4689bd41c958
+  data.tar.gz: 981d0804f35ec9049d0c0a883a5907fc1e254a0bba80339f664773437fc3b63f62e7dc29555f0de86c00d4706435b9616452a705cb31c3a2193ee918b97ca22a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ynab (0.2.0)
+    ynab (0.4.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -11,7 +11,7 @@ GEM
     diff-lcs (1.3)
     ethon (0.11.0)
       ffi (>= 1.3.0)
-    ffi (1.9.21)
+    ffi (1.9.23)
     json (2.1.0)
     rake (12.0.0)
     rspec (3.7.0)

data/README.md

@@ -1,7 +1,7 @@
 # YNAB API Ruby Library
 
 [![Build Status](https://travis-ci.org/ynab/ynab-sdk-ruby.svg?branch=master)](https://travis-ci.org/ynab/ynab-sdk-ruby)
-[![NPM Package](https://img.shields.io/gem/v/ynab.svg)](https://rubygems.org/gems/ynab)
+[![RubyGem](https://img.shields.io/gem/v/ynab.svg)](https://rubygems.org/gems/ynab)
 
 **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).**
 
@@ -21,7 +21,7 @@ gem install ynab
 ## Usage
 
 To use this client you must
-[obtain an access token](https://api.youneedabudget.com/#authentication) from
+[obtain an access token](https://api.youneedabudget.com/#authentication-overview) from
 your [My Account](https://app.youneedabudget.com/settings) page of the YNAB web
 app.
 
@@ -42,14 +42,44 @@ end
 
 ## Examples
 
-See the [examples folder](https://github.com/ynab/ynab-sdk-ruby/tree/master/examples) for, well, example usage scenarios.
+See the [examples folder](https://github.com/ynab/ynab-sdk-ruby/tree/master/examples) for example usage scenarios.
+
+## Methods
+
+The following methods are available in this library.
+
+|                       | Method                                                | Description                                                                                            |
+|------------------------|-------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
+| **User**                | `budgets.get_user()`                                  | Returns authenticated user information
+| **Budgets**                | `budgets.get_budgets()`                                  | Returns budgets list with summary information                                                          |
+|                        | `budgets.get_budget_by_id(id)`                             | Returns a single budget with all related entities |
+| **Accounts**               | `accounts.get_accounts(budget_id)`                                | Returns all accounts                                                                                   |
+|                        | `accounts.get_account_by_id(budget_id, id)`                           | Returns a single account                                                                               |
+| **Categories**             | `categories.get_categories(budget_id)`                            | Returns all categories grouped by category group.                                                      |
+|                        | `categories.get_category_by_id(budget_id, id)`                        | Returns a single category                                                                              |
+| **Payees**                 | `payees.get_payees(budget_id)`                                    | Returns all payees                                                                                     |
+|                        | `payees.get_payee_by_id(budget_id, id)`                               | Returns single payee                                                                                   |
+| **Payee Locations**        | `payee_locations.get_payee_locations(budget_id)`                    | Returns all payee locations                                                                            |
+|                        | `payee_locations.get_payee_location_by_id(budget_id, id)`               | Returns a single payee location                                                                        |
+|                        | `payee_locations.get_payee_locations_by_payee(budget_id, id)`           | Returns all payee locations for the specified payee                                                    |
+| **Months**                 | `months.get_budget_months(budget_id)`                              | Returns all budget months                                                                              |
+|                        | `months.get_budget_month(budget_id, month)`                             | Returns a single budget month                                                                          |
+| **Transactions**           | `transactions.get_transactions(budget_id)`                        | Returns budget transactions                                                                            |
+|                        | `transactions.get_transactions_by_account(budget_id, id)`               | Returns all transactions for a specified account                                                       |
+|                        | `transactions.get_transactions_by_category(budget_id, id)`              | Returns all transactions for a specified category                                                      |
+|                        | `transactions.get_transactions_by_id(budget_id, id)`                  | Returns a single transaction                                                                           |
+|                        | `transactions.update_transaction(budget_id, id, transaction)`                      | Updates a transaction                                                                                   |
+|                        | `transactions.create_transaction(budget_id, transaction)`                      | Creates a new transaction                                                                              |
+|                        | `transactions.bulk_create_transactions(budget_id, transactions)`                 | Creates multiple transactions                                                                          |
+| **Scheduled Transactions** | `scheduled_transactions.get_scheduled_transactions(budget_id)`      | Returns all scheduled transactions                                                                     |
+|                        | `scheduled_transactions.get_scheduled_transaction_by_id(budget_id, id)` | Returns a single scheduled transaction                                                                 |
 
 ## Development
 
 - Install dependencies: `bundle`
 - Generate latest client based on swagger spec: `rake generate`
 - Run tests: `rake spec` or `rspec`
-- Publish: Update `gemVersion` in config.json and then `rake generate && rspec && gem build ynab && gem push ynab`
+- Publish: Update `gemVersion` in config.json and then `rake generate && rspec && gem build ynab && gem push ynab-0.0.0.gem`
 
 ## License
 

data/config.json

@@ -1,7 +1,7 @@
 {
   "gemName": "ynab",
   "moduleName": "YnabApi",
-  "gemVersion": "0.3.0",
+  "gemVersion": "0.4.0",
   "gemDescription": "Ruby gem wrapper for the YNAB API. Read the documentation at https://api.youneedabudget.com",
   "gemHomepage": "https://github.com/ynab/ynab-sdk-ruby",
   "gemLicense": "Apache-2.0",

data/docs/ScheduledTransactionDetail.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **frequency** | **String** |  | 
 **amount** | **Float** | The scheduled transaction amount in milliunits format | 
 **memo** | **String** |  | 
-**flag_color** | **String** |  | 
+**flag_color** | **String** | The scheduled transaction flag | 
 **account_id** | **String** |  | 
 **payee_id** | **String** |  | 
 **category_id** | **String** |  | 

data/docs/ScheduledTransactionSummary.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **frequency** | **String** |  | 
 **amount** | **Float** | The scheduled transaction amount in milliunits format | 
 **memo** | **String** |  | 
-**flag_color** | **String** |  | 
+**flag_color** | **String** | The scheduled transaction flag | 
 **account_id** | **String** |  | 
 **payee_id** | **String** |  | 
 **category_id** | **String** |  | 

data/docs/TransactionDetail.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **memo** | **String** |  | 
 **cleared** | **String** | The cleared status of the transaction | 
 **approved** | **BOOLEAN** | Whether or not the transaction is approved | 
-**flag_color** | **String** |  | 
+**flag_color** | **String** | The transaction flag | 
 **account_id** | **String** |  | 
 **payee_id** | **String** |  | 
 **category_id** | **String** |  | 

data/docs/TransactionSummary.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **memo** | **String** |  | 
 **cleared** | **String** | The cleared status of the transaction | 
 **approved** | **BOOLEAN** | Whether or not the transaction is approved | 
-**flag_color** | **String** |  | 
+**flag_color** | **String** | The transaction flag | 
 **account_id** | **String** |  | 
 **payee_id** | **String** |  | 
 **category_id** | **String** |  | 

data/docs/TransactionsApi.md

@@ -10,6 +10,7 @@ Method | HTTP request | Description
 [**get_transactions_by_account**](TransactionsApi.md#get_transactions_by_account) | **GET** /budgets/{budget_id}/accounts/{account_id}/transactions | List account transactions
 [**get_transactions_by_category**](TransactionsApi.md#get_transactions_by_category) | **GET** /budgets/{budget_id}/categories/{category_id}/transactions | List category transactions
 [**get_transactions_by_id**](TransactionsApi.md#get_transactions_by_id) | **GET** /budgets/{budget_id}/transactions/{transaction_id} | Single transaction
+[**get_transactions_by_payee**](TransactionsApi.md#get_transactions_by_payee) | **GET** /budgets/{budget_id}/payees/{payee_id}/transactions | List payee transactions
 [**update_transaction**](TransactionsApi.md#update_transaction) | **PUT** /budgets/{budget_id}/transactions/{transaction_id} | Updates an existing transaction
 
 
@@ -366,6 +367,67 @@ Name | Type | Description  | Notes
 
 
 
+# **get_transactions_by_payee**
+> TransactionsResponse get_transactions_by_payee(budget_id, payee_id, opts)
+
+List payee transactions
+
+Returns all transactions for a specified payee
+
+### Example
+```ruby
+# load the gem
+require 'ynab'
+# setup authorization
+YnabApi.configure do |config|
+  # Configure API key authorization: bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = YnabApi::TransactionsApi.new
+
+budget_id = "budget_id_example" # String | The ID of the Budget.
+
+payee_id = "payee_id_example" # String | The ID of the Payee.
+
+opts = { 
+  since_date: Date.parse("2013-10-20") # Date | Only return transactions on or after this date.
+}
+
+begin
+  #List payee transactions
+  result = api_instance.get_transactions_by_payee(budget_id, payee_id, opts)
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling TransactionsApi->get_transactions_by_payee: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **budget_id** | [**String**](.md)| The ID of the Budget. | 
+ **payee_id** | [**String**](.md)| The ID of the Payee. | 
+ **since_date** | **Date**| Only return transactions on or after this date. | [optional] 
+
+### Return type
+
+[**TransactionsResponse**](TransactionsResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
 # **update_transaction**
 > TransactionResponse update_transaction(budget_id, transaction_id, transaction)
 

data/docs/User.md

@@ -0,0 +1,8 @@
+# YnabApi::User
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+
+

data/docs/UserApi.md

@@ -0,0 +1,57 @@
+# YnabApi::UserApi
+
+All URIs are relative to *https://api.youneedabudget.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_user**](UserApi.md#get_user) | **GET** /user | User info
+
+
+# **get_user**
+> UserResponse get_user
+
+User info
+
+Returns authenticated user information.
+
+### Example
+```ruby
+# load the gem
+require 'ynab'
+# setup authorization
+YnabApi.configure do |config|
+  # Configure API key authorization: bearer
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = YnabApi::UserApi.new
+
+begin
+  #User info
+  result = api_instance.get_user
+  p result
+rescue YnabApi::ApiError => e
+  puts "Exception when calling UserApi->get_user: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**UserResponse**](UserResponse.md)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/UserResponse.md

@@ -0,0 +1,8 @@
+# YnabApi::UserResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**UserWrapper**](UserWrapper.md) |  | 
+
+

data/docs/UserWrapper.md

@@ -0,0 +1,8 @@
+# YnabApi::UserWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | [**User**](User.md) |  | 
+
+

data/lib/ynab.rb

@@ -17,6 +17,7 @@ require 'ynab/version'
 require 'ynab/configuration'
 
 # Models
+require 'ynab/models/user'
 require 'ynab/models/account'
 require 'ynab/models/account_response'
 require 'ynab/models/account_wrapper'
@@ -75,6 +76,7 @@ require 'ynab/models/bulk_ids'
 require 'ynab/models/bulk_response'
 
 # APIs
+require 'ynab/api/user_api'
 require 'ynab/api/accounts_api'
 require 'ynab/api/budgets_api'
 require 'ynab/api/categories_api'
@@ -97,6 +99,10 @@ module YnabApi
       @client = ApiClient.new(config)
     end
 
+    def users
+      UserApi.new(@client)
+    end
+
     def budgets
       BudgetsApi.new(@client)
     end

data/lib/ynab/api/transactions_api.rb

@@ -383,6 +383,68 @@ module YnabApi
       return data, status_code, headers
     end
 
+    # List payee transactions
+    # Returns all transactions for a specified payee
+    # @param budget_id The ID of the Budget.
+    # @param payee_id The ID of the Payee.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Date] :since_date Only return transactions on or after this date.
+    # @return [TransactionsResponse]
+    def get_transactions_by_payee(budget_id, payee_id, opts = {})
+      data, _status_code, _headers = get_transactions_by_payee_with_http_info(budget_id, payee_id, opts)
+      return data
+    end
+
+    # List payee transactions
+    # Returns all transactions for a specified payee
+    # @param budget_id The ID of the Budget.
+    # @param payee_id The ID of the Payee.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Date] :since_date Only return transactions on or after this date.
+    # @return [Array<(TransactionsResponse, Fixnum, Hash)>] TransactionsResponse data, response status code and response headers
+    def get_transactions_by_payee_with_http_info(budget_id, payee_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: TransactionsApi.get_transactions_by_payee ..."
+      end
+      # verify the required parameter 'budget_id' is set
+      if @api_client.config.client_side_validation && budget_id.nil?
+        fail ArgumentError, "Missing the required parameter 'budget_id' when calling TransactionsApi.get_transactions_by_payee"
+      end
+      # verify the required parameter 'payee_id' is set
+      if @api_client.config.client_side_validation && payee_id.nil?
+        fail ArgumentError, "Missing the required parameter 'payee_id' when calling TransactionsApi.get_transactions_by_payee"
+      end
+      # resource path
+      local_var_path = "/budgets/{budget_id}/payees/{payee_id}/transactions".sub('{' + 'budget_id' + '}', budget_id.to_s).sub('{' + 'payee_id' + '}', payee_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'since_date'] = opts[:'since_date'] if !opts[:'since_date'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['bearer']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'TransactionsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TransactionsApi#get_transactions_by_payee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Updates an existing transaction
     # Updates a transaction
     # @param budget_id The ID of the Budget.

data/lib/ynab/api/user_api.rb

@@ -0,0 +1,70 @@
+=begin
+#YNAB API Endpoints
+
+#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.youneedabudget.com
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require "uri"
+
+module YnabApi
+  class UserApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # User info
+    # Returns authenticated user information.
+    # @param [Hash] opts the optional parameters
+    # @return [UserResponse]
+    def get_user(opts = {})
+      data, _status_code, _headers = get_user_with_http_info(opts)
+      return data
+    end
+
+    # User info
+    # Returns authenticated user information.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserResponse, Fixnum, Hash)>] UserResponse data, response status code and response headers
+    def get_user_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UserApi.get_user ..."
+      end
+      # resource path
+      local_var_path = "/user"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['bearer']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'UserResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UserApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end