patch_ruby 1.12.0 → 1.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4c6622c9c97768d2c233d87f9ce0dbfab9fc74f7e4f0ac580754cacf9d892c8
-  data.tar.gz: eb8743d767c0bc0116ea6a36a4b6e1a160d986ddde64942d4c4e056c47987ed4
+  metadata.gz: d306d8bd83ffdd48383cdc925e8c0a8ee37db778d519d8541b8ee57e999b18d6
+  data.tar.gz: b107f76975cb46cc0598481ffdc8f8ba4de6a02f6d467009686b29517c391182
 SHA512:
-  metadata.gz: fbde5884a5facbdc44de9b3bbb44ed3f001bdb4ee094ff173603bc784a269b31ccc57be17756239b8cb51f5912954d0ab7ada18ca5eae80e965c224b17f112fc
-  data.tar.gz: 435315b6ba7b76b5ffe84a4a5924c52ceafdaa6efe7fc4fb4bbe19fd722d06c73b810c7f577787ed15d7e91635df34aa792d63dcd03c373254a306f22a6b43f8
+  metadata.gz: bf3c7d236266c4df42832a9f7312951e90785d9bd4ba6a76a58b36b7ab41612bef0e9e13493657a6898a836e8e0f746156205e39da9c4a4b6f15acf4ee906eec
+  data.tar.gz: 874b7efa8ddd9dbd677a9a54f35651d13178aeec2b21ec0094e0a7c91b19593d9c7405fb9f9cdf959afac0de7353744ac854a1a0797dde37fd000c71e50fa749

data/CHANGELOG.md

@@ -5,6 +5,30 @@ 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.15.1] - 2021-11-04
+
+### Added
+
+- Adds verifier to project responses
+
+## [1.15.0] - 2021-10-04
+
+### Added
+
+- Added the ability to fetch project technology types via `Patch::TechnologyType.retrieve_technology_types()`
+
+## [1.14.0] - 2021-09-21
+
+### Added
+
+- Adds mechanism, tagline, state, latitude, longitude, and technology_type to project responses
+
+## [1.13.0] - 2021-09-10
+
+### Added
+
+- Adds ability to create Bitcoin and Ethereum estimates using the daily balance held.
+
 ## [1.12.0] - 2021-09-08
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    patch_ruby (1.12.0)
+    patch_ruby (1.15.1)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -18,7 +18,7 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    ethon (0.14.0)
+    ethon (0.15.0)
       ffi (>= 1.15.0)
     factory_bot (6.2.0)
       activesupport (>= 5.0.0)

data/lib/patch_ruby/api/estimates_api.rb

@@ -96,7 +96,7 @@ module Patch
       return data, status_code, headers
     end
 
-    # Create an ethereum estimate given a timestamp and gas used
+    # Create an ethereum estimate
     # Creates an ethereum estimate for the amount of CO2 to be compensated. An order in the `draft` state may be created based on the parameters, linked to the estimate. 
     # @param create_ethereum_estimate_request [CreateEthereumEstimateRequest] 
     # @param [Hash] opts the optional parameters
@@ -107,7 +107,7 @@ module Patch
       data
     end
 
-    # Create an ethereum estimate given a timestamp and gas used
+    # Create an ethereum estimate
     # Creates an ethereum estimate for the amount of CO2 to be compensated. An order in the `draft` state may be created based on the parameters, linked to the estimate. 
     # @param create_ethereum_estimate_request [CreateEthereumEstimateRequest] 
     # @param [Hash] opts the optional parameters

data/lib/patch_ruby/api/technology_types_api.rb

@@ -0,0 +1,84 @@
+=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 'cgi'
+
+module Patch
+  class TechnologyTypesApi
+    OPERATIONS = [
+      :retrieve_technology_types,
+    ]
+
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Retrieves the list of technology_types
+    # Retrieves a list of all technology_types. 
+    # @param [Hash] opts the optional parameters
+    # @return [TechnologyTypeListResponse]
+    def retrieve_technology_types(opts = {})
+      
+      data, _status_code, _headers = retrieve_technology_types_with_http_info(opts)
+      data
+    end
+
+    # Retrieves the list of technology_types
+    # Retrieves a list of all technology_types. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TechnologyTypeListResponse, Integer, Hash)>] TechnologyTypeListResponse data, response status code and response headers
+    def retrieve_technology_types_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TechnologyTypesApi.retrieve_technology_types ...'
+      end
+      # resource path
+      local_var_path = '/v1/projects/technology_types'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TechnologyTypeListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :operation => :"TechnologyTypesApi.retrieve_technology_types",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TechnologyTypesApi#retrieve_technology_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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.12.0"
+      @user_agent = "patch-ruby/1.15.1"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/patch_ruby/models/create_bitcoin_estimate_request.rb

@@ -19,6 +19,8 @@ module Patch
 
     attr_accessor :transaction_value_btc_sats
 
+    attr_accessor :average_daily_balance_btc_sats
+
     attr_accessor :project_id
 
     attr_accessor :create_order
@@ -28,6 +30,7 @@ module Patch
       {
         :'timestamp' => :'timestamp',
         :'transaction_value_btc_sats' => :'transaction_value_btc_sats',
+        :'average_daily_balance_btc_sats' => :'average_daily_balance_btc_sats',
         :'project_id' => :'project_id',
         :'create_order' => :'create_order'
       }
@@ -43,6 +46,7 @@ module Patch
       {
         :'timestamp' => :'Time',
         :'transaction_value_btc_sats' => :'Integer',
+        :'average_daily_balance_btc_sats' => :'Integer',
         :'project_id' => :'String',
         :'create_order' => :'Boolean'
       }
@@ -53,6 +57,7 @@ module Patch
       Set.new([
         :'timestamp',
         :'transaction_value_btc_sats',
+        :'average_daily_balance_btc_sats',
         :'project_id',
         :'create_order'
       ])
@@ -93,12 +98,18 @@ module Patch
         self.transaction_value_btc_sats = attributes[:'transaction_value_btc_sats']
       end
 
+      if attributes.key?(:'average_daily_balance_btc_sats')
+        self.average_daily_balance_btc_sats = attributes[:'average_daily_balance_btc_sats']
+      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
 
@@ -122,6 +133,7 @@ module Patch
       self.class == o.class &&
           timestamp == o.timestamp &&
           transaction_value_btc_sats == o.transaction_value_btc_sats &&
+          average_daily_balance_btc_sats == o.average_daily_balance_btc_sats &&
           project_id == o.project_id &&
           create_order == o.create_order
     end
@@ -135,7 +147,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [timestamp, transaction_value_btc_sats, project_id, create_order].hash
+      [timestamp, transaction_value_btc_sats, average_daily_balance_btc_sats, project_id, create_order].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/create_ethereum_estimate_request.rb

@@ -21,6 +21,8 @@ module Patch
 
     attr_accessor :transaction_value_eth_gwei
 
+    attr_accessor :average_daily_balance_eth_gwei
+
     attr_accessor :project_id
 
     attr_accessor :create_order
@@ -31,6 +33,7 @@ module Patch
         :'timestamp' => :'timestamp',
         :'gas_used' => :'gas_used',
         :'transaction_value_eth_gwei' => :'transaction_value_eth_gwei',
+        :'average_daily_balance_eth_gwei' => :'average_daily_balance_eth_gwei',
         :'project_id' => :'project_id',
         :'create_order' => :'create_order'
       }
@@ -47,6 +50,7 @@ module Patch
         :'timestamp' => :'String',
         :'gas_used' => :'Integer',
         :'transaction_value_eth_gwei' => :'Integer',
+        :'average_daily_balance_eth_gwei' => :'Integer',
         :'project_id' => :'String',
         :'create_order' => :'Boolean'
       }
@@ -58,6 +62,7 @@ module Patch
         :'timestamp',
         :'gas_used',
         :'transaction_value_eth_gwei',
+        :'average_daily_balance_eth_gwei',
         :'project_id',
         :'create_order'
       ])
@@ -102,12 +107,18 @@ module Patch
         self.transaction_value_eth_gwei = attributes[:'transaction_value_eth_gwei']
       end
 
+      if attributes.key?(:'average_daily_balance_eth_gwei')
+        self.average_daily_balance_eth_gwei = attributes[:'average_daily_balance_eth_gwei']
+      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
 
@@ -132,6 +143,7 @@ module Patch
           timestamp == o.timestamp &&
           gas_used == o.gas_used &&
           transaction_value_eth_gwei == o.transaction_value_eth_gwei &&
+          average_daily_balance_eth_gwei == o.average_daily_balance_eth_gwei &&
           project_id == o.project_id &&
           create_order == o.create_order
     end
@@ -145,7 +157,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [timestamp, gas_used, transaction_value_eth_gwei, project_id, create_order].hash
+      [timestamp, gas_used, transaction_value_eth_gwei, average_daily_balance_eth_gwei, project_id, create_order].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/create_flight_estimate_request.rb

@@ -135,6 +135,8 @@ module Patch
 
       if attributes.key?(:'create_order')
         self.create_order = attributes[:'create_order']
+      else
+        self.create_order = false
       end
     end
 

data/lib/patch_ruby/models/create_mass_estimate_request.rb

@@ -84,6 +84,8 @@ module Patch
 
       if attributes.key?(:'create_order')
         self.create_order = attributes[:'create_order']
+      else
+        self.create_order = false
       end
 
       if attributes.key?(:'project_id')

data/lib/patch_ruby/models/create_shipping_estimate_request.rb

@@ -127,6 +127,8 @@ module Patch
 
       if attributes.key?(:'create_order')
         self.create_order = attributes[:'create_order']
+      else
+        self.create_order = false
       end
     end
 

data/lib/patch_ruby/models/create_vehicle_estimate_request.rb

@@ -116,6 +116,8 @@ module Patch
 
       if attributes.key?(:'create_order')
         self.create_order = attributes[:'create_order']
+      else
+        self.create_order = false
       end
     end
 

data/lib/patch_ruby/models/order.rb

@@ -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.

data/lib/patch_ruby/models/parent_technology_type.rb

@@ -0,0 +1,240 @@
+=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 '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
+
+    # Name of this technology type.
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'slug' => :'slug',
+        :'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
+      {
+        :'slug' => :'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::ParentTechnologyTypesApi::OPERATIONS') && Patch::ParentTechnologyTypesApi::OPERATIONS.include?(message)
+        Patch::ParentTechnologyTypesApi.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::ParentTechnologyType` 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::ParentTechnologyType`. 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?(:'slug')
+        self.slug = attributes[:'slug']
+      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
+      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?
+      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 &&
+          slug == o.slug &&
+          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
+      [slug, 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