ynab 0.4.0 → 0.5.0

data/lib/ynab/models/sub_transaction.rb

@@ -19,7 +19,7 @@ module YnabApi
 
     attr_accessor :transaction_id
 
-    # The sub-transaction amount in milliunits format
+    # The subtransaction amount in milliunits format
     attr_accessor :amount
 
     attr_accessor :memo

data/lib/ynab/models/transaction_detail.rb

@@ -44,7 +44,11 @@ module YnabApi
     # 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'.
     attr_accessor :import_id
 
-    # If a split transaction, the sub-transactions.
+    attr_accessor :payee_name
+
+    attr_accessor :category_name
+
+    # If a split transaction, the subtransactions.
     attr_accessor :subtransactions
 
     class EnumAttributeValidator
@@ -84,6 +88,8 @@ module YnabApi
         :'category_id' => :'category_id',
         :'transfer_account_id' => :'transfer_account_id',
         :'import_id' => :'import_id',
+        :'payee_name' => :'payee_name',
+        :'category_name' => :'category_name',
         :'subtransactions' => :'subtransactions'
       }
     end
@@ -103,6 +109,8 @@ module YnabApi
         :'category_id' => :'String',
         :'transfer_account_id' => :'String',
         :'import_id' => :'String',
+        :'payee_name' => :'String',
+        :'category_name' => :'String',
         :'subtransactions' => :'Array<SubTransaction>'
       }
     end
@@ -163,6 +171,14 @@ module YnabApi
         self.import_id = attributes[:'import_id']
       end
 
+      if attributes.has_key?(:'payee_name')
+        self.payee_name = attributes[:'payee_name']
+      end
+
+      if attributes.has_key?(:'category_name')
+        self.category_name = attributes[:'category_name']
+      end
+
       if attributes.has_key?(:'subtransactions')
         if (value = attributes[:'subtransactions']).is_a?(Array)
           self.subtransactions = value
@@ -223,6 +239,14 @@ module YnabApi
         invalid_properties.push("invalid value for 'import_id', import_id cannot be nil.")
       end
 
+      if @payee_name.nil?
+        invalid_properties.push("invalid value for 'payee_name', payee_name cannot be nil.")
+      end
+
+      if @category_name.nil?
+        invalid_properties.push("invalid value for 'category_name', category_name cannot be nil.")
+      end
+
       if @subtransactions.nil?
         invalid_properties.push("invalid value for 'subtransactions', subtransactions cannot be nil.")
       end
@@ -249,6 +273,8 @@ module YnabApi
       return false if @category_id.nil?
       return false if @transfer_account_id.nil?
       return false if @import_id.nil?
+      return false if @payee_name.nil?
+      return false if @category_name.nil?
       return false if @subtransactions.nil?
       return true
     end
@@ -290,6 +316,8 @@ module YnabApi
           category_id == o.category_id &&
           transfer_account_id == o.transfer_account_id &&
           import_id == o.import_id &&
+          payee_name == o.payee_name &&
+          category_name == o.category_name &&
           subtransactions == o.subtransactions
     end
 
@@ -302,7 +330,7 @@ module YnabApi
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, date, amount, memo, cleared, approved, flag_color, account_id, payee_id, category_id, transfer_account_id, import_id, subtransactions].hash
+      [id, date, amount, memo, cleared, approved, flag_color, account_id, payee_id, category_id, transfer_account_id, import_id, payee_name, category_name, subtransactions].hash
     end
 
     # Builds the object from hash

data/lib/ynab/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.3.1
 =end
 
 module YnabApi
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec-v1-swagger.json

@@ -869,7 +869,7 @@
           "200": {
             "description": "The list of requested Transactions.",
             "schema": {
-              "$ref": "#/definitions/TransactionsResponse"
+              "$ref": "#/definitions/HybridTransactionsResponse"
             }
           },
           "404": {
@@ -924,7 +924,7 @@
           "200": {
             "description": "The list of requested Transactions.",
             "schema": {
-              "$ref": "#/definitions/TransactionsResponse"
+              "$ref": "#/definitions/HybridTransactionsResponse"
             }
           },
           "404": {
@@ -1276,6 +1276,7 @@
           "$ref": "#/definitions/BudgetSummary"
         },
         {
+          "type": "object",
           "properties": {
             "accounts": {
               "type": "array",
@@ -1510,6 +1511,7 @@
           "$ref": "#/definitions/CategoryGroup"
         },
         {
+          "type": "object",
           "required": ["categories"],
           "properties": {
             "categories": {
@@ -1705,6 +1707,27 @@
         }
       }
     },
+    "HybridTransactionsResponse": {
+      "type": "object",
+      "required": ["data"],
+      "properties": {
+        "data": {
+          "$ref": "#/definitions/HybridTransactionsWrapper"
+        }
+      }
+    },
+    "HybridTransactionsWrapper": {
+      "type": "object",
+      "required": ["transactions"],
+      "properties": {
+        "transactions": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/HybridTransaction"
+          }
+        }
+      }
+    },
     "TransactionResponse": {
       "type": "object",
       "required": ["data"],
@@ -1799,11 +1822,18 @@
           "$ref": "#/definitions/TransactionSummary"
         },
         {
-          "required": ["subtransactions"],
+          "type": "object",
+          "required": ["payee_name", "category_name", "subtransactions"],
           "properties": {
+            "payee_name": {
+              "type": "string"
+            },
+            "category_name": {
+              "type": "string"
+            },
             "subtransactions": {
               "type": "array",
-              "description": "If a split transaction, the sub-transactions.",
+              "description": "If a split transaction, the subtransactions.",
               "items": {
                 "$ref": "#/definitions/SubTransaction"
               }
@@ -1812,6 +1842,31 @@
         }
       ]
     },
+    "HybridTransaction": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/TransactionSummary"
+        },
+        {
+          "type": "object",
+          "required": ["type", "parent_transaction_id"],
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": ["transaction", "subtransaction"],
+              "description":
+                "Whether the hybrid transaction represents a regular transaction or a subtransaction"
+            },
+            "parent_transaction_id": {
+              "type": "string",
+              "format": "uuid",
+              "description":
+                "For subtransaction types, this is the id of the pararent transaction.  For transaction types, this id will be always be null."
+            }
+          }
+        }
+      ]
+    },
     "SaveTransactionWrapper": {
       "type": "object",
       "required": ["transaction"],
@@ -1954,7 +2009,7 @@
         "amount": {
           "type": "number",
           "format": "1234000",
-          "description": "The sub-transaction amount in milliunits format"
+          "description": "The subtransaction amount in milliunits format"
         },
         "memo": {
           "type": "string"
@@ -2103,12 +2158,27 @@
           "$ref": "#/definitions/ScheduledTransactionSummary"
         },
         {
-          "required": ["subtransactions"],
+          "type": "object",
+          "required": [
+            "account_name",
+            "payee_name",
+            "category_name",
+            "subtransactions"
+          ],
           "properties": {
+            "account_name": {
+              "type": "string"
+            },
+            "payee_name": {
+              "type": "string"
+            },
+            "category_name": {
+              "type": "string"
+            },
             "subtransactions": {
               "type": "array",
               "description":
-                "If a split scheduled transaction, the sub-transactions.",
+                "If a split scheduled transaction, the subtransactions.",
               "items": {
                 "$ref": "#/definitions/ScheduledSubTransaction"
               }
@@ -2141,7 +2211,7 @@
           "type": "number",
           "format": "1234000",
           "description":
-            "The scheduled sub-transaction amount in milliunits format"
+            "The scheduled subtransaction amount in milliunits format"
         },
         "memo": {
           "type": "string"
@@ -2229,6 +2299,7 @@
           "$ref": "#/definitions/MonthSummary"
         },
         {
+          "type": "object",
           "required": ["categories"],
           "properties": {
             "categories": {

data/spec/api/transactions_spec.rb

@@ -4,6 +4,8 @@ require 'pp'
 describe 'transactions' do
   let(:access_token) { '9f1a2c4842b614a771aaae9220fc54ae835e298c4654dc2c9205fc1d7bd1a045' }
   let(:budget_id) { 'f419ac25-6217-4175-88dc-c3136ff5f6fd' }
+  let(:category_id) { '84ffe61c-081c-44db-ad23-6ee809206c40' }
+  let(:payee_id) { '2676f959-c5de-4db2-8d3f-2503777b25fb' }
   let(:client) { YnabApi::Client.new(access_token, 'api.localhost:3000', false) }
   let (:instance) { client.transactions }
 
@@ -45,8 +47,28 @@ describe 'transactions' do
     end
   end
 
-  describe 'GET /budgets/{budget_id}/transaction/{payee_id}' do
-    it "returns a payee" do
+  describe 'GET /budgets/{budget_id}/category/{category_id}/transactions' do
+    it "returns a list of transactions for a category" do
+      VCR.use_cassette("category_transactions") do
+        response = instance.get_transactions_by_category(budget_id, category_id)
+        expect(client.last_request.response.options[:code]).to be 200
+        expect(response.data.transactions.length).to be 3
+      end
+    end
+  end
+
+  describe 'GET /budgets/{budget_id}/category/{payee_id}/transactions' do
+    it "returns a list of transactions for a payee" do
+      VCR.use_cassette("payee_transactions") do
+        response = instance.get_transactions_by_payee(budget_id, payee_id)
+        expect(client.last_request.response.options[:code]).to be 200
+        expect(response.data.transactions.length).to be 2
+      end
+    end
+  end
+
+  describe 'GET /budgets/{budget_id}/transaction/{transaction_id}' do
+    it "returns a transaction" do
       VCR.use_cassette("transaction") do
         response = instance.get_transactions_by_id(budget_id, '81c374ff-74ab-4d6d-8d5a-ba3ad3fa68e4')
         expect(response.data.transaction).to be

data/spec/fixtures/vcr_cassettes/category_transactions.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.localhost:3000/v1/budgets/f419ac25-6217-4175-88dc-c3136ff5f6fd/categories/84ffe61c-081c-44db-ad23-6ee809206c40/transactions
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - api_client/ruby/0.4.0
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      Authorization:
+      - Bearer 9f1a2c4842b614a771aaae9220fc54ae835e298c4654dc2c9205fc1d7bd1a045
+      Expect:
+      - ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Vary:
+      - Accept-Encoding, Origin
+      ETag:
+      - W/"34c52d2665519c44aa89bfb862b99e7e"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 0e4f8e02-620d-4433-8a88-f776fdafc165
+      X-Runtime:
+      - '0.376111'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"data":{"transactions":[{"type":"subtransaction","id":"4a675c31-f5f1-43ba-8c9a-6cd7d5b0cac4","parent_transaction_id":"56a3ae86-ce55-4e23-923b-6cb59add860b","date":"2018-03-26","amount":-50000,"memo":"","cleared":"uncleared","approved":true,"flag_color":null,"account_id":"16addaa3-cfaf-4e57-933c-7e1645f000f0","payee_id":null,"category_id":"84ffe61c-081c-44db-ad23-6ee809206c40","transfer_account_id":null,"import_id":null},{"type":"subtransaction","id":"4c3f5877-b4b9-4d5a-9177-be7dfcd86c6e","parent_transaction_id":"910a79e1-29f5-4789-a2a0-2a69c2f94a2b","date":"2018-03-26","amount":-25000,"memo":"","cleared":"uncleared","approved":true,"flag_color":null,"account_id":"16addaa3-cfaf-4e57-933c-7e1645f000f0","payee_id":null,"category_id":"84ffe61c-081c-44db-ad23-6ee809206c40","transfer_account_id":null,"import_id":null},{"type":"transaction","id":"d477e91a-1f2b-4df5-8069-6b61dee51259","parent_transaction_id":null,"date":"2018-03-27","amount":-13000,"memo":"","cleared":"uncleared","approved":true,"flag_color":null,"account_id":"16addaa3-cfaf-4e57-933c-7e1645f000f0","payee_id":"2676f959-c5de-4db2-8d3f-2503777b25fb","category_id":"84ffe61c-081c-44db-ad23-6ee809206c40","transfer_account_id":null,"import_id":null}]}}'
+    http_version: '1.1'
+    adapter_metadata:
+      effective_url: http://api.localhost:3000/v1/budgets/6e6aa585-8537-4afc-950f-93d55fac17fa/categories/84ffe61c-081c-44db-ad23-6ee809206c40/transactions
+  recorded_at: Tue, 27 Mar 2018 17:02:30 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr_cassettes/payee_transactions.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.localhost:3000/v1/budgets/f419ac25-6217-4175-88dc-c3136ff5f6fd/payees/2676f959-c5de-4db2-8d3f-2503777b25fb/transactions
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - api_client/ruby/0.4.0
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      Authorization:
+      - Bearer 9f1a2c4842b614a771aaae9220fc54ae835e298c4654dc2c9205fc1d7bd1a045
+      Expect:
+      - ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Vary:
+      - Accept-Encoding, Origin
+      ETag:
+      - W/"d2b4b29be1231be9847defe032df6712"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - b79f3971-7666-4b04-8d8b-bd5258dd02bc
+      X-Runtime:
+      - '0.186443'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"data":{"transactions":[{"type":"subtransaction","id":"008908a3-07c2-4684-b4c1-6f1024814f8d","parent_transaction_id":"910a79e1-29f5-4789-a2a0-2a69c2f94a2b","date":"2018-03-26","amount":-15000,"memo":"","cleared":"uncleared","approved":true,"flag_color":null,"account_id":"16addaa3-cfaf-4e57-933c-7e1645f000f0","payee_id":"2676f959-c5de-4db2-8d3f-2503777b25fb","category_id":"b457e34a-234e-40b2-992e-40055171e644","transfer_account_id":null,"import_id":null},{"type":"transaction","id":"d477e91a-1f2b-4df5-8069-6b61dee51259","parent_transaction_id":null,"date":"2018-03-27","amount":-13000,"memo":"","cleared":"uncleared","approved":true,"flag_color":null,"account_id":"16addaa3-cfaf-4e57-933c-7e1645f000f0","payee_id":"2676f959-c5de-4db2-8d3f-2503777b25fb","category_id":"84ffe61c-081c-44db-ad23-6ee809206c40","transfer_account_id":null,"import_id":null}]}}'
+    http_version: '1.1'
+    adapter_metadata:
+      effective_url: http://api.localhost:3000/v1/budgets/6e6aa585-8537-4afc-950f-93d55fac17fa/payees/2676f959-c5de-4db2-8d3f-2503777b25fb/transactions
+  recorded_at: Tue, 27 Mar 2018 17:03:22 GMT
+recorded_with: VCR 3.0.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ynab
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - You Need A Budget, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -134,6 +134,9 @@ files:
 - docs/DateFormat.md
 - docs/ErrorDetail.md
 - docs/ErrorResponse.md
+- docs/HybridTransaction.md
+- docs/HybridTransactionsResponse.md
+- docs/HybridTransactionsWrapper.md
 - docs/MonthDetail.md
 - docs/MonthDetailResponse.md
 - docs/MonthDetailWrapper.md
@@ -219,6 +222,9 @@ files:
 - lib/ynab/models/date_format.rb
 - lib/ynab/models/error_detail.rb
 - lib/ynab/models/error_response.rb
+- lib/ynab/models/hybrid_transaction.rb
+- lib/ynab/models/hybrid_transactions_response.rb
+- lib/ynab/models/hybrid_transactions_wrapper.rb
 - lib/ynab/models/month_detail.rb
 - lib/ynab/models/month_detail_response.rb
 - lib/ynab/models/month_detail_wrapper.rb
@@ -275,6 +281,7 @@ files:
 - spec/fixtures/vcr_cassettes/categories.yml
 - spec/fixtures/vcr_cassettes/categories_unauthorized.yml
 - spec/fixtures/vcr_cassettes/category.yml
+- spec/fixtures/vcr_cassettes/category_transactions.yml
 - spec/fixtures/vcr_cassettes/create_transaction.yml
 - spec/fixtures/vcr_cassettes/month.yml
 - spec/fixtures/vcr_cassettes/months.yml
@@ -283,6 +290,7 @@ files:
 - spec/fixtures/vcr_cassettes/payee_location.yml
 - spec/fixtures/vcr_cassettes/payee_locations.yml
 - spec/fixtures/vcr_cassettes/payee_locations_unauthorized.yml
+- spec/fixtures/vcr_cassettes/payee_transactions.yml
 - spec/fixtures/vcr_cassettes/payees.yml
 - spec/fixtures/vcr_cassettes/payees_unauthorized.yml
 - spec/fixtures/vcr_cassettes/scheduled_transaction.yml
@@ -330,6 +338,7 @@ test_files:
 - spec/api/months_spec.rb
 - spec/api/transactions_spec.rb
 - spec/fixtures/.DS_Store
+- spec/fixtures/vcr_cassettes/payee_transactions.yml
 - spec/fixtures/vcr_cassettes/categories.yml
 - spec/fixtures/vcr_cassettes/scheduled_transactions.yml
 - spec/fixtures/vcr_cassettes/accounts_unauthorized.yml
@@ -339,6 +348,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/payees_unauthorized.yml
 - spec/fixtures/vcr_cassettes/create_transaction.yml
 - spec/fixtures/vcr_cassettes/budgets.yml
+- spec/fixtures/vcr_cassettes/category_transactions.yml
 - spec/fixtures/vcr_cassettes/accounts.yml
 - spec/fixtures/vcr_cassettes/payee.yml
 - spec/fixtures/vcr_cassettes/payee_location.yml