patch_ruby 1.14.0 → 1.16.0

data/lib/patch_ruby/models/order.rb

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 
@@ -30,7 +30,7 @@ module Patch
     # The current state of the order.
     attr_accessor :state
 
-    # The current state of the allocated carbon offsets of the order.
+    # DEPRECATED. Indicates if the order has been fully allocated to projects.
     attr_accessor :allocation_state
 
     # The total price in cents USD of the carbon offsets purchased through this order.
@@ -203,8 +203,8 @@ module Patch
         invalid_properties.push('invalid value for "mass_g", mass_g cannot be nil.')
       end
 
-      if @mass_g > 2000000000
-        invalid_properties.push('invalid value for "mass_g", must be smaller than or equal to 2000000000.')
+      if @mass_g > 100000000000
+        invalid_properties.push('invalid value for "mass_g", must be smaller than or equal to 100000000000.')
       end
 
       if @mass_g < 0
@@ -239,7 +239,7 @@ module Patch
     def valid?
       return false if @id.nil?
       return false if @mass_g.nil?
-      return false if @mass_g > 2000000000
+      return false if @mass_g > 100000000000
       return false if @mass_g < 0
       return false if @production.nil?
       return false if @state.nil?
@@ -260,8 +260,8 @@ module Patch
         fail ArgumentError, 'mass_g cannot be nil'
       end
 
-      if mass_g > 2000000000
-        fail ArgumentError, 'invalid value for "mass_g", must be smaller than or equal to 2000000000.'
+      if mass_g > 100000000000
+        fail ArgumentError, 'invalid value for "mass_g", must be smaller than or equal to 100000000000.'
       end
 
       if mass_g < 0

data/lib/patch_ruby/models/order_list_response.rb

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 

data/lib/patch_ruby/models/order_response.rb

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 

data/lib/patch_ruby/models/parent_technology_type.rb

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 
@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module Patch
+  # An object containing the parent technology type's name and slug.
   class ParentTechnologyType
     # Unique identifier for this type of technology.
     attr_accessor :slug

data/lib/patch_ruby/models/photo.rb

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 

data/lib/patch_ruby/models/project.rb

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 
@@ -27,10 +27,10 @@ module Patch
     # The description of the project.
     attr_accessor :description
 
-    # The type of carbon removal project, currently available project types are Biomass, Dac, Forestry, Mineralization, Ocean, Renewables, Soil.
+    # Deprecated. Favor the technology_type field instead.
     attr_accessor :type
 
-    # The mechanism of the project. removal or avoidance.
+    # The mechanism of the project. Either removal or avoidance.
     attr_accessor :mechanism
 
     # The country of origin of the project.
@@ -57,16 +57,22 @@ module Patch
     # 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.
+    # 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.
+    attr_accessor :verifier
+
+    # An object returning the Standard associated with this project, when applicable. Standards provide guidance on GHG quantification, monitoring, and reporting. Standards can include protocols/methodologies and guidance documents.
     attr_accessor :standard
 
     # An array returning the UN Sustainable Development Goals associated with this project.
     attr_accessor :sdgs
 
+    # A short description of the project.
+    attr_accessor :tagline
+
     attr_accessor :technology_type
 
-    # A short description of the project
-    attr_accessor :tagline
+    # 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
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -107,10 +113,12 @@ module Patch
         :'photos' => :'photos',
         :'average_price_per_tonne_cents_usd' => :'average_price_per_tonne_cents_usd',
         :'remaining_mass_g' => :'remaining_mass_g',
+        :'verifier' => :'verifier',
         :'standard' => :'standard',
         :'sdgs' => :'sdgs',
+        :'tagline' => :'tagline',
         :'technology_type' => :'technology_type',
-        :'tagline' => :'tagline'
+        :'highlights' => :'highlights'
       }
     end
 
@@ -136,10 +144,12 @@ module Patch
         :'photos' => :'Array<Photo>',
         :'average_price_per_tonne_cents_usd' => :'Integer',
         :'remaining_mass_g' => :'Integer',
+        :'verifier' => :'String',
         :'standard' => :'Standard',
         :'sdgs' => :'Array<Sdg>',
+        :'tagline' => :'String',
         :'technology_type' => :'TechnologyType',
-        :'tagline' => :'String'
+        :'highlights' => :'Array<Highlight>'
       }
     end
 
@@ -152,7 +162,6 @@ module Patch
         :'photos',
         :'standard',
         :'sdgs',
-        :'tagline'
       ])
     end
 
@@ -241,6 +250,10 @@ module Patch
         self.remaining_mass_g = attributes[:'remaining_mass_g']
       end
 
+      if attributes.key?(:'verifier')
+        self.verifier = attributes[:'verifier']
+      end
+
       if attributes.key?(:'standard')
         self.standard = attributes[:'standard']
       end
@@ -251,12 +264,18 @@ module Patch
         end
       end
 
+      if attributes.key?(:'tagline')
+        self.tagline = attributes[:'tagline']
+      end
+
       if attributes.key?(:'technology_type')
         self.technology_type = attributes[:'technology_type']
       end
 
-      if attributes.key?(:'tagline')
-        self.tagline = attributes[:'tagline']
+      if attributes.key?(:'highlights')
+        if (value = attributes[:'highlights']).is_a?(Array)
+          self.highlights = value
+        end
       end
     end
 
@@ -296,6 +315,14 @@ module Patch
         invalid_properties.push('invalid value for "remaining_mass_g", remaining_mass_g cannot be nil.')
       end
 
+      if @technology_type.nil?
+        invalid_properties.push('invalid value for "technology_type", technology_type cannot be nil.')
+      end
+
+      if @highlights.nil?
+        invalid_properties.push('invalid value for "highlights", highlights cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -306,27 +333,17 @@ module Patch
       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)
       mechanism_validator = EnumAttributeValidator.new('String', ["removal", "avoidance"])
       return false unless mechanism_validator.valid?(@mechanism)
       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?
+      return false if @technology_type.nil?
+      return false if @highlights.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] type Object to be assigned
-    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
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] mechanism Object to be assigned
     def mechanism=(mechanism)
@@ -356,10 +373,12 @@ 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 &&
+          verifier == o.verifier &&
           standard == o.standard &&
           sdgs == o.sdgs &&
+          tagline == o.tagline &&
           technology_type == o.technology_type &&
-          tagline == o.tagline
+          highlights == o.highlights
     end
 
     # @see the `==` method
@@ -371,7 +390,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, standard, sdgs, technology_type, tagline].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
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/project_list_response.rb

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 

data/lib/patch_ruby/models/project_response.rb

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 

data/lib/patch_ruby/models/sdg.rb

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 

data/lib/patch_ruby/models/standard.rb

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 

data/lib/patch_ruby/models/technology_type.rb

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 
@@ -14,11 +14,12 @@ require 'date'
 require 'time'
 
 module Patch
+  # An object containing the technology type's name, slug and parent_technology_type.
   class TechnologyType
     # Unique identifier for this type of technology.
     attr_accessor :slug
 
-    # Name of this technology type.
+    # Display name of this technology type.
     attr_accessor :name
 
     attr_accessor :parent_technology_type
@@ -96,12 +97,22 @@ module Patch
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @slug.nil?
+        invalid_properties.push('invalid value for "slug", slug 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 @slug.nil?
+      return false if @name.nil?
       true
     end
 

data/lib/patch_ruby/models/{preference_response.rb → technology_type_list_response.rb}

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Patch
-  class PreferenceResponse
+  class TechnologyTypeListResponse
     attr_accessor :success
 
     attr_accessor :error
@@ -40,7 +40,7 @@ module Patch
       {
         :'success' => :'Boolean',
         :'error' => :'Object',
-        :'data' => :'Preference'
+        :'data' => :'Array<TechnologyType>'
       }
     end
 
@@ -56,8 +56,8 @@ module Patch
     # 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::PreferenceResponsesApi::OPERATIONS') && Patch::PreferenceResponsesApi::OPERATIONS.include?(message)
-        Patch::PreferenceResponsesApi.new.send(message, *args)
+      if Object.const_defined?('Patch::TechnologyTypeListResponsesApi::OPERATIONS') && Patch::TechnologyTypeListResponsesApi::OPERATIONS.include?(message)
+        Patch::TechnologyTypeListResponsesApi.new.send(message, *args)
       else
         super
       end
@@ -67,13 +67,13 @@ module Patch
     # @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::PreferenceResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Patch::TechnologyTypeListResponse` 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::PreferenceResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Patch::TechnologyTypeListResponse`. 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
       }
@@ -87,7 +87,9 @@ module Patch
       end
 
       if attributes.key?(:'data')
-        self.data = attributes[:'data']
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
       end
     end
 

data/lib/patch_ruby/version.rb

@@ -4,12 +4,12 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 
 =end
 
 module Patch
-  VERSION = '1.14.0'
+  VERSION = '1.16.0'
 end

data/lib/patch_ruby.rb

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 
@@ -23,7 +23,6 @@ require 'patch_ruby/models/create_ethereum_estimate_request'
 require 'patch_ruby/models/create_flight_estimate_request'
 require 'patch_ruby/models/create_mass_estimate_request'
 require 'patch_ruby/models/create_order_request'
-require 'patch_ruby/models/create_preference_request'
 require 'patch_ruby/models/create_shipping_estimate_request'
 require 'patch_ruby/models/create_success_response'
 require 'patch_ruby/models/create_vehicle_estimate_request'
@@ -31,27 +30,26 @@ require 'patch_ruby/models/error_response'
 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/meta_index_object'
 require 'patch_ruby/models/order'
 require 'patch_ruby/models/order_list_response'
 require 'patch_ruby/models/order_response'
 require 'patch_ruby/models/parent_technology_type'
 require 'patch_ruby/models/photo'
-require 'patch_ruby/models/preference'
-require 'patch_ruby/models/preference_list_response'
-require 'patch_ruby/models/preference_response'
 require 'patch_ruby/models/project'
 require 'patch_ruby/models/project_list_response'
 require 'patch_ruby/models/project_response'
 require 'patch_ruby/models/sdg'
 require 'patch_ruby/models/standard'
 require 'patch_ruby/models/technology_type'
+require 'patch_ruby/models/technology_type_list_response'
 
 # APIs
 require 'patch_ruby/api/estimates_api'
 require 'patch_ruby/api/orders_api'
-require 'patch_ruby/api/preferences_api'
 require 'patch_ruby/api/projects_api'
+require 'patch_ruby/api/technology_types_api'
 
 module Patch
   class << self

data/patch_ruby.gemspec

@@ -6,7 +6,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 

data/spec/api/technology_types_api_spec.rb

@@ -0,0 +1,46 @@
+=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: 5.2.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Patch::TechnologyTypesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TechnologyTypesApi' do
+  before do
+    # run before each test
+    @api_instance = Patch::TechnologyTypesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TechnologyTypesApi' do
+    it 'should create an instance of TechnologyTypesApi' do
+      expect(@api_instance).to be_instance_of(Patch::TechnologyTypesApi)
+    end
+  end
+
+  # unit tests for retrieve_technology_types
+  # Retrieves the list of technology_types
+  # Retrieves a list of all technology_types. 
+  # @param [Hash] opts the optional parameters
+  # @return [TechnologyTypeListResponse]
+  describe 'retrieve_technology_types test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api_client_spec.rb

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 

data/spec/configuration_spec.rb

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1
 

data/spec/integration/orders_spec.rb

@@ -30,8 +30,6 @@ RSpec.describe 'Orders Integration' do
     order_mass_g = 100_000
     tonne_per_gram = 1_000_000
 
-    expected_price = (average_price_per_tonne_cents_usd.to_f / tonne_per_gram) * order_mass_g
-
     create_order_response = Patch::Order.create_order(mass_g: order_mass_g, project_id: project_id)
 
     order = create_order_response.data
@@ -39,7 +37,7 @@ RSpec.describe 'Orders Integration' do
     expect(order.id).not_to be_nil
     expect(order.created_at).to be_a_kind_of(Time)
     expect(order.mass_g).to eq(order_mass_g)
-    expect(order.price_cents_usd).to be_between(expected_price - 2, expected_price + 2)
+    expect(order.price_cents_usd).to be_kind_of(Integer)
     expect(order.patch_fee_cents_usd).to be_kind_of(Integer)
     expect(order.registry_url).not_to be_empty
   end

data/spec/integration/projects/technology_types_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+RSpec.describe "Projects TechnologyTypes Integration" do
+  it "returns a list of technology types and their parent types" do
+    technology_types = Patch::TechnologyType.retrieve_technology_types()
+    expect(technology_types.data.count).to be_positive
+    expect(technology_types.data.first.slug).to be_a(String)
+    expect(technology_types.data.first.name).to be_a(String)
+
+    parent = technology_types.data.first.parent_technology_type
+    expect(parent.slug).to be_a(String)
+    expect(parent.name).to be_a(String)
+  end
+end

data/spec/integration/projects_spec.rb

@@ -49,7 +49,6 @@ RSpec.describe 'Projects Integration' do
       expect(project.average_price_per_tonne_cents_usd)
         .to be_an_instance_of(Integer)
       expect(project.remaining_mass_g).to be_an_instance_of(Integer)
-      expect(project.state).to be_an_instance_of(String)
       expect(project.longitude).to be_an_instance_of(Float)
       expect(project.latitude).to be_an_instance_of(Float)
 
@@ -62,6 +61,8 @@ RSpec.describe 'Projects Integration' do
       expect(parent_type).to be_an_instance_of(Patch::ParentTechnologyType)
       expect(parent_type.name).to be_an_instance_of(String)
       expect(parent_type.slug).to be_an_instance_of(String)
+
+      expect(project.highlights).to be_an_instance_of(Array)
     end
   end
 end

data/spec/models/project_spec.rb

@@ -51,7 +51,7 @@ describe 'Project' do
       }
     }
     let(:nullable_properties) do
-      Set.new(%i[photos standard sdgs state latitude longitude tagline])
+      Set.new(%i[photos standard sdgs state latitude longitude])
     end
   end
 

data/spec/spec_helper.rb

@@ -4,7 +4,7 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.1