patch_ruby 1.24.2 → 2.1.1

data/lib/patch_ruby/models/update_order_line_item_request.rb

@@ -0,0 +1,434 @@
+=begin
+#Patch API V2
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: 2
+Contact: engineering@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.3.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Patch
+  class UpdateOrderLineItemRequest
+    attr_accessor :vintage_year
+
+    attr_accessor :vintage_start_year
+
+    attr_accessor :vintage_end_year
+
+    attr_accessor :price
+
+    attr_accessor :currency
+
+    attr_accessor :amount
+
+    attr_accessor :unit
+
+    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
+      {
+        :'vintage_year' => :'vintage_year',
+        :'vintage_start_year' => :'vintage_start_year',
+        :'vintage_end_year' => :'vintage_end_year',
+        :'price' => :'price',
+        :'currency' => :'currency',
+        :'amount' => :'amount',
+        :'unit' => :'unit'
+      }
+    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
+      {
+        :'vintage_year' => :'Integer',
+        :'vintage_start_year' => :'Integer',
+        :'vintage_end_year' => :'Integer',
+        :'price' => :'Integer',
+        :'currency' => :'String',
+        :'amount' => :'Integer',
+        :'unit' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'vintage_year',
+        :'vintage_start_year',
+        :'vintage_end_year',
+        :'price',
+        :'currency',
+        :'amount',
+        :'unit'
+      ])
+    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::UpdateOrderLineItemRequestsApi::OPERATIONS') && Patch::UpdateOrderLineItemRequestsApi::OPERATIONS.include?(message)
+        Patch::UpdateOrderLineItemRequestsApi.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::UpdateOrderLineItemRequest` 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::UpdateOrderLineItemRequest`. 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?(:'vintage_year')
+        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
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'unit')
+        self.unit = attributes[:'unit']
+      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 !@vintage_year.nil? && @vintage_year > 2100
+        invalid_properties.push('invalid value for "vintage_year", must be smaller than or equal to 2100.')
+      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 > 2100
+        invalid_properties.push('invalid value for "vintage_start_year", must be smaller than or equal to 2100.')
+      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 > 2100
+        invalid_properties.push('invalid value for "vintage_end_year", must be smaller than or equal to 2100.')
+      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 > 100000000000000
+        invalid_properties.push('invalid value for "amount", must be smaller than or equal to 100000000000000.')
+      end
+
+      if !@amount.nil? && @amount < 0
+        invalid_properties.push('invalid value for "amount", must be greater than or equal to 0.')
+      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 !@vintage_year.nil? && @vintage_year > 2100
+      return false if !@vintage_year.nil? && @vintage_year < 1900
+      return false if !@vintage_start_year.nil? && @vintage_start_year > 2100
+      return false if !@vintage_start_year.nil? && @vintage_start_year < 1900
+      return false if !@vintage_end_year.nil? && @vintage_end_year > 2100
+      return false if !@vintage_end_year.nil? && @vintage_end_year < 1900
+      return false if !@price.nil? && @price < 2
+      return false if !@amount.nil? && @amount > 100000000000000
+      return false if !@amount.nil? && @amount < 0
+      unit_validator = EnumAttributeValidator.new('String', ["g", "Wh"])
+      return false unless unit_validator.valid?(@unit)
+      true
+    end
+
+    # 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.'
+      end
+
+      if !vintage_year.nil? && vintage_year < 1900
+        fail ArgumentError, 'invalid value for "vintage_year", must be greater than or equal to 1900.'
+      end
+
+      @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 > 2100
+        fail ArgumentError, 'invalid value for "vintage_start_year", must be smaller than or equal to 2100.'
+      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 > 2100
+        fail ArgumentError, 'invalid value for "vintage_end_year", must be smaller than or equal to 2100.'
+      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)
+      if !price.nil? && price < 2
+        fail ArgumentError, 'invalid value for "price", must be greater than or equal to 2.'
+      end
+
+      @price = price
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] amount Value to be assigned
+    def amount=(amount)
+      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
+        fail ArgumentError, 'invalid value for "amount", must be greater than or equal to 0.'
+      end
+
+      @amount = amount
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] unit Object to be assigned
+    def unit=(unit)
+      validator = EnumAttributeValidator.new('String', ["g", "Wh"])
+      unless validator.valid?(unit)
+        fail ArgumentError, "invalid value for \"unit\", must be one of #{validator.allowable_values}."
+      end
+      @unit = unit
+    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 &&
+          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 &&
+          unit == o.unit
+    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
+      [vintage_year, vintage_start_year, vintage_end_year, price, currency, amount, unit].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/version.rb

@@ -1,9 +1,9 @@
 =begin
-#Patch API V1
+#Patch API V2
 
 #The core API used to integrate with Patch's service
 
-The version of the OpenAPI document: v1
+The version of the OpenAPI document: 2
 Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.3.1
@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.3.1
 =end
 
 module Patch
-  VERSION = '1.24.2'
+  VERSION = '2.1.1'
 end

data/lib/patch_ruby.rb

@@ -1,9 +1,9 @@
 =begin
-#Patch API V1
+#Patch API V2
 
 #The core API used to integrate with Patch's service
 
-The version of the OpenAPI document: v1
+The version of the OpenAPI document: 2
 Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.3.1
@@ -17,7 +17,6 @@ require 'patch_ruby/version'
 require 'patch_ruby/configuration'
 
 # Models
-require 'patch_ruby/models/allocation'
 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'
@@ -25,6 +24,7 @@ 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'
+require 'patch_ruby/models/create_order_line_item_request'
 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'
@@ -32,6 +32,9 @@ 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'
@@ -40,9 +43,10 @@ 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_issued_to'
+require 'patch_ruby/models/order_line_item'
+require 'patch_ruby/models/order_line_item_project'
+require 'patch_ruby/models/order_line_item_response'
 require 'patch_ruby/models/order_list_response'
 require 'patch_ruby/models/order_response'
 require 'patch_ruby/models/parent_technology_type'
@@ -55,9 +59,11 @@ require 'patch_ruby/models/sdg'
 require 'patch_ruby/models/standard'
 require 'patch_ruby/models/technology_type'
 require 'patch_ruby/models/technology_type_list_response'
+require 'patch_ruby/models/update_order_line_item_request'
 
 # APIs
 require 'patch_ruby/api/estimates_api'
+require 'patch_ruby/api/order_line_items_api'
 require 'patch_ruby/api/orders_api'
 require 'patch_ruby/api/projects_api'
 require 'patch_ruby/api/technology_types_api'

data/patch_ruby.gemspec

@@ -1,11 +1,11 @@
 # -*- encoding: utf-8 -*-
 
 =begin
-#Patch API V1
+#Patch API V2
 
 #The core API used to integrate with Patch's service
 
-The version of the OpenAPI document: v1
+The version of the OpenAPI document: 2
 Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.3.1

data/spec/api/order_line_items_api_spec.rb

@@ -0,0 +1,78 @@
+=begin
+#Patch API V2
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: 2
+Contact: engineering@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Patch::OrderLineItemsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'OrderLineItemsApi' do
+  before do
+    # run before each test
+    @api_instance = Patch::OrderLineItemsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of OrderLineItemsApi' do
+    it 'should create an instance of OrderLineItemsApi' do
+      expect(@api_instance).to be_instance_of(Patch::OrderLineItemsApi)
+    end
+  end
+
+  # unit tests for create_order_line_item
+  # Creates an order line item
+  # Creates a line item on an order that is in the `draft` state. 
+  # @param order_id 
+  # @param create_order_line_item_request 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :patch_version 
+  # @return [OrderLineItemResponse]
+  describe 'create_order_line_item test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_order_line_item
+  # Deletes an order line item
+  # Deletes a line item on an order that is in the `draft` state. 
+  # @param order_id 
+  # @param serial_number 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :patch_version 
+  # @return [DeleteOrderLineItemResponse]
+  describe 'delete_order_line_item test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_order_line_item
+  # Updates an order line item
+  # Updates a line item on an order that is in the `draft` state. 
+  # @param order_id 
+  # @param serial_number 
+  # @param update_order_line_item_request 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :patch_version 
+  # @return [OrderLineItemResponse]
+  describe 'update_order_line_item 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

@@ -1,9 +1,9 @@
 =begin
-#Patch API V1
+#Patch API V2
 
 #The core API used to integrate with Patch's service
 
-The version of the OpenAPI document: v1
+The version of the OpenAPI document: 2
 Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.3.1

data/spec/configuration_spec.rb

@@ -1,9 +1,9 @@
 =begin
-#Patch API V1
+#Patch API V2
 
 #The core API used to integrate with Patch's service
 
-The version of the OpenAPI document: v1
+The version of the OpenAPI document: 2
 Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.3.1

data/spec/factories/create_order_requests.rb

@@ -1,8 +1,10 @@
 FactoryBot.define do
   factory :create_order_request, class: Patch::CreateOrderRequest do
     sequence(:project_id) { |n| n }
-    mass_g { 100 }
-    total_price_cents_usd { 100 }
+    amount { 100 }
+    unit { "g" }
+    total_price { 100 }
+    currency { "USD" }
     metadata { {} }
   end
 end

data/spec/factories/orders.rb

@@ -1,12 +1,13 @@
 FactoryBot.define do
   factory :order, class: Patch::Order do
     sequence(:id) { |n| n }
-    mass_g { 1_000 }
+    amount { 1_000 }
+    unit { "g" }
     production { false }
     state { "draft" }
-    allocation_state { "pending" }
-    price_cents_usd { 500 }
-    patch_fee_cents_usd { 5 }
+    price { 500 }
+    patch_fee { 5 }
+    currency { "USD" }
     metadata { {} }
   end
 end

data/spec/factories/projects.rb

@@ -7,12 +7,9 @@ FactoryBot.define do
     production { false }
     name { "New Project" }
     description { "New Descirption" }
-    type { "biomass" }
     country { "DK" }
-    developer { "Danish Developer" }
+    project_partner { "Danish Developer" }
     photos { [] }
-    average_price_per_tonne_cents_usd { 120 }
-    remaining_mass_g { 1_000 }
     standard { 'european_biochar_certificate' }
     state { 'CO' }
     latitude { 45.0 }

data/spec/integration/estimates_spec.rb

@@ -86,7 +86,7 @@ RSpec.describe 'Estimates Integration' do
       create_order: false
     )
 
-    expect(create_estimate_response.data.type).to eq 'shipping'
+    expect(create_estimate_response.data.type).to eq 'ecommerce'
     expect(create_estimate_response.data.mass_g).to be >= 10_000
   end