ynab 1.0.0 → 1.1.0

data/lib/ynab/models/transaction_response.rb

@@ -12,7 +12,7 @@ Swagger Codegen version: 2.4.0-SNAPSHOT
 
 require 'date'
 
-module YnabApi
+module YNAB
   class TransactionResponse
     attr_accessor :data
 
@@ -138,7 +138,7 @@ module YnabApi
           end
         end
       else # model
-        temp_model = YnabApi.const_get(type).new
+        temp_model = YNAB.const_get(type).new
         temp_model.build_from_hash(value)
       end
     end

data/lib/ynab/models/transaction_summary.rb

@@ -12,7 +12,7 @@ Swagger Codegen version: 2.4.0-SNAPSHOT
 
 require 'date'
 
-module YnabApi
+module YNAB
   class TransactionSummary
     attr_accessor :id
 
@@ -358,7 +358,7 @@ module YnabApi
           end
         end
       else # model
-        temp_model = YnabApi.const_get(type).new
+        temp_model = YNAB.const_get(type).new
         temp_model.build_from_hash(value)
       end
     end

data/lib/ynab/models/transaction_wrapper.rb

@@ -12,7 +12,7 @@ Swagger Codegen version: 2.4.0-SNAPSHOT
 
 require 'date'
 
-module YnabApi
+module YNAB
   class TransactionWrapper
     attr_accessor :transaction
 
@@ -138,7 +138,7 @@ module YnabApi
           end
         end
       else # model
-        temp_model = YnabApi.const_get(type).new
+        temp_model = YNAB.const_get(type).new
         temp_model.build_from_hash(value)
       end
     end

data/lib/ynab/models/transactions_response.rb

@@ -12,7 +12,7 @@ Swagger Codegen version: 2.4.0-SNAPSHOT
 
 require 'date'
 
-module YnabApi
+module YNAB
   class TransactionsResponse
     attr_accessor :data
 
@@ -138,7 +138,7 @@ module YnabApi
           end
         end
       else # model
-        temp_model = YnabApi.const_get(type).new
+        temp_model = YNAB.const_get(type).new
         temp_model.build_from_hash(value)
       end
     end

data/lib/ynab/models/transactions_wrapper.rb

@@ -12,7 +12,7 @@ Swagger Codegen version: 2.4.0-SNAPSHOT
 
 require 'date'
 
-module YnabApi
+module YNAB
   class TransactionsWrapper
     attr_accessor :transactions
 
@@ -140,7 +140,7 @@ module YnabApi
           end
         end
       else # model
-        temp_model = YnabApi.const_get(type).new
+        temp_model = YNAB.const_get(type).new
         temp_model.build_from_hash(value)
       end
     end

data/lib/ynab/models/user.rb

@@ -12,7 +12,7 @@ Swagger Codegen version: 2.4.0-SNAPSHOT
 
 require 'date'
 
-module YnabApi
+module YNAB
   class User
     attr_accessor :id
 
@@ -138,7 +138,7 @@ module YnabApi
           end
         end
       else # model
-        temp_model = YnabApi.const_get(type).new
+        temp_model = YNAB.const_get(type).new
         temp_model.build_from_hash(value)
       end
     end

data/lib/ynab/models/user_response.rb

@@ -12,7 +12,7 @@ Swagger Codegen version: 2.4.0-SNAPSHOT
 
 require 'date'
 
-module YnabApi
+module YNAB
   class UserResponse
     attr_accessor :data
 
@@ -138,7 +138,7 @@ module YnabApi
           end
         end
       else # model
-        temp_model = YnabApi.const_get(type).new
+        temp_model = YNAB.const_get(type).new
         temp_model.build_from_hash(value)
       end
     end

data/lib/ynab/models/user_wrapper.rb

@@ -12,7 +12,7 @@ Swagger Codegen version: 2.4.0-SNAPSHOT
 
 require 'date'
 
-module YnabApi
+module YNAB
   class UserWrapper
     attr_accessor :user
 
@@ -138,7 +138,7 @@ module YnabApi
           end
         end
       else # model
-        temp_model = YnabApi.const_get(type).new
+        temp_model = YNAB.const_get(type).new
         temp_model.build_from_hash(value)
       end
     end

data/lib/ynab/version.rb

@@ -10,6 +10,6 @@ Swagger Codegen version: 2.4.0-SNAPSHOT
 
 =end
 
-module YnabApi
-  VERSION = '1.0.0'
+module YNAB
+  VERSION = '1.1.0'
 end

data/spec-v1-swagger.json

@@ -154,6 +154,46 @@
         }
       }
     },
+    "/budgets/{budget_id}/settings": {
+      "get": {
+        "tags": ["Budgets"],
+        "summary": "Budget Settings",
+        "description":
+          "Returns settings for a budget.",
+        "operationId": "getBudgetSettingsById",
+        "produces": ["application/json"],
+        "parameters": [
+          {
+            "name": "budget_id",
+            "in": "path",
+            "description": "The ID of the Budget.",
+            "required": true,
+            "type": "string",
+            "format": "uuid"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The requested Budget Settings.",
+            "schema": {
+              "$ref": "#/definitions/BudgetSettingsResponse"
+            }
+          },
+          "404": {
+            "description": "The specified Budget was not found.",
+            "schema": {
+              "$ref": "#/definitions/ErrorResponse"
+            }
+          },
+          "default": {
+            "description": "An error occurred.",
+            "schema": {
+              "$ref": "#/definitions/ErrorResponse"
+            }
+          }
+        }
+      }
+    },
     "/budgets/{budget_id}/accounts": {
       "get": {
         "tags": ["Accounts"],
@@ -660,7 +700,7 @@
             "name": "type",
             "in": "query",
             "description":
-              "Only return transactions of a certain type (i.e. 'uncategorized', 'unapproved')",
+              "Only return transactions of a certain type ('uncategorized' and 'unapproved' are currently supported)",
             "required": false,
             "type": "string",
             "enum": ["uncategorized", "unapproved"]
@@ -801,6 +841,15 @@
             "required": false,
             "type": "string",
             "format": "date"
+          },
+          {
+            "name": "type",
+            "in": "query",
+            "description":
+              "Only return transactions of a certain type (i.e. 'uncategorized', 'unapproved')",
+            "required": false,
+            "type": "string",
+            "enum": ["uncategorized", "unapproved"]
           }
         ],
         "responses": {
@@ -856,6 +905,15 @@
             "required": false,
             "type": "string",
             "format": "date"
+          },
+          {
+            "name": "type",
+            "in": "query",
+            "description":
+              "Only return transactions of a certain type (i.e. 'uncategorized', 'unapproved')",
+            "required": false,
+            "type": "string",
+            "enum": ["uncategorized", "unapproved"]
           }
         ],
         "responses": {
@@ -911,6 +969,15 @@
             "required": false,
             "type": "string",
             "format": "date"
+          },
+          {
+            "name": "type",
+            "in": "query",
+            "description":
+              "Only return transactions of a certain type (i.e. 'uncategorized', 'unapproved')",
+            "required": false,
+            "type": "string",
+            "enum": ["uncategorized", "unapproved"]
           }
         ],
         "responses": {
@@ -1016,7 +1083,7 @@
         ],
         "responses": {
           "200": {
-            "description": "The Transaction was successfull updated.",
+            "description": "The Transaction was successfully updated.",
             "schema": {
               "$ref": "#/definitions/TransactionResponse"
             }
@@ -1268,6 +1335,24 @@
         }
       }
     },
+    "BudgetSettingsResponse": {
+      "type": "object",
+      "required": ["data"],
+      "properties": {
+        "data": {
+          "$ref": "#/definitions/BudgetSettingsWrapper"
+        }
+      }
+    },
+    "BudgetSettingsWrapper": {
+      "type": "object",
+      "required": ["settings"],
+      "properties": {
+        "settings": {
+          "$ref": "#/definitions/BudgetSettings"
+        }
+      }
+    },
     "BudgetSummary": {
       "type": "object",
       "required": ["id", "name"],
@@ -1293,6 +1378,18 @@
         }
       }
     },
+    "BudgetSettings": {
+      "type": "object",
+      "required": ["date_format", "currency_format"],
+      "properties": {
+        "date_format": {
+          "$ref": "#/definitions/DateFormat"
+        },
+        "currency_format": {
+          "$ref": "#/definitions/CurrencyFormat"
+        }
+      }
+    },
     "BudgetDetail": {
       "allOf": [
         {
@@ -1587,6 +1684,11 @@
           "description": "Whether or not the category is hidden",
           "type": "boolean"
         },
+        "original_category_group_id": {
+          "description": "If category is hidden this is the id of the category group it originally belonged to before it was hidden.",
+          "type": "string",
+          "format": "uuid"
+        },
         "note": {
           "type": "string"
         },
@@ -1976,7 +2078,7 @@
         "payee_name": {
           "type": "string",
           "description":
-            "The payee name.  If a payee_name value is provided and payee_id is not included or has a null value, payee_name will be used to create or use an existing payee."
+            "The payee name.  If a payee_name value is provided and payee_id has a null value, the payee_name value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified) or (2) a payee with the same name or (3) creation of a new payee."
         },
         "category_id": {
           "type": "string",

data/spec/api/accounts_spec.rb

@@ -3,12 +3,12 @@ require 'spec_helper'
 describe 'accounts' do
   let(:access_token) { '9f1a2c4842b614a771aaae9220fc54ae835e298c4654dc2c9205fc1d7bd1a045' }
   let(:budget_id) { 'f419ac25-6217-4175-88dc-c3136ff5f6fd' }
-  let(:client) { YnabApi::Client.new(access_token, 'api.localhost:3000', false) }
+  let(:client) { YNAB::API.new(access_token, 'api.localhost:3000', false) }
   let (:instance) { client.accounts }
 
   describe 'test an instance of AccountsApi' do
     it 'should create an instance of AccountsApi' do
-      expect(instance).to be_instance_of(YnabApi::AccountsApi)
+      expect(instance).to be_instance_of(YNAB::AccountsApi)
     end
   end
 
@@ -23,10 +23,10 @@ describe 'accounts' do
 
     it "throws when unauthorized" do
       VCR.use_cassette("accounts_unauthorized") do
-        client = YnabApi::Client.new('not_valid_access_token', 'api.localhost:3000', false)
+        client = YNAB::API.new('not_valid_access_token', 'api.localhost:3000', false)
         begin
           response = client.accounts.get_accounts(budget_id)
-        rescue YnabApi::ApiError => e
+        rescue YNAB::ApiError => e
           expect(e.code).to be 401
           expect(client.last_request.response.options[:code]).to be 401
         end
@@ -53,4 +53,13 @@ describe 'accounts' do
       end
     end
   end
+
+  it "foobar" do
+    VCR.use_cassette("accounts") do
+      client = YnabApi::Client.new(access_token, 'api.localhost:3000', false)
+      response = client.accounts.get_accounts(budget_id)
+      expect(client.last_request.response.options[:code]).to be 200
+      expect(response.data.accounts.length).to be 1
+    end
+  end
 end

data/spec/api/budgets_spec.rb

@@ -2,12 +2,12 @@ require 'spec_helper'
 
 describe 'budgets' do
   let(:access_token) { '9f1a2c4842b614a771aaae9220fc54ae835e298c4654dc2c9205fc1d7bd1a045' }
-  let(:client) { YnabApi::Client.new(access_token, 'api.localhost:3000', false) }
+  let(:client) { YNAB::API.new(access_token, 'api.localhost:3000', false) }
   let (:instance) { client.budgets }
 
   describe 'test an instance of BudgetsApi' do
     it 'should create an instance of BudgetsApi' do
-      expect(instance).to be_instance_of(YnabApi::BudgetsApi)
+      expect(instance).to be_instance_of(YNAB::BudgetsApi)
     end
   end
 
@@ -22,10 +22,10 @@ describe 'budgets' do
 
     it "throws when unauthorized" do
       VCR.use_cassette("budgets_unauthorized") do
-        client = YnabApi::Client.new('not_valid_access_token', 'api.localhost:3000', false)
+        client = YNAB::API.new('not_valid_access_token', 'api.localhost:3000', false)
         begin
           response = client.budgets.get_budgets
-        rescue YnabApi::ApiError => e
+        rescue YNAB::ApiError => e
           expect(e.code).to be 401
           expect(client.last_request.response.options[:code]).to be 401
         end

data/spec/api/categories_spec.rb

@@ -3,12 +3,12 @@ require 'spec_helper'
 describe 'categories' do
   let(:access_token) { '9f1a2c4842b614a771aaae9220fc54ae835e298c4654dc2c9205fc1d7bd1a045' }
   let(:budget_id) { 'f419ac25-6217-4175-88dc-c3136ff5f6fd' }
-  let(:client) { YnabApi::Client.new(access_token, 'api.localhost:3000', false) }
+  let(:client) { YNAB::API.new(access_token, 'api.localhost:3000', false) }
   let (:instance) { client.categories }
 
   describe 'test an instance of CategoriesApi' do
     it 'should create an instance of CategoriesApi' do
-      expect(instance).to be_instance_of(YnabApi::CategoriesApi)
+      expect(instance).to be_instance_of(YNAB::CategoriesApi)
     end
   end
 
@@ -23,10 +23,10 @@ describe 'categories' do
 
     it "throws when unauthorized" do
       VCR.use_cassette("categories_unauthorized") do
-        client = YnabApi::Client.new('not_valid_access_token', 'api.localhost:3000', false)
+        client = YNAB::API.new('not_valid_access_token', 'api.localhost:3000', false)
         begin
           response = client.categories.get_categories(budget_id)
-        rescue YnabApi::ApiError => e
+        rescue YNAB::ApiError => e
           expect(e.code).to be 401
           expect(client.last_request.response.options[:code]).to be 401
         end

data/spec/api/months_spec.rb

@@ -3,12 +3,12 @@ require 'spec_helper'
 describe 'months' do
   let(:access_token) { '9f1a2c4842b614a771aaae9220fc54ae835e298c4654dc2c9205fc1d7bd1a045' }
   let(:budget_id) { 'f419ac25-6217-4175-88dc-c3136ff5f6fd' }
-  let(:client) { YnabApi::Client.new(access_token, 'api.localhost:3000', false) }
+  let(:client) { YNAB::API.new(access_token, 'api.localhost:3000', false) }
   let (:instance) { client.months }
 
   describe 'test an instance of MonthsApi' do
     it 'should create an instance of MonthsApi' do
-      expect(instance).to be_instance_of(YnabApi::MonthsApi)
+      expect(instance).to be_instance_of(YNAB::MonthsApi)
     end
   end
 
@@ -23,10 +23,10 @@ describe 'months' do
 
     it "throws when unauthorized" do
       VCR.use_cassette("months_unauthorized") do
-        client = YnabApi::Client.new('not_valid_access_token', 'api.localhost:3000', false)
+        client = YNAB::API.new('not_valid_access_token', 'api.localhost:3000', false)
         begin
           response = client.months.get_budget_months(budget_id)
-        rescue YnabApi::ApiError => e
+        rescue YNAB::ApiError => e
           expect(e.code).to be 401
           expect(client.last_request.response.options[:code]).to be 401
         end