patch_ruby 1.20.0 → 1.21.0

data/lib/patch_ruby/models/order_inventory_project.rb

@@ -0,0 +1,249 @@
+=begin
+#Patch API V1
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: v1
+Contact: engineering@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.3.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Patch
+  class OrderInventoryProject
+    # The unique uid for a project. UIDs will be prepended by pro_prod or pro_test depending on the mode it was created in.
+    attr_accessor :id
+
+    # The name of the project.
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::OrderInventoryProjectsApi::OPERATIONS') && Patch::OrderInventoryProjectsApi::OPERATIONS.include?(message)
+        Patch::OrderInventoryProjectsApi.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::OrderInventoryProject` 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::OrderInventoryProject`. 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?(:'name')
+        self.name = attributes[:'name']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name 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 @id.nil?
+      return false if @name.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 &&
+          id == o.id &&
+          name == o.name
+    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
+      [id, name].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/project.rb

@@ -51,10 +51,10 @@ module Patch
     # 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.
+    # DEPRECATED. 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.
+    # DEPRECATED. The remaining mass in grams available for purchase for this project.
     attr_accessor :remaining_mass_g
 
     # The name of the project verifier, when applicable. A verifier is the organization that verifies the calculations of the actual amount of greenhouse gas emissions that have been avoided or sequestered through implementation of the project.
@@ -71,9 +71,12 @@ module Patch
 
     attr_accessor :technology_type
 
-    # An array of objects containing the highlight's slug, title, and a URL for the corresponding icon.  A highlight's title is a short string that spotlights a characteristic about the project.
+    # An array of objects containing the highlight's slug, title, and a URL for the corresponding icon. A highlight's title is a short string that spotlights a characteristic about the project.
     attr_accessor :highlights
 
+    # 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
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -118,7 +121,8 @@ module Patch
         :'sdgs' => :'sdgs',
         :'tagline' => :'tagline',
         :'technology_type' => :'technology_type',
-        :'highlights' => :'highlights'
+        :'highlights' => :'highlights',
+        :'inventory' => :'inventory'
       }
     end
 
@@ -149,7 +153,8 @@ module Patch
         :'sdgs' => :'Array<Sdg>',
         :'tagline' => :'String',
         :'technology_type' => :'TechnologyType',
-        :'highlights' => :'Array<Highlight>'
+        :'highlights' => :'Array<Highlight>',
+        :'inventory' => :'Array<Inventory>'
       }
     end
 
@@ -280,6 +285,12 @@ module Patch
           self.highlights = value
         end
       end
+
+      if attributes.key?(:'inventory')
+        if (value = attributes[:'inventory']).is_a?(Array)
+          self.inventory = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -326,6 +337,10 @@ module Patch
         invalid_properties.push('invalid value for "highlights", highlights cannot be nil.')
       end
 
+      if @inventory.nil?
+        invalid_properties.push('invalid value for "inventory", inventory cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -344,6 +359,7 @@ module Patch
       return false if @remaining_mass_g.nil?
       return false if @technology_type.nil?
       return false if @highlights.nil?
+      return false if @inventory.nil?
       true
     end
 
@@ -381,7 +397,8 @@ module Patch
           sdgs == o.sdgs &&
           tagline == o.tagline &&
           technology_type == o.technology_type &&
-          highlights == o.highlights
+          highlights == o.highlights &&
+          inventory == o.inventory
     end
 
     # @see the `==` method
@@ -393,7 +410,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, production, name, description, type, mechanism, country, state, latitude, longitude, developer, photos, average_price_per_tonne_cents_usd, remaining_mass_g, verifier, standard, sdgs, tagline, technology_type, highlights].hash
+      [id, production, name, description, type, mechanism, country, state, latitude, longitude, developer, photos, average_price_per_tonne_cents_usd, remaining_mass_g, verifier, standard, sdgs, tagline, technology_type, highlights, inventory].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.3.1
 =end
 
 module Patch
-  VERSION = '1.20.0'
+  VERSION = '1.21.0'
 end

data/lib/patch_ruby.rb

@@ -32,8 +32,11 @@ require 'patch_ruby/models/estimate'
 require 'patch_ruby/models/estimate_list_response'
 require 'patch_ruby/models/estimate_response'
 require 'patch_ruby/models/highlight'
+require 'patch_ruby/models/inventory'
 require 'patch_ruby/models/meta_index_object'
 require 'patch_ruby/models/order'
+require 'patch_ruby/models/order_inventory'
+require 'patch_ruby/models/order_inventory_project'
 require 'patch_ruby/models/order_list_response'
 require 'patch_ruby/models/order_response'
 require 'patch_ruby/models/parent_technology_type'

data/spec/integration/estimates_spec.rb

@@ -27,7 +27,7 @@ RSpec.describe 'Estimates Integration' do
     )
 
     expect(flight_estimate.data.type).to eq 'flight'
-    expect(flight_estimate.data.mass_g).to eq 1_000_622
+    expect(flight_estimate.data.mass_g).to be >= 1_000_000
   end
 
   it 'supports creating flight estimates with origin and destination' do
@@ -60,8 +60,8 @@ RSpec.describe 'Estimates Integration' do
     )
 
     expect(vehicle_estimate.data.type).to eq 'vehicle'
-    expect(vehicle_estimate.data.mass_g).to eq 5_500
-    expect(vehicle_estimate.data.order.mass_g).to eq 5_500
+    expect(vehicle_estimate.data.mass_g).to be >= 1_000
+    expect(vehicle_estimate.data.order.amount).to be >= 1_000
   end
 
   it 'supports creating vehicle estimates with partial information' do

data/spec/integration/orders_spec.rb

@@ -116,4 +116,32 @@ RSpec.describe 'Orders Integration' do
     expect(create_order_response.data.id).not_to be_nil
     expect(create_order_response.data.mass_g).to eq(100)
   end
+
+  it 'supports create with an amount and unit' do
+    create_order_response =
+      Patch::Order.create_order(amount: 100, unit: "g")
+
+    expect(create_order_response.success).to eq true
+    expect(create_order_response.data.id).not_to be_nil
+    expect(create_order_response.data.amount).to eq(100)
+    expect(create_order_response.data.unit).to eq("g")
+    expect(create_order_response.data.inventory[0]).to be_an_instance_of(
+      Patch::OrderInventory
+    )
+    expect(create_order_response.data.inventory[0].project).to be_an_instance_of(
+      Patch::OrderInventoryProject
+    )
+    expect(create_order_response.data.inventory[0].unit).to eq("g")
+  end
+
+  it 'supports create with a total price and currency' do
+    create_order_response =
+      Patch::Order.create_order(total_price: 100, currency: "EUR")
+
+    expect(create_order_response.success).to eq true
+    expect(create_order_response.data.id).not_to be_nil
+    expect(create_order_response.data.price + create_order_response.data.patch_fee
+    ).to be_within(1).of(100)
+    expect(create_order_response.data.currency).to eq "EUR"
+  end
 end

data/spec/integration/projects_spec.rb

@@ -63,6 +63,15 @@ RSpec.describe 'Projects Integration' do
       expect(parent_type.slug).to be_an_instance_of(String)
 
       expect(project.highlights).to be_an_instance_of(Array)
+
+      inventory = project.inventory
+      expect(inventory).to be_an_instance_of(Array)
+      expect(inventory[0]).to be_an_instance_of(Patch::Inventory)
+      expect(inventory[0].vintage_year).to be_an_instance_of(Integer)
+      expect(inventory[0].amount_available).to be_an_instance_of(Integer)
+      expect(inventory[0].price).to be_an_instance_of(Integer)
+      expect(inventory[0].currency).to be_an_instance_of(String)
+      expect(inventory[0].unit).to be_an_instance_of(String)
     end
   end
 end

data/spec/models/create_order_request_spec.rb

@@ -31,7 +31,7 @@ describe 'CreateOrderRequest' do
     let(:instance) { @instance }
     let(:instance_hash) { { project_id: @instance.project_id, mass_g: @instance.mass_g, total_price_cents_usd: @instance.total_price_cents_usd, metadata: @instance.metadata } }
     let(:nullable_properties) do
-      Set.new(%i[mass_g total_price_cents_usd project_id metadata state vintage_year])
+      Set.new(%i[mass_g total_price_cents_usd project_id metadata state vintage_year total_price currency amount unit])
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patch_ruby
 version: !ruby/object:Gem::Version
-  version: 1.20.0
+  version: 1.21.0
 platform: ruby
 authors:
 - Patch Technology
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-18 00:00:00.000000000 Z
+date: 2022-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -115,8 +115,11 @@ files:
 - lib/patch_ruby/models/estimate_list_response.rb
 - lib/patch_ruby/models/estimate_response.rb
 - lib/patch_ruby/models/highlight.rb
+- lib/patch_ruby/models/inventory.rb
 - lib/patch_ruby/models/meta_index_object.rb
 - lib/patch_ruby/models/order.rb
+- lib/patch_ruby/models/order_inventory.rb
+- lib/patch_ruby/models/order_inventory_project.rb
 - lib/patch_ruby/models/order_list_response.rb
 - lib/patch_ruby/models/order_response.rb
 - lib/patch_ruby/models/parent_technology_type.rb
@@ -201,46 +204,46 @@ summary: Ruby wrapper for the Patch API
 test_files:
 - spec/api/technology_types_api_spec.rb
 - spec/api/orders_api_spec.rb
-- spec/api/estimates_api_spec.rb
 - spec/api/projects_api_spec.rb
+- spec/api/estimates_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
 - spec/constants.rb
-- spec/factories/allocations.rb
-- spec/factories/create_mass_estimate_requests.rb
-- spec/factories/meta_index_objects.rb
-- spec/factories/estimate_list_responses.rb
-- spec/factories/order_list_responses.rb
-- spec/factories/parent_technology_type.rb
 - spec/factories/create_order_requests.rb
+- spec/factories/estimate_list_responses.rb
 - spec/factories/sdgs.rb
-- spec/factories/order_responses.rb
-- spec/factories/orders.rb
-- spec/factories/technology_type.rb
+- spec/factories/allocations.rb
+- spec/factories/parent_technology_type.rb
 - spec/factories/project_responses.rb
-- spec/factories/estimate_responses.rb
+- spec/factories/order_responses.rb
 - spec/factories/project_list_responses.rb
+- spec/factories/estimates.rb
+- spec/factories/technology_type.rb
 - spec/factories/error_responses.rb
+- spec/factories/orders.rb
+- spec/factories/meta_index_objects.rb
 - spec/factories/projects.rb
-- spec/factories/estimates.rb
-- spec/integration/estimates_spec.rb
-- spec/integration/projects/technology_types_spec.rb
+- spec/factories/create_mass_estimate_requests.rb
+- spec/factories/order_list_responses.rb
+- spec/factories/estimate_responses.rb
 - spec/integration/projects_spec.rb
+- spec/integration/projects/technology_types_spec.rb
+- spec/integration/estimates_spec.rb
 - spec/integration/orders_spec.rb
-- spec/models/project_response_spec.rb
-- spec/models/project_list_response_spec.rb
-- spec/models/create_order_request_spec.rb
-- spec/models/estimate_list_response_spec.rb
 - spec/models/estimate_spec.rb
+- spec/models/create_mass_estimate_request_spec.rb
+- spec/models/estimate_list_response_spec.rb
+- spec/models/meta_index_object_spec.rb
+- spec/models/estimate_response_spec.rb
+- spec/models/project_response_spec.rb
 - spec/models/project_spec.rb
-- spec/models/order_response_spec.rb
+- spec/models/order_spec.rb
+- spec/models/project_list_response_spec.rb
 - spec/models/allocation_spec.rb
-- spec/models/meta_index_object_spec.rb
 - spec/models/error_response_spec.rb
-- spec/models/estimate_response_spec.rb
-- spec/models/create_mass_estimate_request_spec.rb
+- spec/models/order_response_spec.rb
+- spec/models/create_order_request_spec.rb
 - spec/models/order_list_response_spec.rb
-- spec/models/order_spec.rb
 - spec/patch_ruby_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared/generated_classes.rb