Add /estimates/ecommerce API support (#71)

Author: Brett Holt

CHANGELOG.md

@@ -5,6 +5,12 @@ 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.24.2] - 2022-08-10
+
+### Added
+
+- Adds `Patch::Estimate.create_ecommerce_estimate` method
+
 ## [1.24.0] - 2022-07-22
 
 ### Added

Gemfile.lock

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

README.md

@@ -127,16 +127,6 @@ Patch::Estimate.create_mass_estimate(mass_g: mass)
 distance_m = 1_000_000 # Pass in the distance traveled in meters
 Patch::Estimate.create_flight_estimate(distance_m: distance_m)
 
-# Create a shipping estimate
-distance_m = 1_000_000 # Pass in the shipping distance in meters
-package_mass_g = 10_000 # Pass in the weight of the package shipped in grams
-transportation_method = "air" # Pass in the transportation method (air, rail, road, sea)
-Patch::Estimate.create_shipping_estimate(
-  distance_m: distance_m,
-  package_mass_g: package_mass_g,
-  transportation_method: transportation_method
-)
-
 # Create a vehicle estimate
 distance_m = 1_000_000 # Pass in the shipping distance in meters
 make = "Toyota" # Pass in the car make
@@ -149,10 +139,20 @@ Patch::Estimate.create_vehicle_estimate(
   year: year
 )
 
-# Create a flight estimate
+# Create a Bitcoin estimate
 transaction_value_btc_sats = 1000; # [Optional] Pass in the transaction value in satoshis
 Patch::Estimate.create_bitcoin_estimate(transaction_value_btc_sats: transaction_value_btc_sats)
 
+# Create an ecommerce estimate
+distance_m = 1_000_000 # Pass in the shipping distance in meters
+package_mass_g = 10_000 # Pass in the weight of the package shipped in grams
+transportation_method = "air" # Pass in the transportation method (air, rail, road, sea)
+Patch::Estimate.create_ecommerce_estimate(
+  distance_m: distance_m,
+  package_mass_g: package_mass_g,
+  transportation_method: transportation_method
+)
+
 ## You can also specify a project-id field (optional) to be used instead of the preferred one
 project_id = 'pro_test_1234' # Pass in the project's ID
 Patch::Estimate.create_mass_estimate(mass_g: mass, project_id: project_id)

lib/patch_ruby.rb

@@ -20,6 +20,7 @@
 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'
 require 'patch_ruby/models/create_ethereum_estimate_request'
 require 'patch_ruby/models/create_flight_estimate_request'
 require 'patch_ruby/models/create_hotel_estimate_request'

lib/patch_ruby/api/estimates_api.rb

@@ -17,6 +17,7 @@ class EstimatesApi
     OPERATIONS = [
       :create_air_shipping_estimate,
       :create_bitcoin_estimate,
+      :create_ecommerce_estimate,
       :create_ethereum_estimate,
       :create_flight_estimate,
       :create_hotel_estimate,
@@ -173,6 +174,75 @@ def create_bitcoin_estimate_with_http_info(create_bitcoin_estimate_request, opts
       return data, status_code, headers
     end
 
+    # Create an e-commerce estimate given the distance traveled in meters, package weight, and transportation method.
+    # Creates a e-commerce estimate for the amount of CO2 to be compensated. An order in the `draft` state may be created based on the parameters. 
+    # @param create_ecommerce_estimate_request [CreateEcommerceEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [EstimateResponse]
+    def create_ecommerce_estimate(create_ecommerce_estimate_request = {}, opts = {})
+      _create_ecommerce_estimate_request = Patch::CreateEcommerceEstimateRequest.new(create_ecommerce_estimate_request) 
+      data, _status_code, _headers = create_ecommerce_estimate_with_http_info(_create_ecommerce_estimate_request, opts)
+      data
+    end
+
+    # Create an e-commerce estimate given the distance traveled in meters, package weight, and transportation method.
+    # Creates a e-commerce estimate for the amount of CO2 to be compensated. An order in the `draft` state may be created based on the parameters. 
+    # @param create_ecommerce_estimate_request [CreateEcommerceEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EstimateResponse, Integer, Hash)>] EstimateResponse data, response status code and response headers
+    def create_ecommerce_estimate_with_http_info(create_ecommerce_estimate_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EstimatesApi.create_ecommerce_estimate ...'
+      end
+      # verify the required parameter 'create_ecommerce_estimate_request' is set
+      if @api_client.config.client_side_validation && create_ecommerce_estimate_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_ecommerce_estimate_request' when calling EstimatesApi.create_ecommerce_estimate"
+      end
+      # resource path
+      local_var_path = '/v1/estimates/ecommerce'
+
+      # 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_ecommerce_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_ecommerce_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_ecommerce_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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] 

lib/patch_ruby/api_client.rb

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

lib/patch_ruby/models/create_air_shipping_estimate_request.rb

@@ -151,7 +151,7 @@ def initialize(attributes = {})
       if attributes.key?(:'emissions_scope')
         self.emissions_scope = attributes[:'emissions_scope']
       else
-        self.emissions_scope = 'wtw'
+        self.emissions_scope = 'ttw'
       end
 
       if attributes.key?(:'project_id')