patch_ruby 1.2.4 → 1.5.1

data/lib/patch_ruby/models/preference.rb

@@ -14,10 +14,13 @@ require 'date'
 
 module Patch
   class Preference
+    # A unique uid for the record. UIDs will be prepended by pre_prod or pre_test depending on the mode it was created in.
     attr_accessor :id
 
+    # Percentage of total purchased offsets that should go to a project. Default is 100%.
     attr_accessor :allocation_percentage
 
+    # An object returning the Project record this Preference is associated with. See the [Project section](/?id=projects) for the full schema.
     attr_accessor :project
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -38,6 +41,13 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties
+    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

data/lib/patch_ruby/models/preference_list_response.rb

@@ -42,6 +42,15 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("error")
+
+      nullable_properties
+    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

data/lib/patch_ruby/models/preference_response.rb

@@ -38,6 +38,15 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("error")
+
+      nullable_properties
+    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

data/lib/patch_ruby/models/project.rb

@@ -14,28 +14,42 @@ require 'date'
 
 module Patch
   class Project
+    # A unique uid for the record. UIDs will be prepended by pro_prod or pro_test depending on the mode it was created in.
     attr_accessor :id
 
+    # A boolean indicating if this project is a production or test mode project.
     attr_accessor :production
 
+    # The name of the project.
     attr_accessor :name
 
+    # The description of the project.
     attr_accessor :description
 
+    # The type of carbon removal project, currently available project types are Biomass, Dac, Forestry, Mineralization, Ocean, Soil.
     attr_accessor :type
 
+    # The country of origin of the project.
     attr_accessor :country
 
+    # The name of the project developer.
     attr_accessor :developer
 
+    # An array of URLs for photos of the project.
     attr_accessor :photos
 
+    # The average price per tonne in USD cents for carbon offsets supplied by this project.
     attr_accessor :average_price_per_tonne_cents_usd
 
+    # The remaining mass in grams available for purchase for this project.
     attr_accessor :remaining_mass_g
 
+    # An object returning the Standard associated with this project.
     attr_accessor :standard
 
+    # An array returning the UN Sustainable Development Goals associated with this project.
+    attr_accessor :sdgs
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -71,7 +85,8 @@ module Patch
         :'photos' => :'photos',
         :'average_price_per_tonne_cents_usd' => :'average_price_per_tonne_cents_usd',
         :'remaining_mass_g' => :'remaining_mass_g',
-        :'standard' => :'standard'
+        :'standard' => :'standard',
+        :'sdgs' => :'sdgs'
       }
     end
 
@@ -88,10 +103,24 @@ module Patch
         :'photos' => :'Array<Photo>',
         :'average_price_per_tonne_cents_usd' => :'Integer',
         :'remaining_mass_g' => :'Integer',
-        :'standard' => :'Standard'
+        :'standard' => :'Standard',
+        :'sdgs' => :'Array<Sdg>'
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("photos")
+
+      nullable_properties.add("standard")
+
+      nullable_properties.add("sdgs")
+
+      nullable_properties
+    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
@@ -163,6 +192,12 @@ module Patch
       if attributes.key?(:'standard')
         self.standard = attributes[:'standard']
       end
+
+      if attributes.key?(:'sdgs')
+        if (value = attributes[:'sdgs']).is_a?(Array)
+          self.sdgs = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -245,7 +280,8 @@ module Patch
           photos == o.photos &&
           average_price_per_tonne_cents_usd == o.average_price_per_tonne_cents_usd &&
           remaining_mass_g == o.remaining_mass_g &&
-          standard == o.standard
+          standard == o.standard &&
+          sdgs == o.sdgs
     end
 
     # @see the `==` method
@@ -257,7 +293,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, production, name, description, type, country, developer, photos, average_price_per_tonne_cents_usd, remaining_mass_g, standard].hash
+      [id, production, name, description, type, country, developer, photos, average_price_per_tonne_cents_usd, remaining_mass_g, standard, sdgs].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/project_list_response.rb

@@ -42,6 +42,15 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("error")
+
+      nullable_properties
+    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

data/lib/patch_ruby/models/project_response.rb

@@ -38,6 +38,15 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("error")
+
+      nullable_properties
+    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

data/lib/patch_ruby/models/sdg.rb

@@ -0,0 +1,269 @@
+=begin
+#Patch API V1
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: v1
+Contact: developers@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module Patch
+  class Sdg
+    # The title of the Sustainable Development Goal.
+    attr_accessor :title
+
+    # The Sustainable Development Goal number.
+    attr_accessor :number
+
+    # The description of the Sustainable Development Goal.
+    attr_accessor :description
+
+    # The url to an information page for the Sustainable Development Goal.
+    attr_accessor :url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'title' => :'title',
+        :'number' => :'number',
+        :'description' => :'description',
+        :'url' => :'url'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'title' => :'String',
+        :'number' => :'Integer',
+        :'description' => :'String',
+        :'url' => :'String'
+      }
+    end
+
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties
+    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::SdgsApi::OPERATIONS') && Patch::SdgsApi::OPERATIONS.include?(message)
+        Patch::SdgsApi.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::Sdg` 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::Sdg`. 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?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'number')
+        self.number = attributes[:'number']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      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 @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @number.nil?
+        invalid_properties.push('invalid value for "number", number cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url 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 @title.nil?
+      return false if @number.nil?
+      return false if @description.nil?
+      return false if @url.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 &&
+          title == o.title &&
+          number == o.number &&
+          description == o.description &&
+          url == o.url
+    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
+      [title, number, description, url].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 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 # 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
+        Patch.const_get(type).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