patch_ruby 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3312ae1bca095a1ee4b912f2267748f57818ef9be2c10febd7bf5f8095bf15a4
-  data.tar.gz: dc08f9414555d65f420a2b8bae74a44c582b15a9702f40bd1e8a875cb094d637
+  metadata.gz: a90772be1e6d26b5b7ffef9d2f06f344a650e1c285f350dface3df5e019d3cf4
+  data.tar.gz: 96e12b69d309e6083a1e0e10dcd2e66b44f6d86fa6c1c27bd407d4bac388a069
 SHA512:
-  metadata.gz: fdf4400660c261231c72654cdead5108cfe90ff6d02457b9057ae7bb8537c55f19e2edb7004604b5d9a39474d5da9222bc8ffded005e808b0c0ab718186eec15
-  data.tar.gz: 4680eafea0b29e4eef4a8e393c56d4b0c9ad12828fa255535035e5fa786a86ef5237cfe0bb715270e3a2b376241d2e42294eb36444da17e17452d7e606d218f9
+  metadata.gz: 7c1d0d76f771cdda09b4694697544007e14484462167846527917a3a28f9d327c70af5e4f24f8e2312c61cebe1927b9a8080f7a73cc9f85018483a8a664021db
+  data.tar.gz: c4a2539ad216e42349dede7c98fdd4512f519d1b0820c2235e356d4a7772154007941bec55402a1383e8b8456664e1493ddb53341d8cfde60617b6e18198a784

data/CHANGELOG.md

@@ -5,7 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.19.0] - 2022-04-05
+
+### Added
+
+- Adds `Patch::Estimate.create_hotel_estimate` method
+
 ## [1.18.0] - 2022-03-22
+
 ### Changed
 
 - Adds optional `state` field to `order` creation

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    patch_ruby (1.18.0)
+    patch_ruby (1.19.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/lib/patch_ruby/api/estimates_api.rb

@@ -18,6 +18,7 @@ module Patch
       :create_bitcoin_estimate,
       :create_ethereum_estimate,
       :create_flight_estimate,
+      :create_hotel_estimate,
       :create_mass_estimate,
       :create_shipping_estimate,
       :create_vehicle_estimate,
@@ -237,6 +238,75 @@ module Patch
       return data, status_code, headers
     end
 
+    # Create a hotel estimate.
+    # Creates a hotel estimate for the amount of CO2 to be compensated. An order in the `draft` state may be created based on the parameters. 
+    # @param create_hotel_estimate_request [CreateHotelEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [EstimateResponse]
+    def create_hotel_estimate(create_hotel_estimate_request = {}, opts = {})
+      _create_hotel_estimate_request = Patch::CreateHotelEstimateRequest.new(create_hotel_estimate_request) 
+      data, _status_code, _headers = create_hotel_estimate_with_http_info(_create_hotel_estimate_request, opts)
+      data
+    end
+
+    # Create a hotel estimate.
+    # Creates a hotel estimate for the amount of CO2 to be compensated. An order in the `draft` state may be created based on the parameters. 
+    # @param create_hotel_estimate_request [CreateHotelEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EstimateResponse, Integer, Hash)>] EstimateResponse data, response status code and response headers
+    def create_hotel_estimate_with_http_info(create_hotel_estimate_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EstimatesApi.create_hotel_estimate ...'
+      end
+      # verify the required parameter 'create_hotel_estimate_request' is set
+      if @api_client.config.client_side_validation && create_hotel_estimate_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_hotel_estimate_request' when calling EstimatesApi.create_hotel_estimate"
+      end
+      # resource path
+      local_var_path = '/v1/estimates/hotel'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_hotel_estimate_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EstimateResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :operation => :"EstimatesApi.create_hotel_estimate",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EstimatesApi#create_hotel_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create an estimate based on mass of CO2
     # Creates an estimate for the mass of CO2 to be compensated. An order in the `draft` state will also be created, linked to the estimate. 
     # @param create_mass_estimate_request [CreateMassEstimateRequest] 

data/lib/patch_ruby/api_client.rb

@@ -31,7 +31,7 @@ module Patch
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "patch-ruby/1.18.0"
+      @user_agent = "patch-ruby/1.19.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/patch_ruby/models/create_hotel_estimate_request.rb

@@ -0,0 +1,300 @@
+=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 CreateHotelEstimateRequest
+    attr_accessor :country_code
+
+    attr_accessor :city
+
+    attr_accessor :region
+
+    attr_accessor :star_rating
+
+    attr_accessor :number_of_nights
+
+    attr_accessor :number_of_rooms
+
+    attr_accessor :project_id
+
+    attr_accessor :create_order
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'country_code' => :'country_code',
+        :'city' => :'city',
+        :'region' => :'region',
+        :'star_rating' => :'star_rating',
+        :'number_of_nights' => :'number_of_nights',
+        :'number_of_rooms' => :'number_of_rooms',
+        :'project_id' => :'project_id',
+        :'create_order' => :'create_order'
+      }
+    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
+      {
+        :'country_code' => :'String',
+        :'city' => :'String',
+        :'region' => :'String',
+        :'star_rating' => :'Integer',
+        :'number_of_nights' => :'Integer',
+        :'number_of_rooms' => :'Integer',
+        :'project_id' => :'String',
+        :'create_order' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'project_id',
+        :'create_order'
+      ])
+    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::CreateHotelEstimateRequestsApi::OPERATIONS') && Patch::CreateHotelEstimateRequestsApi::OPERATIONS.include?(message)
+        Patch::CreateHotelEstimateRequestsApi.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::CreateHotelEstimateRequest` 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::CreateHotelEstimateRequest`. 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?(:'country_code')
+        self.country_code = attributes[:'country_code']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'region')
+        self.region = attributes[:'region']
+      end
+
+      if attributes.key?(:'star_rating')
+        self.star_rating = attributes[:'star_rating']
+      end
+
+      if attributes.key?(:'number_of_nights')
+        self.number_of_nights = attributes[:'number_of_nights']
+      end
+
+      if attributes.key?(:'number_of_rooms')
+        self.number_of_rooms = attributes[:'number_of_rooms']
+      end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      end
+
+      if attributes.key?(:'create_order')
+        self.create_order = attributes[:'create_order']
+      else
+        self.create_order = false
+      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 @country_code.nil?
+        invalid_properties.push('invalid value for "country_code", country_code 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 @country_code.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 &&
+          country_code == o.country_code &&
+          city == o.city &&
+          region == o.region &&
+          star_rating == o.star_rating &&
+          number_of_nights == o.number_of_nights &&
+          number_of_rooms == o.number_of_rooms &&
+          project_id == o.project_id &&
+          create_order == o.create_order
+    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
+      [country_code, city, region, star_rating, number_of_nights, number_of_rooms, project_id, create_order].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

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

data/lib/patch_ruby.rb

@@ -21,6 +21,7 @@ require 'patch_ruby/models/allocation'
 require 'patch_ruby/models/create_bitcoin_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'
 require 'patch_ruby/models/create_order_request'
 require 'patch_ruby/models/create_shipping_estimate_request'

data/spec/integration/estimates_spec.rb

@@ -87,7 +87,7 @@ RSpec.describe 'Estimates Integration' do
     )
 
     expect(create_estimate_response.data.type).to eq 'shipping'
-    expect(create_estimate_response.data.mass_g).to eq 12_431
+    expect(create_estimate_response.data.mass_g).to be >= 10_000
   end
 
 
@@ -156,4 +156,19 @@ RSpec.describe 'Estimates Integration' do
     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",
+      city: "Denver",
+      star_rating: 5,
+      number_of_nights: 2,
+      number_of_rooms: 2
+    )
+
+    expect(create_estimate_response.success).to eq(true)
+    expect(create_estimate_response.data.type).to eq 'hotel'
+    expect(create_estimate_response.data.mass_g).to be >= 100_000
+    expect(create_estimate_response.data.id).not_to be_nil
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patch_ruby
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Patch Technology
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -104,6 +104,7 @@ files:
 - lib/patch_ruby/models/create_bitcoin_estimate_request.rb
 - lib/patch_ruby/models/create_ethereum_estimate_request.rb
 - lib/patch_ruby/models/create_flight_estimate_request.rb
+- lib/patch_ruby/models/create_hotel_estimate_request.rb
 - lib/patch_ruby/models/create_mass_estimate_request.rb
 - lib/patch_ruby/models/create_order_request.rb
 - lib/patch_ruby/models/create_shipping_estimate_request.rb
@@ -198,48 +199,48 @@ signing_key:
 specification_version: 4
 summary: Ruby wrapper for the Patch API
 test_files:
+- spec/api/projects_api_spec.rb
+- spec/api/estimates_api_spec.rb
 - 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_client_spec.rb
 - spec/configuration_spec.rb
 - spec/constants.rb
 - spec/factories/project_list_responses.rb
-- spec/factories/error_responses.rb
-- spec/factories/sdgs.rb
-- spec/factories/meta_index_objects.rb
-- spec/factories/create_mass_estimate_requests.rb
-- spec/factories/project_responses.rb
+- spec/factories/orders.rb
 - spec/factories/estimates.rb
-- spec/factories/parent_technology_type.rb
-- spec/factories/technology_type.rb
-- spec/factories/order_responses.rb
-- spec/factories/estimate_responses.rb
-- spec/factories/allocations.rb
+- spec/factories/create_order_requests.rb
+- spec/factories/create_mass_estimate_requests.rb
 - spec/factories/estimate_list_responses.rb
-- spec/factories/orders.rb
+- spec/factories/order_responses.rb
 - spec/factories/projects.rb
+- spec/factories/technology_type.rb
+- spec/factories/parent_technology_type.rb
 - spec/factories/order_list_responses.rb
-- spec/factories/create_order_requests.rb
-- spec/integration/projects/technology_types_spec.rb
-- spec/integration/orders_spec.rb
+- spec/factories/error_responses.rb
+- spec/factories/allocations.rb
+- spec/factories/project_responses.rb
+- spec/factories/sdgs.rb
+- spec/factories/estimate_responses.rb
+- spec/factories/meta_index_objects.rb
 - spec/integration/projects_spec.rb
 - spec/integration/estimates_spec.rb
-- spec/models/project_spec.rb
-- spec/models/order_response_spec.rb
+- spec/integration/orders_spec.rb
+- spec/integration/projects/technology_types_spec.rb
+- spec/models/estimate_spec.rb
+- spec/models/create_order_request_spec.rb
+- spec/models/create_mass_estimate_request_spec.rb
 - spec/models/error_response_spec.rb
+- spec/models/order_list_response_spec.rb
+- spec/models/order_response_spec.rb
+- spec/models/estimate_response_spec.rb
+- spec/models/order_spec.rb
+- spec/models/project_spec.rb
+- spec/models/project_list_response_spec.rb
 - spec/models/project_response_spec.rb
+- spec/models/allocation_spec.rb
 - spec/models/meta_index_object_spec.rb
-- spec/models/create_mass_estimate_request_spec.rb
 - spec/models/estimate_list_response_spec.rb
-- spec/models/allocation_spec.rb
-- spec/models/create_order_request_spec.rb
-- spec/models/order_list_response_spec.rb
-- spec/models/project_list_response_spec.rb
-- spec/models/estimate_spec.rb
-- spec/models/order_spec.rb
-- spec/models/estimate_response_spec.rb
 - spec/patch_ruby_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared/generated_classes.rb