ynab 0.3.0 → 0.4.0

data/lib/ynab/models/user_wrapper.rb

@@ -0,0 +1,193 @@
+=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 'date'
+
+module YnabApi
+
+  class UserWrapper
+    attr_accessor :user
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'user' => :'user'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'user' => :'User'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'user')
+        self.user = attributes[:'user']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @user.nil?
+        invalid_properties.push("invalid value for 'user', user cannot be nil.")
+      end
+
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @user.nil?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          user == o.user
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [user].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = YnabApi.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/ynab/version.rb

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

data/spec-v1-swagger.json

@@ -10,6 +10,9 @@
   "host": "api.youneedabudget.com",
   "basePath": "/v1",
   "tags": [
+    {
+      "name": "User"
+    },
     {
       "name": "Budgets"
     },
@@ -50,6 +53,29 @@
     }
   ],
   "paths": {
+    "/user": {
+      "get": {
+        "tags": ["User"],
+        "summary": "User info",
+        "description": "Returns authenticated user information.",
+        "operationId": "getUser",
+        "produces": ["application/json"],
+        "responses": {
+          "200": {
+            "description": "The user info.",
+            "schema": {
+              "$ref": "#/definitions/UserResponse"
+            }
+          },
+          "default": {
+            "description": "An error occurred.",
+            "schema": {
+              "$ref": "#/definitions/ErrorResponse"
+            }
+          }
+        }
+      }
+    },
     "/budgets": {
       "get": {
         "tags": ["Budgets"],
@@ -737,8 +763,7 @@
         ],
         "responses": {
           "201": {
-            "description":
-              "The bulk request was processed sucessfully.",
+            "description": "The bulk request was processed sucessfully.",
             "schema": {
               "$ref": "#/definitions/BulkResponse"
             }
@@ -862,6 +887,61 @@
         }
       }
     },
+    "/budgets/{budget_id}/payees/{payee_id}/transactions": {
+      "get": {
+        "tags": ["Transactions"],
+        "summary": "List payee transactions",
+        "description": "Returns all transactions for a specified payee",
+        "operationId": "getTransactionsByPayee",
+        "produces": ["application/json"],
+        "parameters": [
+          {
+            "name": "budget_id",
+            "in": "path",
+            "description": "The ID of the Budget.",
+            "required": true,
+            "type": "string",
+            "format": "uuid"
+          },
+          {
+            "name": "payee_id",
+            "in": "path",
+            "description": "The ID of the Payee.",
+            "required": true,
+            "type": "string",
+            "format": "uuid"
+          },
+          {
+            "name": "since_date",
+            "in": "query",
+            "description": "Only return transactions on or after this date.",
+            "required": false,
+            "type": "string",
+            "format": "date"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The list of requested Transactions.",
+            "schema": {
+              "$ref": "#/definitions/TransactionsResponse"
+            }
+          },
+          "404": {
+            "description": "No Transactions were found.",
+            "schema": {
+              "$ref": "#/definitions/ErrorResponse"
+            }
+          },
+          "default": {
+            "description": "An error occurred.",
+            "schema": {
+              "$ref": "#/definitions/ErrorResponse"
+            }
+          }
+        }
+      }
+    },
     "/budgets/{budget_id}/transactions/{transaction_id}": {
       "get": {
         "tags": ["Transactions"],
@@ -1076,6 +1156,34 @@
         }
       }
     },
+    "UserResponse": {
+      "type": "object",
+      "required": ["data"],
+      "properties": {
+        "data": {
+          "$ref": "#/definitions/UserWrapper"
+        }
+      }
+    },
+    "UserWrapper": {
+      "type": "object",
+      "required": ["user"],
+      "properties": {
+        "user": {
+          "$ref": "#/definitions/User"
+        }
+      }
+    },
+    "User": {
+      "type": "object",
+      "required": ["id"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid"
+        }
+      }
+    },
     "BudgetSummaryResponse": {
       "type": "object",
       "required": ["data"],
@@ -1133,7 +1241,8 @@
         "last_modified_on": {
           "type": "string",
           "format": "date-time",
-          "description": "The last time any changes were made to the budget from either a web or mobile client."
+          "description":
+            "The last time any changes were made to the budget from either a web or mobile client."
         },
         "date_format": {
           "$ref": "#/definitions/DateFormat"
@@ -1301,6 +1410,7 @@
             "cash",
             "lineOfCredit",
             "merchantAccount",
+            "payPal",
             "investmentAccount",
             "mortgage",
             "otherAsset",
@@ -1656,7 +1766,9 @@
           "description": "Whether or not the transaction is approved"
         },
         "flag_color": {
-          "type": "string"
+          "type": "string",
+          "enum": ["red", "orange", "yellow", "green", "blue", "purple", null],
+          "description": "The transaction flag"
         },
         "account_id": {
           "type": "string",
@@ -1758,7 +1870,7 @@
         },
         "flag_color": {
           "type": "string",
-          "enum": ["red", "orange", "yellow", "green", "blue", "purple"],
+          "enum": ["red", "orange", "yellow", "green", "blue", "purple", null],
           "description": "The transaction flag"
         },
         "import_id": {
@@ -1961,7 +2073,9 @@
           "type": "string"
         },
         "flag_color": {
-          "type": "string"
+          "type": "string",
+          "enum": ["red", "orange", "yellow", "green", "blue", "purple", null],
+          "description": "The scheduled transaction flag"
         },
         "account_id": {
           "type": "string",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ynab
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - You Need A Budget, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2018-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -171,6 +171,10 @@ files:
 - docs/TransactionsApi.md
 - docs/TransactionsResponse.md
 - docs/TransactionsWrapper.md
+- docs/User.md
+- docs/UserApi.md
+- docs/UserResponse.md
+- docs/UserWrapper.md
 - examples/budget-list.rb
 - examples/budget-month.rb
 - examples/category-balance.rb
@@ -183,6 +187,7 @@ files:
 - lib/ynab/api/payees_api.rb
 - lib/ynab/api/scheduled_transactions_api.rb
 - lib/ynab/api/transactions_api.rb
+- lib/ynab/api/user_api.rb
 - lib/ynab/api_client.rb
 - lib/ynab/api_error.rb
 - lib/ynab/configuration.rb
@@ -246,6 +251,9 @@ files:
 - lib/ynab/models/transaction_wrapper.rb
 - lib/ynab/models/transactions_response.rb
 - lib/ynab/models/transactions_wrapper.rb
+- lib/ynab/models/user.rb
+- lib/ynab/models/user_response.rb
+- lib/ynab/models/user_wrapper.rb
 - lib/ynab/version.rb
 - spec-v1-swagger.json
 - spec/api/accounts_spec.rb