patch_ruby 2.0.0 → 2.1.1

data/lib/patch_ruby/models/disclaimer.rb

@@ -0,0 +1,282 @@
+=begin
+#Patch API V2
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: 2
+Contact: engineering@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.3.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Patch
+  class Disclaimer
+    # The body of the disclaimer.
+    attr_accessor :body
+
+    # The header for the disclaimer.
+    attr_accessor :header
+
+    # The severity of the disclaimer.
+    attr_accessor :severity
+
+    # The text for the provided link.
+    attr_accessor :link_text
+
+    # The destination of the provided link.
+    attr_accessor :link_destination
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'body' => :'body',
+        :'header' => :'header',
+        :'severity' => :'severity',
+        :'link_text' => :'link_text',
+        :'link_destination' => :'link_destination'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'body' => :'String',
+        :'header' => :'String',
+        :'severity' => :'String',
+        :'link_text' => :'String',
+        :'link_destination' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'body',
+        :'link_text',
+        :'link_destination'
+      ])
+    end
+
+
+    # Allows models with corresponding API classes to delegate API operations to those API classes
+    # Exposes Model.operation_id which delegates to ModelsApi.new.operation_id
+    # Eg. Order.create_order delegates to OrdersApi.new.create_order
+    def self.method_missing(message, *args, &block)
+      if Object.const_defined?('Patch::DisclaimersApi::OPERATIONS') && Patch::DisclaimersApi::OPERATIONS.include?(message)
+        Patch::DisclaimersApi.new.send(message, *args)
+      else
+        super
+      end
+    end
+
+    # 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 `Patch::Disclaimer` 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 `Patch::Disclaimer`. 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
+      }
+
+      if attributes.key?(:'body')
+        self.body = attributes[:'body']
+      end
+
+      if attributes.key?(:'header')
+        self.header = attributes[:'header']
+      end
+
+      if attributes.key?(:'severity')
+        self.severity = attributes[:'severity']
+      end
+
+      if attributes.key?(:'link_text')
+        self.link_text = attributes[:'link_text']
+      end
+
+      if attributes.key?(:'link_destination')
+        self.link_destination = attributes[:'link_destination']
+      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 @header.nil?
+        invalid_properties.push('invalid value for "header", header cannot be nil.')
+      end
+
+      if @severity.nil?
+        invalid_properties.push('invalid value for "severity", severity cannot be nil.')
+      end
+
+      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 @header.nil?
+      return false if @severity.nil?
+      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 &&
+          body == o.body &&
+          header == o.header &&
+          severity == o.severity &&
+          link_text == o.link_text &&
+          link_destination == o.link_destination
+    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
+      [body, header, severity, link_text, link_destination].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = Patch.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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/patch_ruby/models/inventory.rb

@@ -18,6 +18,12 @@ module Patch
     # The year in which the climate impacts of the project occurred, or will occur.
     attr_accessor :vintage_year
 
+    # The starting year in which the climate impacts of the project occurred, or will occur.
+    attr_accessor :vintage_start_year
+
+    # The ending year in which the climate impacts of the project occurred, or will occur.
+    attr_accessor :vintage_end_year
+
     # The amount available for this vintage year.
     attr_accessor :amount_available
 
@@ -34,6 +40,8 @@ module Patch
     def self.attribute_map
       {
         :'vintage_year' => :'vintage_year',
+        :'vintage_start_year' => :'vintage_start_year',
+        :'vintage_end_year' => :'vintage_end_year',
         :'amount_available' => :'amount_available',
         :'price' => :'price',
         :'currency' => :'currency',
@@ -50,6 +58,8 @@ module Patch
     def self.openapi_types
       {
         :'vintage_year' => :'Integer',
+        :'vintage_start_year' => :'Integer',
+        :'vintage_end_year' => :'Integer',
         :'amount_available' => :'Integer',
         :'price' => :'Integer',
         :'currency' => :'String',
@@ -94,6 +104,14 @@ module Patch
         self.vintage_year = attributes[:'vintage_year']
       end
 
+      if attributes.key?(:'vintage_start_year')
+        self.vintage_start_year = attributes[:'vintage_start_year']
+      end
+
+      if attributes.key?(:'vintage_end_year')
+        self.vintage_end_year = attributes[:'vintage_end_year']
+      end
+
       if attributes.key?(:'amount_available')
         self.amount_available = attributes[:'amount_available']
       end
@@ -119,6 +137,14 @@ module Patch
         invalid_properties.push('invalid value for "vintage_year", vintage_year cannot be nil.')
       end
 
+      if @vintage_start_year.nil?
+        invalid_properties.push('invalid value for "vintage_start_year", vintage_start_year cannot be nil.')
+      end
+
+      if @vintage_end_year.nil?
+        invalid_properties.push('invalid value for "vintage_end_year", vintage_end_year cannot be nil.')
+      end
+
       if @amount_available.nil?
         invalid_properties.push('invalid value for "amount_available", amount_available cannot be nil.')
       end
@@ -142,6 +168,8 @@ module Patch
     # @return true if the model is valid
     def valid?
       return false if @vintage_year.nil?
+      return false if @vintage_start_year.nil?
+      return false if @vintage_end_year.nil?
       return false if @amount_available.nil?
       return false if @price.nil?
       return false if @currency.nil?
@@ -155,6 +183,8 @@ module Patch
       return true if self.equal?(o)
       self.class == o.class &&
           vintage_year == o.vintage_year &&
+          vintage_start_year == o.vintage_start_year &&
+          vintage_end_year == o.vintage_end_year &&
           amount_available == o.amount_available &&
           price == o.price &&
           currency == o.currency &&
@@ -170,7 +200,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [vintage_year, amount_available, price, currency, unit].hash
+      [vintage_year, vintage_start_year, vintage_end_year, amount_available, price, currency, unit].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/order.rb

@@ -42,7 +42,7 @@ module Patch
     # The currency code for the `price` and `patch_fee`.
     attr_accessor :currency
 
-    # The url of this order in the public registry.
+    # The URL of this order in the public registry. Use this URL to access the order's accompanying certificate.
     attr_accessor :registry_url
 
     # An optional JSON object containing metadata for this order.
@@ -230,8 +230,8 @@ module Patch
         invalid_properties.push('invalid value for "amount", amount cannot be nil.')
       end
 
-      if @amount > 100000000000
-        invalid_properties.push('invalid value for "amount", must be smaller than or equal to 100000000000.')
+      if @amount > 100000000000000
+        invalid_properties.push('invalid value for "amount", must be smaller than or equal to 100000000000000.')
       end
 
       if @amount < 0
@@ -270,7 +270,7 @@ module Patch
       state_validator = EnumAttributeValidator.new('String', ["draft", "reserved", "placed", "processing", "complete", "cancelled"])
       return false unless state_validator.valid?(@state)
       return false if @amount.nil?
-      return false if @amount > 100000000000
+      return false if @amount > 100000000000000
       return false if @amount < 0
       return false if @unit.nil?
       return false if @price.nil?
@@ -297,8 +297,8 @@ module Patch
         fail ArgumentError, 'amount cannot be nil'
       end
 
-      if amount > 100000000000
-        fail ArgumentError, 'invalid value for "amount", must be smaller than or equal to 100000000000.'
+      if amount > 100000000000000
+        fail ArgumentError, 'invalid value for "amount", must be smaller than or equal to 100000000000000.'
       end
 
       if amount < 0

data/lib/patch_ruby/models/order_line_item.rb

@@ -24,6 +24,12 @@ module Patch
     # The year in which the climate impacts of the project occurred, or will occur.
     attr_accessor :vintage_year
 
+    # The starting year in which the climate impacts of the project occurred, or will occur.
+    attr_accessor :vintage_start_year
+
+    # The ending year in which the climate impacts of the project occurred, or will occur.
+    attr_accessor :vintage_end_year
+
     # The amount ordered for the given project and vintage year.
     attr_accessor :amount
 
@@ -42,6 +48,8 @@ module Patch
         :'id' => :'id',
         :'project' => :'project',
         :'vintage_year' => :'vintage_year',
+        :'vintage_start_year' => :'vintage_start_year',
+        :'vintage_end_year' => :'vintage_end_year',
         :'amount' => :'amount',
         :'unit' => :'unit',
         :'price' => :'price',
@@ -60,6 +68,8 @@ module Patch
         :'id' => :'String',
         :'project' => :'OrderLineItemProject',
         :'vintage_year' => :'Integer',
+        :'vintage_start_year' => :'Integer',
+        :'vintage_end_year' => :'Integer',
         :'amount' => :'Integer',
         :'unit' => :'String',
         :'price' => :'Integer',
@@ -115,6 +125,14 @@ module Patch
         self.vintage_year = attributes[:'vintage_year']
       end
 
+      if attributes.key?(:'vintage_start_year')
+        self.vintage_start_year = attributes[:'vintage_start_year']
+      end
+
+      if attributes.key?(:'vintage_end_year')
+        self.vintage_end_year = attributes[:'vintage_end_year']
+      end
+
       if attributes.key?(:'amount')
         self.amount = attributes[:'amount']
       end
@@ -144,6 +162,14 @@ module Patch
         invalid_properties.push('invalid value for "vintage_year", vintage_year cannot be nil.')
       end
 
+      if @vintage_start_year.nil?
+        invalid_properties.push('invalid value for "vintage_start_year", vintage_start_year cannot be nil.')
+      end
+
+      if @vintage_end_year.nil?
+        invalid_properties.push('invalid value for "vintage_end_year", vintage_end_year cannot be nil.')
+      end
+
       if @amount.nil?
         invalid_properties.push('invalid value for "amount", amount cannot be nil.')
       end
@@ -168,6 +194,8 @@ module Patch
     def valid?
       return false if @project.nil?
       return false if @vintage_year.nil?
+      return false if @vintage_start_year.nil?
+      return false if @vintage_end_year.nil?
       return false if @amount.nil?
       return false if @unit.nil?
       return false if @price.nil?
@@ -183,6 +211,8 @@ module Patch
           id == o.id &&
           project == o.project &&
           vintage_year == o.vintage_year &&
+          vintage_start_year == o.vintage_start_year &&
+          vintage_end_year == o.vintage_end_year &&
           amount == o.amount &&
           unit == o.unit &&
           price == o.price &&
@@ -198,7 +228,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, project, vintage_year, amount, unit, price, currency].hash
+      [id, project, vintage_year, vintage_start_year, vintage_end_year, amount, unit, price, currency].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/project.rb

@@ -36,6 +36,9 @@ module Patch
     # The state where this project is located.
     attr_accessor :state
 
+    # The issuance type of the project. One of: ex-ante, ex-post.
+    attr_accessor :issuance_type
+
     # The latitude at which this project is located.
     attr_accessor :latitude
 
@@ -68,6 +71,31 @@ module Patch
     # An array of objects containing available inventory for a project. Available inventory is grouped by a project's vintage year and returns amount and pricing available for a given vintage year.
     attr_accessor :inventory
 
+    # An array of objects containing disclaimers about the project. Information, warnings, and critical concerns may be present.
+    attr_accessor :disclaimers
+
+    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
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -78,6 +106,7 @@ module Patch
         :'mechanism' => :'mechanism',
         :'country' => :'country',
         :'state' => :'state',
+        :'issuance_type' => :'issuance_type',
         :'latitude' => :'latitude',
         :'longitude' => :'longitude',
         :'project_partner' => :'project_partner',
@@ -88,7 +117,8 @@ module Patch
         :'tagline' => :'tagline',
         :'technology_type' => :'technology_type',
         :'highlights' => :'highlights',
-        :'inventory' => :'inventory'
+        :'inventory' => :'inventory',
+        :'disclaimers' => :'disclaimers'
       }
     end
 
@@ -107,6 +137,7 @@ module Patch
         :'mechanism' => :'String',
         :'country' => :'String',
         :'state' => :'String',
+        :'issuance_type' => :'String',
         :'latitude' => :'Float',
         :'longitude' => :'Float',
         :'project_partner' => :'String',
@@ -117,7 +148,8 @@ module Patch
         :'tagline' => :'String',
         :'technology_type' => :'TechnologyType',
         :'highlights' => :'Array<Highlight>',
-        :'inventory' => :'Array<Inventory>'
+        :'inventory' => :'Array<Inventory>',
+        :'disclaimers' => :'Array<Disclaimer>'
       }
     end
 
@@ -188,6 +220,10 @@ module Patch
         self.state = attributes[:'state']
       end
 
+      if attributes.key?(:'issuance_type')
+        self.issuance_type = attributes[:'issuance_type']
+      end
+
       if attributes.key?(:'latitude')
         self.latitude = attributes[:'latitude']
       end
@@ -242,6 +278,12 @@ module Patch
           self.inventory = value
         end
       end
+
+      if attributes.key?(:'disclaimers')
+        if (value = attributes[:'disclaimers']).is_a?(Array)
+          self.disclaimers = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -295,6 +337,8 @@ module Patch
       return false if @name.nil?
       return false if @description.nil?
       return false if @country.nil?
+      issuance_type_validator = EnumAttributeValidator.new('String', ["ex-ante", "ex-post"])
+      return false unless issuance_type_validator.valid?(@issuance_type)
       return false if @project_partner.nil?
       return false if @technology_type.nil?
       return false if @highlights.nil?
@@ -302,6 +346,16 @@ module Patch
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] issuance_type Object to be assigned
+    def issuance_type=(issuance_type)
+      validator = EnumAttributeValidator.new('String', ["ex-ante", "ex-post"])
+      unless validator.valid?(issuance_type)
+        fail ArgumentError, "invalid value for \"issuance_type\", must be one of #{validator.allowable_values}."
+      end
+      @issuance_type = issuance_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -314,6 +368,7 @@ module Patch
           mechanism == o.mechanism &&
           country == o.country &&
           state == o.state &&
+          issuance_type == o.issuance_type &&
           latitude == o.latitude &&
           longitude == o.longitude &&
           project_partner == o.project_partner &&
@@ -324,7 +379,8 @@ module Patch
           tagline == o.tagline &&
           technology_type == o.technology_type &&
           highlights == o.highlights &&
-          inventory == o.inventory
+          inventory == o.inventory &&
+          disclaimers == o.disclaimers
     end
 
     # @see the `==` method
@@ -336,7 +392,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, production, name, description, mechanism, country, state, latitude, longitude, project_partner, photos, verifier, standard, sdgs, tagline, technology_type, highlights, inventory].hash
+      [id, production, name, description, mechanism, country, state, issuance_type, latitude, longitude, project_partner, photos, verifier, standard, sdgs, tagline, technology_type, highlights, inventory, disclaimers].hash
     end
 
     # Builds the object from hash