class Patch::Project
Attributes
The average price per tonne in USD cents for carbon offsets supplied by this project.
The country of origin of the project.
The description of the project.
The name of the project developer.
A unique uid for the record. UIDs will be prepended by pro_prod or pro_test depending on the mode it was created in.
The name of the project.
An array of URLs for photos of the project.
A boolean indicating if this project is a production or test mode project.
The remaining mass in grams available for purchase for this project.
An array returning the UN Sustainable Development Goals associated with this project.
An object returning the Standard
associated with this project.
The type of carbon removal project, currently available project types are Biomass, Dac, Forestry, Mineralization, Ocean, Renewables, Soil.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/patch_ruby/models/project.rb, line 95 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/patch_ruby/models/project.rb, line 77 def self.attribute_map { :'id' => :'id', :'production' => :'production', :'name' => :'name', :'description' => :'description', :'type' => :'type', :'country' => :'country', :'developer' => :'developer', :'photos' => :'photos', :'average_price_per_tonne_cents_usd' => :'average_price_per_tonne_cents_usd', :'remaining_mass_g' => :'remaining_mass_g', :'standard' => :'standard', :'sdgs' => :'sdgs' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/patch_ruby/models/project.rb, line 305 def self.build_from_hash(attributes) new.build_from_hash(attributes) 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
# File lib/patch_ruby/models/project.rb, line 130 def self.method_missing(message, *args, &block) if Object.const_defined?('Patch::ProjectsApi::OPERATIONS') && Patch::ProjectsApi::OPERATIONS.include?(message) Patch::ProjectsApi.new.send(message, *args) else super end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/patch_ruby/models/project.rb, line 140 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Patch::Project` 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::Project`. 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?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'production') self.production = attributes[:'production'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'country') self.country = attributes[:'country'] end if attributes.key?(:'developer') self.developer = attributes[:'developer'] end if attributes.key?(:'photos') if (value = attributes[:'photos']).is_a?(Array) self.photos = value end end if attributes.key?(:'average_price_per_tonne_cents_usd') self.average_price_per_tonne_cents_usd = attributes[:'average_price_per_tonne_cents_usd'] end if attributes.key?(:'remaining_mass_g') self.remaining_mass_g = attributes[:'remaining_mass_g'] end 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
List of attributes with nullable: true
# File lib/patch_ruby/models/project.rb, line 118 def self.openapi_nullable Set.new([ :'photos', :'standard', :'sdgs' ]) end
Attribute type mapping.
# File lib/patch_ruby/models/project.rb, line 100 def self.openapi_types { :'id' => :'String', :'production' => :'Boolean', :'name' => :'String', :'description' => :'String', :'type' => :'String', :'country' => :'String', :'developer' => :'String', :'photos' => :'Array<Photo>', :'average_price_per_tonne_cents_usd' => :'Integer', :'remaining_mass_g' => :'Integer', :'standard' => :'Standard', :'sdgs' => :'Array<Sdg>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/patch_ruby/models/project.rb, line 273 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && production == o.production && name == o.name && description == o.description && type == o.type && country == o.country && developer == o.developer && 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 && sdgs == o.sdgs end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/patch_ruby/models/project.rb, line 335 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
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
# File lib/patch_ruby/models/project.rb, line 406 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/patch_ruby/models/project.rb, line 312 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
@see the `==` method @param [Object] Object to be compared
# File lib/patch_ruby/models/project.rb, line 292 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/patch_ruby/models/project.rb, line 298 def hash [id, production, name, description, type, country, developer, photos, average_price_per_tonne_cents_usd, remaining_mass_g, standard, sdgs].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/patch_ruby/models/project.rb, line 208 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @production.nil? invalid_properties.push('invalid value for "production", production cannot be nil.') end if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @description.nil? invalid_properties.push('invalid value for "description", description cannot be nil.') end if @country.nil? invalid_properties.push('invalid value for "country", country cannot be nil.') end if @developer.nil? invalid_properties.push('invalid value for "developer", developer cannot be nil.') end if @average_price_per_tonne_cents_usd.nil? invalid_properties.push('invalid value for "average_price_per_tonne_cents_usd", average_price_per_tonne_cents_usd cannot be nil.') end if @remaining_mass_g.nil? invalid_properties.push('invalid value for "remaining_mass_g", remaining_mass_g cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/patch_ruby/models/project.rb, line 388 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/patch_ruby/models/project.rb, line 376 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/patch_ruby/models/project.rb, line 263 def type=(type) validator = EnumAttributeValidator.new('String', ["biomass", "dac", "forestry", "mineralization", "ocean", "renewables", "soil"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @type = type end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/patch_ruby/models/project.rb, line 247 def valid? return false if @id.nil? return false if @production.nil? return false if @name.nil? return false if @description.nil? type_validator = EnumAttributeValidator.new('String', ["biomass", "dac", "forestry", "mineralization", "ocean", "renewables", "soil"]) return false unless type_validator.valid?(@type) return false if @country.nil? return false if @developer.nil? return false if @average_price_per_tonne_cents_usd.nil? return false if @remaining_mass_g.nil? true end