ynab 2.0.0.rc1 → 2.1.0

data/lib/ynab/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.0-SNAPSHOT
 =end
 
 module YNAB
-  VERSION = '2.0.0.rc1'
+  VERSION = '2.1.0'
 end

data/templates/api.mustache

@@ -0,0 +1,213 @@
+=begin
+{{> api_info}}
+=end
+
+require 'cgi'
+
+module {{moduleName}}
+{{#operations}}
+  class {{classname}}
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+{{#operation}}
+    {{#summary}}
+    # {{{.}}}
+    {{/summary}}
+    {{#notes}}
+    # {{{.}}}
+    {{/notes}}
+{{#vendorExtensions.x-group-parameters}}
+    # @param [Hash] opts the parameters
+{{#allParams}}
+{{#required}}
+    # @option opts [{{{dataType}}}] :{{paramName}} {{description}} (required)
+{{/required}}
+{{/allParams}}
+{{/vendorExtensions.x-group-parameters}}
+{{^vendorExtensions.x-group-parameters}}
+{{#allParams}}
+{{#required}}
+    # @param {{paramName}} [{{{dataType}}}] {{description}}
+{{/required}}
+{{/allParams}}
+    # @param [Hash] opts the optional parameters
+{{/vendorExtensions.x-group-parameters}}
+{{#allParams}}
+{{^required}}
+    # @option opts [{{{dataType}}}] :{{paramName}} {{description}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
+{{/required}}
+{{/allParams}}
+    # @return [{{{returnType}}}{{^returnType}}nil{{/returnType}}]
+    def {{operationId}}({{^vendorExtensions.x-group-parameters}}{{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}opts = {})
+      {{#returnType}}data, _status_code, _headers = {{/returnType}}{{operationId}}_with_http_info({{^vendorExtensions.x-group-parameters}}{{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}opts)
+      {{#returnType}}data{{/returnType}}{{^returnType}}nil{{/returnType}}
+    end
+
+    {{#summary}}
+    # {{.}}
+    {{/summary}}
+    {{#notes}}
+    # {{.}}
+    {{/notes}}
+{{#vendorExtensions.x-group-parameters}}
+    # @param [Hash] opts the parameters
+{{#allParams}}
+{{#required}}
+    # @option opts [{{{dataType}}}] :{{paramName}} {{description}} (required)
+{{/required}}
+{{/allParams}}
+{{/vendorExtensions.x-group-parameters}}
+{{^vendorExtensions.x-group-parameters}}
+{{#allParams}}
+{{#required}}
+    # @param {{paramName}} [{{{dataType}}}] {{description}}
+{{/required}}
+{{/allParams}}
+    # @param [Hash] opts the optional parameters
+{{/vendorExtensions.x-group-parameters}}
+{{#allParams}}
+{{^required}}
+    # @option opts [{{{dataType}}}] :{{paramName}} {{description}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
+{{/required}}
+{{/allParams}}
+    # @return [Array<({{{returnType}}}{{^returnType}}nil{{/returnType}}, Integer, Hash)>] {{#returnType}}{{{.}}} data{{/returnType}}{{^returnType}}nil{{/returnType}}, response status code and response headers
+    def {{operationId}}_with_http_info({{^vendorExtensions.x-group-parameters}}{{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: {{classname}}.{{operationId}} ...'
+      end
+      {{#vendorExtensions.x-group-parameters}}
+      # unbox the parameters from the hash
+      {{#allParams}}
+      {{^isNullable}}
+      {{#required}}
+      {{{paramName}}} = opts[:'{{{paramName}}}']
+      {{/required}}
+      {{/isNullable}}
+      {{/allParams}}
+      {{/vendorExtensions.x-group-parameters}}
+      {{#allParams}}
+      {{^isNullable}}
+      {{#required}}
+      # verify the required parameter '{{paramName}}' is set
+      if @api_client.config.client_side_validation && {{{paramName}}}.nil?
+        fail ArgumentError, "Missing the required parameter '{{paramName}}' when calling {{classname}}.{{operationId}}"
+      end
+      {{#isEnum}}
+      {{^isContainer}}
+      {{/isContainer}}
+      {{/isEnum}}
+      {{/required}}
+      {{/isNullable}}
+      {{^required}}
+      {{#isEnum}}
+      {{#collectionFormat}}
+      {{/collectionFormat}}
+      {{^collectionFormat}}
+      {{/collectionFormat}}
+      {{/isEnum}}
+      {{/required}}
+      {{#hasValidation}}
+      {{#maxLength}}
+      {{/maxLength}}
+      {{#minLength}}
+      {{/minLength}}
+      {{#maximum}}
+      {{/maximum}}
+      {{#minimum}}
+      {{/minimum}}
+      {{#pattern}}
+      {{/pattern}}
+      {{#maxItems}}
+      {{/maxItems}}
+      {{#minItems}}
+      {{/minItems}}
+      {{/hasValidation}}
+      {{/allParams}}
+      # resource path
+      local_var_path = '{{{path}}}'{{#pathParams}}.sub('{' + '{{baseName}}' + '}', CGI.escape({{paramName}}.to_s){{^strictSpecBehavior}}.gsub('%2F', '/'){{/strictSpecBehavior}}){{/pathParams}}
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      {{#queryParams}}
+      {{#required}}
+      query_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
+      {{/required}}
+      {{/queryParams}}
+      {{#queryParams}}
+      {{^required}}
+      query_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{{paramName}}}'].nil?
+      {{/required}}
+      {{/queryParams}}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      {{#hasProduces}}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept([{{#produces}}'{{{mediaType}}}'{{^-last}}, {{/-last}}{{/produces}}])
+      {{/hasProduces}}
+      {{#hasConsumes}}
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type([{{#consumes}}'{{{mediaType}}}'{{^-last}}, {{/-last}}{{/consumes}}])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      {{/hasConsumes}}
+      {{#headerParams}}
+      {{#required}}
+      header_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
+      {{/required}}
+      {{/headerParams}}
+      {{#headerParams}}
+      {{^required}}
+      header_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{{paramName}}}'].nil?
+      {{/required}}
+      {{/headerParams}}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      {{#formParams}}
+      {{#required}}
+      form_params['{{baseName}}'] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
+      {{/required}}
+      {{/formParams}}
+      {{#formParams}}
+      {{^required}}
+      form_params['{{baseName}}'] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{paramName}}'].nil?
+      {{/required}}
+      {{/formParams}}
+
+      # http body (model)
+      post_body = opts[:debug_body]{{#bodyParam}} || @api_client.object_to_http_body({{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}){{/bodyParam}}
+
+      # return_type
+      return_type = opts[:debug_return_type]{{#returnType}} || '{{{.}}}'{{/returnType}}
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [{{#authMethods}}'{{name}}'{{^-last}}, {{/-last}}{{/authMethods}}]
+
+      new_options = opts.merge(
+        :operation => :"{{classname}}.{{operationId}}",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:{{httpMethod}}, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: {{classname}}#{{operationId}}\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+{{^-last}}
+
+{{/-last}}
+{{/operation}}
+  end
+{{/operations}}
+end

data/templates/partial_model_generic.mustache

@@ -0,0 +1,305 @@
+  {{#description}}
+  # {{{.}}}
+  {{/description}}
+  class {{classname}}{{#parent}} < {{{.}}}{{/parent}}
+  {{#vars}}
+    {{#description}}
+    # {{{.}}}
+    {{/description}}
+    attr_accessor :{{{name}}}
+
+  {{/vars}}
+{{#hasEnums}}
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+{{/hasEnums}}
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        {{#vars}}
+        :'{{{name}}}' => :'{{{baseName}}}'{{^-last}},{{/-last}}
+        {{/vars}}
+      }
+    end
+
+    # Returns all the JSON keys this model knows about{{#parent}}, including the ones defined in its parent(s){{/parent}}
+    def self.acceptable_attributes
+      {{^parent}}
+      attribute_map.values
+      {{/parent}}
+      {{#parent}}
+      attribute_map.values.concat(superclass.acceptable_attributes)
+      {{/parent}}
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        {{#vars}}
+        :'{{{name}}}' => :'{{{dataType}}}'{{^-last}},{{/-last}}
+        {{/vars}}
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        {{#vars}}
+        {{#isNullable}}
+        :'{{{name}}}'{{^-last}},{{/-last}}
+        {{/isNullable}}
+        {{/vars}}
+      ])
+    end
+
+    {{#anyOf}}
+    {{#-first}}
+    # List of class defined in anyOf (OpenAPI v3)
+    def self.openapi_any_of
+      [
+    {{/-first}}
+      :'{{{.}}}'{{^-last}},{{/-last}}
+    {{#-last}}
+      ]
+    end
+
+    {{/-last}}
+    {{/anyOf}}
+    {{#allOf}}
+    {{#-first}}
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+    {{/-first}}
+      :'{{{.}}}'{{^-last}},{{/-last}}
+    {{#-last}}
+      ]
+    end
+
+    {{/-last}}
+    {{/allOf}}
+    {{#discriminator}}
+    {{#propertyName}}
+    # discriminator's property name in OpenAPI v3
+    def self.openapi_discriminator_name
+      :'{{{.}}}'
+    end
+
+    {{/propertyName}}
+    {{/discriminator}}
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `{{{moduleName}}}::{{{classname}}}` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `{{{moduleName}}}::{{{classname}}}`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+      {{#parent}}
+
+      # call parent's initialize
+      super(attributes)
+      {{/parent}}
+      {{#vars}}
+
+      if attributes.key?(:'{{{name}}}')
+        {{#isArray}}
+        if (value = attributes[:'{{{name}}}']).is_a?(Array)
+          self.{{{name}}} = value
+        end
+        {{/isArray}}
+        {{#isMap}}
+        if (value = attributes[:'{{{name}}}']).is_a?(Hash)
+          self.{{{name}}} = value
+        end
+        {{/isMap}}
+        {{^isContainer}}
+        self.{{{name}}} = attributes[:'{{{name}}}']
+        {{/isContainer}}
+      {{#defaultValue}}
+      else
+        self.{{{name}}} = {{{defaultValue}}}
+      {{/defaultValue}}
+      end
+      {{/vars}}
+    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 = {{^parent}}Array.new{{/parent}}{{#parent}}super{{/parent}}
+      {{#vars}}
+      {{^isNullable}}
+      {{#required}}
+      {{/required}}
+      {{/isNullable}}
+      {{#hasValidation}}
+      {{#maxLength}}
+      {{/maxLength}}
+      {{#minLength}}
+      {{/minLength}}
+      {{#maximum}}
+      {{/maximum}}
+      {{#minimum}}
+      {{/minimum}}
+      {{#pattern}}
+      {{/pattern}}
+      {{#maxItems}}
+      {{/maxItems}}
+      {{#minItems}}
+      {{/minItems}}
+      {{/hasValidation}}
+      {{/vars}}
+      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?
+      {{#vars}}
+      {{^isNullable}}
+      {{#required}}
+      return false if @{{{name}}}.nil?
+      {{/required}}
+      {{/isNullable}}
+      {{#isEnum}}
+      {{^isContainer}}
+      {{{name}}}_validator = EnumAttributeValidator.new('{{{dataType}}}', [{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}])
+      return false unless {{{name}}}_validator.valid?(@{{{name}}})
+      {{/isContainer}}
+      {{/isEnum}}
+      {{#hasValidation}}
+      {{#maxLength}}
+      return false if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}}.to_s.length > {{{maxLength}}}
+      {{/maxLength}}
+      {{#minLength}}
+      return false if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}}.to_s.length < {{{minLength}}}
+      {{/minLength}}
+      {{#maximum}}
+      return false if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}} >{{#exclusiveMaximum}}={{/exclusiveMaximum}} {{{maximum}}}
+      {{/maximum}}
+      {{#minimum}}
+      return false if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}} <{{#exclusiveMinimum}}={{/exclusiveMinimum}} {{{minimum}}}
+      {{/minimum}}
+      {{#pattern}}
+      return false if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}} !~ Regexp.new({{{pattern}}})
+      {{/pattern}}
+      {{#maxItems}}
+      return false if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}}.length > {{{maxItems}}}
+      {{/maxItems}}
+      {{#minItems}}
+      return false if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}}.length < {{{minItems}}}
+      {{/minItems}}
+      {{/hasValidation}}
+      {{/vars}}
+      {{#anyOf}}
+      {{#-first}}
+      _any_of_found = false
+      self.class.openapi_any_of.each do |_class|
+        _any_of = {{moduleName}}.const_get(_class).build_from_hash(self.to_hash)
+        if _any_of.valid?
+          _any_of_found = true
+        end
+      end
+
+      if !_any_of_found
+        return false
+      end
+
+      {{/-first}}
+      {{/anyOf}}
+      true{{#parent}} && super{{/parent}}
+    end
+
+    {{#vars}}
+    {{#isEnum}}
+    {{^isContainer}}
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] {{{name}}} Object to be assigned
+    def {{{name}}}=({{{name}}})
+      @{{{name}}} = {{{name}}}
+    end
+
+    {{/isContainer}}
+    {{/isEnum}}
+    {{^isEnum}}
+    {{#hasValidation}}
+    # Custom attribute writer method with validation
+    # @param [Object] {{{name}}} Value to be assigned
+    def {{{name}}}=({{{name}}})
+      {{^isNullable}}
+      {{#required}}
+      if {{{name}}}.nil?
+        fail ArgumentError, '{{{name}}} cannot be nil'
+      end
+
+      {{/required}}
+      {{/isNullable}}
+      {{#maxLength}}
+      {{/maxLength}}
+      {{#minLength}}
+      {{/minLength}}
+      {{#maximum}}
+      {{/maximum}}
+      {{#minimum}}
+      {{/minimum}}
+      {{#pattern}}
+      {{/pattern}}
+      {{#maxItems}}
+      {{/maxItems}}
+      {{#minItems}}
+      {{/minItems}}
+      @{{{name}}} = {{{name}}}
+    end
+
+    {{/hasValidation}}
+    {{/isEnum}}
+    {{/vars}}
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class{{#vars}} &&
+          {{name}} == o.{{name}}{{/vars}}{{#parent}} && super(o){{/parent}}
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [{{#vars}}{{name}}{{^-last}}, {{/-last}}{{/vars}}].hash
+    end
+
+{{> base_object}}
+  end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ynab
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.1.0
 platform: ruby
 authors:
 - YNAB
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-31 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -353,10 +353,12 @@ files:
 - spec/fixtures/vcr_cassettes/update_transaction.yml
 - spec/fixtures/vcr_cassettes/update_transactions.yml
 - spec/spec_helper.rb
+- templates/api.mustache
 - templates/api_client.mustache
 - templates/api_client_typhoeus_partial.mustache
 - templates/api_doc.mustache
 - templates/gem.mustache
+- templates/partial_model_generic.mustache
 - templates/partial_model_generic_doc.mustache
 - ynab.gemspec
 homepage: https://github.com/ynab/ynab-sdk-ruby
@@ -374,9 +376,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: