patch_ruby 2.0.0 → 2.3.0

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
 
@@ -62,12 +65,37 @@ 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.
+    # DEPRECATED. 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. Highlights are deprecated and not populated for recent projects.
     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
 
+    # 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

data/lib/patch_ruby/models/update_order_line_item_request.rb

@@ -17,6 +17,10 @@ module Patch
   class UpdateOrderLineItemRequest
     attr_accessor :vintage_year
 
+    attr_accessor :vintage_start_year
+
+    attr_accessor :vintage_end_year
+
     attr_accessor :price
 
     attr_accessor :currency
@@ -51,6 +55,8 @@ module Patch
     def self.attribute_map
       {
         :'vintage_year' => :'vintage_year',
+        :'vintage_start_year' => :'vintage_start_year',
+        :'vintage_end_year' => :'vintage_end_year',
         :'price' => :'price',
         :'currency' => :'currency',
         :'amount' => :'amount',
@@ -67,6 +73,8 @@ module Patch
     def self.openapi_types
       {
         :'vintage_year' => :'Integer',
+        :'vintage_start_year' => :'Integer',
+        :'vintage_end_year' => :'Integer',
         :'price' => :'Integer',
         :'currency' => :'String',
         :'amount' => :'Integer',
@@ -78,6 +86,8 @@ module Patch
     def self.openapi_nullable
       Set.new([
         :'vintage_year',
+        :'vintage_start_year',
+        :'vintage_end_year',
         :'price',
         :'currency',
         :'amount',
@@ -116,6 +126,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?(:'price')
         self.price = attributes[:'price']
       end
@@ -137,20 +155,36 @@ module Patch
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if !@vintage_year.nil? && @vintage_year > 2100
-        invalid_properties.push('invalid value for "vintage_year", must be smaller than or equal to 2100.')
+      if !@vintage_year.nil? && @vintage_year > 2225
+        invalid_properties.push('invalid value for "vintage_year", must be smaller than or equal to 2225.')
       end
 
       if !@vintage_year.nil? && @vintage_year < 1900
         invalid_properties.push('invalid value for "vintage_year", must be greater than or equal to 1900.')
       end
 
+      if !@vintage_start_year.nil? && @vintage_start_year > 2225
+        invalid_properties.push('invalid value for "vintage_start_year", must be smaller than or equal to 2225.')
+      end
+
+      if !@vintage_start_year.nil? && @vintage_start_year < 1900
+        invalid_properties.push('invalid value for "vintage_start_year", must be greater than or equal to 1900.')
+      end
+
+      if !@vintage_end_year.nil? && @vintage_end_year > 2225
+        invalid_properties.push('invalid value for "vintage_end_year", must be smaller than or equal to 2225.')
+      end
+
+      if !@vintage_end_year.nil? && @vintage_end_year < 1900
+        invalid_properties.push('invalid value for "vintage_end_year", must be greater than or equal to 1900.')
+      end
+
       if !@price.nil? && @price < 2
         invalid_properties.push('invalid value for "price", must be greater than or equal to 2.')
       end
 
-      if !@amount.nil? && @amount > 100000000000
-        invalid_properties.push('invalid value for "amount", must be smaller than or equal to 100000000000.')
+      if !@amount.nil? && @amount > 100000000000000
+        invalid_properties.push('invalid value for "amount", must be smaller than or equal to 100000000000000.')
       end
 
       if !@amount.nil? && @amount < 0
@@ -163,12 +197,16 @@ module Patch
     # 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 !@vintage_year.nil? && @vintage_year > 2100
+      return false if !@vintage_year.nil? && @vintage_year > 2225
       return false if !@vintage_year.nil? && @vintage_year < 1900
+      return false if !@vintage_start_year.nil? && @vintage_start_year > 2225
+      return false if !@vintage_start_year.nil? && @vintage_start_year < 1900
+      return false if !@vintage_end_year.nil? && @vintage_end_year > 2225
+      return false if !@vintage_end_year.nil? && @vintage_end_year < 1900
       return false if !@price.nil? && @price < 2
-      return false if !@amount.nil? && @amount > 100000000000
+      return false if !@amount.nil? && @amount > 100000000000000
       return false if !@amount.nil? && @amount < 0
-      unit_validator = EnumAttributeValidator.new('String', ["g", "Wh"])
+      unit_validator = EnumAttributeValidator.new('String', ["g"])
       return false unless unit_validator.valid?(@unit)
       true
     end
@@ -176,8 +214,8 @@ module Patch
     # Custom attribute writer method with validation
     # @param [Object] vintage_year Value to be assigned
     def vintage_year=(vintage_year)
-      if !vintage_year.nil? && vintage_year > 2100
-        fail ArgumentError, 'invalid value for "vintage_year", must be smaller than or equal to 2100.'
+      if !vintage_year.nil? && vintage_year > 2225
+        fail ArgumentError, 'invalid value for "vintage_year", must be smaller than or equal to 2225.'
       end
 
       if !vintage_year.nil? && vintage_year < 1900
@@ -187,6 +225,34 @@ module Patch
       @vintage_year = vintage_year
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] vintage_start_year Value to be assigned
+    def vintage_start_year=(vintage_start_year)
+      if !vintage_start_year.nil? && vintage_start_year > 2225
+        fail ArgumentError, 'invalid value for "vintage_start_year", must be smaller than or equal to 2225.'
+      end
+
+      if !vintage_start_year.nil? && vintage_start_year < 1900
+        fail ArgumentError, 'invalid value for "vintage_start_year", must be greater than or equal to 1900.'
+      end
+
+      @vintage_start_year = vintage_start_year
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] vintage_end_year Value to be assigned
+    def vintage_end_year=(vintage_end_year)
+      if !vintage_end_year.nil? && vintage_end_year > 2225
+        fail ArgumentError, 'invalid value for "vintage_end_year", must be smaller than or equal to 2225.'
+      end
+
+      if !vintage_end_year.nil? && vintage_end_year < 1900
+        fail ArgumentError, 'invalid value for "vintage_end_year", must be greater than or equal to 1900.'
+      end
+
+      @vintage_end_year = vintage_end_year
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] price Value to be assigned
     def price=(price)
@@ -200,8 +266,8 @@ module Patch
     # Custom attribute writer method with validation
     # @param [Object] amount Value to be assigned
     def amount=(amount)
-      if !amount.nil? && amount > 100000000000
-        fail ArgumentError, 'invalid value for "amount", must be smaller than or equal to 100000000000.'
+      if !amount.nil? && amount > 100000000000000
+        fail ArgumentError, 'invalid value for "amount", must be smaller than or equal to 100000000000000.'
       end
 
       if !amount.nil? && amount < 0
@@ -214,7 +280,7 @@ module Patch
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] unit Object to be assigned
     def unit=(unit)
-      validator = EnumAttributeValidator.new('String', ["g", "Wh"])
+      validator = EnumAttributeValidator.new('String', ["g"])
       unless validator.valid?(unit)
         fail ArgumentError, "invalid value for \"unit\", must be one of #{validator.allowable_values}."
       end
@@ -227,6 +293,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 &&
           price == o.price &&
           currency == o.currency &&
           amount == o.amount &&
@@ -242,7 +310,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [vintage_year, price, currency, amount, unit].hash
+      [vintage_year, vintage_start_year, vintage_end_year, price, currency, amount, unit].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 = '2.0.0'
+  VERSION = '2.3.0'
 end

data/lib/patch_ruby.rb

@@ -20,7 +20,6 @@ require 'patch_ruby/configuration'
 require 'patch_ruby/models/create_air_shipping_estimate_request'
 require 'patch_ruby/models/create_bitcoin_estimate_request'
 require 'patch_ruby/models/create_ecommerce_estimate_request'
-require 'patch_ruby/models/create_ethereum_estimate_request'
 require 'patch_ruby/models/create_flight_estimate_request'
 require 'patch_ruby/models/create_hotel_estimate_request'
 require 'patch_ruby/models/create_mass_estimate_request'
@@ -29,11 +28,10 @@ require 'patch_ruby/models/create_order_request'
 require 'patch_ruby/models/create_rail_shipping_estimate_request'
 require 'patch_ruby/models/create_road_shipping_estimate_request'
 require 'patch_ruby/models/create_sea_shipping_estimate_request'
-require 'patch_ruby/models/create_shipping_estimate_request'
 require 'patch_ruby/models/create_success_response'
-require 'patch_ruby/models/create_vehicle_estimate_request'
 require 'patch_ruby/models/delete_order_line_item_response'
 require 'patch_ruby/models/delete_order_response'
+require 'patch_ruby/models/disclaimer'
 require 'patch_ruby/models/error_response'
 require 'patch_ruby/models/estimate'
 require 'patch_ruby/models/estimate_list_response'

data/patch_ruby.gemspec

@@ -41,4 +41,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'pry'
   # End custom
 
-end
+end

data/spec/integration/estimates_spec.rb

@@ -45,51 +45,6 @@ RSpec.describe 'Estimates Integration' do
     expect(flight_estimate_longer.data.mass_g).to be > 2 * flight_estimate.data.mass_g
   end
 
-  it 'supports creating vehicle estimates' do
-    distance_m = 10_000
-    make = "Toyota"
-    model = "Corolla"
-    year = 2000
-
-    vehicle_estimate = Patch::Estimate.create_vehicle_estimate(
-      distance_m: distance_m,
-      make: make,
-      model: model,
-      year: year,
-      create_order: true
-    )
-
-    expect(vehicle_estimate.data.type).to eq 'vehicle'
-    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
-    distance_m = 10_000
-
-    vehicle_estimate = Patch::Estimate.create_vehicle_estimate(
-      distance_m: distance_m,
-      create_order: false
-    )
-
-    expect(vehicle_estimate.data.type).to eq 'vehicle'
-    expect(vehicle_estimate.data.mass_g).to eq 2_132
-  end
-
-  it 'supports creating shipping estimates' do
-    distance_m = 100_000_000
-    package_mass_g = 10_000
-    create_estimate_response = Patch::Estimate.create_shipping_estimate(
-      distance_m: distance_m,
-      package_mass_g: package_mass_g,
-      transportation_method: 'rail',
-      create_order: false
-    )
-
-    expect(create_estimate_response.data.type).to eq 'shipping'
-    expect(create_estimate_response.data.mass_g).to be >= 10_000
-  end
-
   it 'supports creating bitcoin estimates with partial information' do
     bitcoin_estimate = Patch::Estimate.create_bitcoin_estimate()
 
@@ -136,26 +91,6 @@ RSpec.describe 'Estimates Integration' do
     expect(bitcoin_estimate_1.data.mass_g).to be < bitcoin_estimate_2.data.mass_g
   end
 
-  it 'supports creating ethereum estimates with a gas amount' do
-    ethereum_estimate = Patch::Estimate.create_ethereum_estimate(
-      gas_used: 100
-    )
-
-    ethereum_estimate_2 = Patch::Estimate.create_ethereum_estimate(
-      gas_used: 1000
-    )
-
-    expect(ethereum_estimate.data.type).to eq 'ethereum'
-    expect(ethereum_estimate.data.mass_g).to be < ethereum_estimate_2.data.mass_g
-  end
-
-  it 'supports creating ethereum estimates with partial information' do
-    ethereum_estimate = Patch::Estimate.create_ethereum_estimate({ create_order: false })
-
-    expect(ethereum_estimate.data.type).to eq 'ethereum'
-    expect(ethereum_estimate.data.mass_g).to be >= 2_000
-  end
-
   it 'supports creating hotel estimates' do
     create_estimate_response = Patch::Estimate.create_hotel_estimate(
       country_code: "US",

data/spec/integration/orders_spec.rb

@@ -134,6 +134,16 @@ RSpec.describe 'Orders Integration' do
     expect(create_order_response.data.unit).to eq("g")
   end
 
+  it 'supports create with a vintage start year and vintage end year' do
+    create_order_response =
+      Patch::Order.create_order(amount: 100, unit: "g", vintage_start_year: 2022, vintage_end_year: 2023)
+
+    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")
+  end
+
   it 'supports create with an amount and unit' do
     create_order_response =
       Patch::Order.create_order(amount: 100, unit: "g")
@@ -209,6 +219,32 @@ RSpec.describe 'Orders Integration' do
     expect(delete_line_item_response.success).to eq(true)
     expect(delete_line_item_response.data).to eq(line_item_id)
 
+    # Add line item via vintage_start_year and vintage_end_year
+    create_order_line_item_response = Patch::OrderLineItem
+      .create_order_line_item(order_id, { project_id: project_id, amount: 300000, unit: "g", vintage_start_year: 2023, vintage_end_year: 2025 })
+
+    expect(create_order_line_item_response.success).to eq(true)
+    expect(create_order_line_item_response.data.id).not_to be_nil
+    expect(create_order_line_item_response.data.amount).to eq(300000)
+    expect(create_order_line_item_response.data.vintage_start_year).to eq(2023)
+    expect(create_order_line_item_response.data.vintage_end_year).to eq(2025)
+    expect(create_order_line_item_response.data.price).to be >= 0
+
+    # Fetch order and check line item matches
+    retrieve_order_response = Patch::Order.retrieve_order(order_id)
+    expect(retrieve_order_response.data.id).to eq order_id
+    expect(retrieve_order_response.data.line_items.length).to eq(1)
+    expect(retrieve_order_response.data.line_items[0].id).to eq(line_item_id)
+    expect(retrieve_order_response.data.line_items[0].amount).to eq(300000)
+    expect(retrieve_order_response.data.line_items[0].vintage_start_year).to eq(2023)
+    expect(retrieve_order_response.data.line_items[0].vintage_end_year).to eq(2025)
+
+    # Delete line item
+    line_item_id = create_order_line_item_response.data.id
+    delete_line_item_response = Patch::OrderLineItem.delete_order_line_item(order_id, line_item_id)
+    expect(delete_line_item_response.success).to eq(true)
+    expect(delete_line_item_response.data).to eq(line_item_id)
+
     # Fetch order and see it has no line items
     retrieve_order_response = Patch::Order.retrieve_order(order_id)
     expect(retrieve_order_response.data.id).to eq order_id

data/spec/integration/projects_spec.rb

@@ -65,19 +65,33 @@ RSpec.describe 'Projects Integration' do
     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].vintage_start_year).to be_an_instance_of(Integer)
+    expect(inventory[0].vintage_end_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)
+
+    issuance_type = project.issuance_type
+    expect(issuance_type).to be_an_instance_of(String)
+
+    disclaimers = project.disclaimers
+    expect(disclaimers).to be_an_instance_of(Array)
+    expect(disclaimers[0]).to be_an_instance_of(Patch::Disclaimer)
+    expect(disclaimers[0].body).to be_an_instance_of(String)
+    expect(disclaimers[0].header).to be_an_instance_of(String)
+    expect(disclaimers[0].severity).to be_an_instance_of(String)
+    expect(disclaimers[0].link_text).to be_an_instance_of(String)
+    expect(disclaimers[0].link_destination).to be_an_instance_of(String)
   end
 
   it 'retrieves projects in the requested language' do
     projects_response = Patch::Project.retrieve_projects(accept_language: 'fr')
 
-    expect(projects_response.data.first.name).to include 'Démo' # French
+    expect(projects_response.data.last.name).to include 'Démo' # French
 
-    project_id = projects_response.data.first.id
+    project_id = projects_response.data.last.id
     project_response = Patch::Project.retrieve_project(project_id, accept_language: 'fr')
-    expect(project_response.data.name).to include 'Démo' # Frenc
+    expect(project_response.data.name).to include 'Démo' # French
   end
 end

data/spec/models/create_order_request_spec.rb

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