From 9c224a535251e65eb806148dfec1834fe8d0da15 Mon Sep 17 00:00:00 2001 From: Brett Holt Date: Wed, 10 Aug 2022 15:07:29 -0700 Subject: [PATCH] Add /estimates/ecommerce API support (#71) --- CHANGELOG.md | 6 + Gemfile.lock | 2 +- README.md | 22 +- lib/patch_ruby.rb | 1 + lib/patch_ruby/api/estimates_api.rb | 70 ++++ lib/patch_ruby/api_client.rb | 2 +- .../create_air_shipping_estimate_request.rb | 2 +- .../create_ecommerce_estimate_request.rb | 373 ++++++++++++++++++ .../create_rail_shipping_estimate_request.rb | 2 +- .../create_road_shipping_estimate_request.rb | 2 +- .../create_sea_shipping_estimate_request.rb | 2 +- lib/patch_ruby/version.rb | 2 +- spec/integration/estimates_spec.rb | 14 + 13 files changed, 482 insertions(+), 18 deletions(-) create mode 100644 lib/patch_ruby/models/create_ecommerce_estimate_request.rb diff --git a/CHANGELOG.md b/CHANGELOG.md index 26d1934..ba955c2 100644 --- a/CHANGELOG.md +++ b/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 diff --git a/Gemfile.lock b/Gemfile.lock index 8713add..296fb4a 100644 --- a/Gemfile.lock +++ b/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 diff --git a/README.md b/README.md index 4f143aa..bdf2003 100644 --- a/README.md +++ b/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) diff --git a/lib/patch_ruby.rb b/lib/patch_ruby.rb index 1364195..4832994 100644 --- a/lib/patch_ruby.rb +++ b/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' diff --git a/lib/patch_ruby/api/estimates_api.rb b/lib/patch_ruby/api/estimates_api.rb index 7569368..270e562 100644 --- a/lib/patch_ruby/api/estimates_api.rb +++ b/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] diff --git a/lib/patch_ruby/api_client.rb b/lib/patch_ruby/api_client.rb index 3a8ff83..3efcd7a 100644 --- a/lib/patch_ruby/api_client.rb +++ b/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 diff --git a/lib/patch_ruby/models/create_air_shipping_estimate_request.rb b/lib/patch_ruby/models/create_air_shipping_estimate_request.rb index 151ae67..565b354 100644 --- a/lib/patch_ruby/models/create_air_shipping_estimate_request.rb +++ b/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') diff --git a/lib/patch_ruby/models/create_ecommerce_estimate_request.rb b/lib/patch_ruby/models/create_ecommerce_estimate_request.rb new file mode 100644 index 0000000..194f7a1 --- /dev/null +++ b/lib/patch_ruby/models/create_ecommerce_estimate_request.rb @@ -0,0 +1,373 @@ +=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 CreateEcommerceEstimateRequest + attr_accessor :distance_m + + attr_accessor :package_mass_g + + attr_accessor :transportation_method + + attr_accessor :project_id + + attr_accessor :create_order + + 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 + { + :'distance_m' => :'distance_m', + :'package_mass_g' => :'package_mass_g', + :'transportation_method' => :'transportation_method', + :'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 + { + :'distance_m' => :'Integer', + :'package_mass_g' => :'Integer', + :'transportation_method' => :'String', + :'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::CreateEcommerceEstimateRequestsApi::OPERATIONS') && Patch::CreateEcommerceEstimateRequestsApi::OPERATIONS.include?(message) + Patch::CreateEcommerceEstimateRequestsApi.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::CreateEcommerceEstimateRequest` 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::CreateEcommerceEstimateRequest`. 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?(:'distance_m') + self.distance_m = attributes[:'distance_m'] + end + + if attributes.key?(:'package_mass_g') + self.package_mass_g = attributes[:'package_mass_g'] + end + + if attributes.key?(:'transportation_method') + self.transportation_method = attributes[:'transportation_method'] + 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 @distance_m.nil? + invalid_properties.push('invalid value for "distance_m", distance_m cannot be nil.') + end + + if @distance_m > 400000000 + invalid_properties.push('invalid value for "distance_m", must be smaller than or equal to 400000000.') + end + + if @distance_m < 0 + invalid_properties.push('invalid value for "distance_m", must be greater than or equal to 0.') + end + + if @package_mass_g.nil? + invalid_properties.push('invalid value for "package_mass_g", package_mass_g cannot be nil.') + end + + if @package_mass_g > 2000000000 + invalid_properties.push('invalid value for "package_mass_g", must be smaller than or equal to 2000000000.') + end + + if @package_mass_g < 0 + invalid_properties.push('invalid value for "package_mass_g", must be greater than or equal to 0.') + end + + if @transportation_method.nil? + invalid_properties.push('invalid value for "transportation_method", transportation_method 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 @distance_m.nil? + return false if @distance_m > 400000000 + return false if @distance_m < 0 + return false if @package_mass_g.nil? + return false if @package_mass_g > 2000000000 + return false if @package_mass_g < 0 + return false if @transportation_method.nil? + transportation_method_validator = EnumAttributeValidator.new('String', ["air", "rail", "road", "sea"]) + return false unless transportation_method_validator.valid?(@transportation_method) + true + end + + # Custom attribute writer method with validation + # @param [Object] distance_m Value to be assigned + def distance_m=(distance_m) + if distance_m.nil? + fail ArgumentError, 'distance_m cannot be nil' + end + + if distance_m > 400000000 + fail ArgumentError, 'invalid value for "distance_m", must be smaller than or equal to 400000000.' + end + + if distance_m < 0 + fail ArgumentError, 'invalid value for "distance_m", must be greater than or equal to 0.' + end + + @distance_m = distance_m + end + + # Custom attribute writer method with validation + # @param [Object] package_mass_g Value to be assigned + def package_mass_g=(package_mass_g) + if package_mass_g.nil? + fail ArgumentError, 'package_mass_g cannot be nil' + end + + if package_mass_g > 2000000000 + fail ArgumentError, 'invalid value for "package_mass_g", must be smaller than or equal to 2000000000.' + end + + if package_mass_g < 0 + fail ArgumentError, 'invalid value for "package_mass_g", must be greater than or equal to 0.' + end + + @package_mass_g = package_mass_g + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] transportation_method Object to be assigned + def transportation_method=(transportation_method) + validator = EnumAttributeValidator.new('String', ["air", "rail", "road", "sea"]) + unless validator.valid?(transportation_method) + fail ArgumentError, "invalid value for \"transportation_method\", must be one of #{validator.allowable_values}." + end + @transportation_method = transportation_method + 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 && + distance_m == o.distance_m && + package_mass_g == o.package_mass_g && + transportation_method == o.transportation_method && + 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 + [distance_m, package_mass_g, transportation_method, 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<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\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 diff --git a/lib/patch_ruby/models/create_rail_shipping_estimate_request.rb b/lib/patch_ruby/models/create_rail_shipping_estimate_request.rb index c8a1365..a8b78e9 100644 --- a/lib/patch_ruby/models/create_rail_shipping_estimate_request.rb +++ b/lib/patch_ruby/models/create_rail_shipping_estimate_request.rb @@ -178,7 +178,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') diff --git a/lib/patch_ruby/models/create_road_shipping_estimate_request.rb b/lib/patch_ruby/models/create_road_shipping_estimate_request.rb index 48c9367..44fbac2 100644 --- a/lib/patch_ruby/models/create_road_shipping_estimate_request.rb +++ b/lib/patch_ruby/models/create_road_shipping_estimate_request.rb @@ -196,7 +196,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?(:'freight_mass_g') diff --git a/lib/patch_ruby/models/create_sea_shipping_estimate_request.rb b/lib/patch_ruby/models/create_sea_shipping_estimate_request.rb index cda9b94..3d78579 100644 --- a/lib/patch_ruby/models/create_sea_shipping_estimate_request.rb +++ b/lib/patch_ruby/models/create_sea_shipping_estimate_request.rb @@ -186,7 +186,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?(:'freight_mass_g') diff --git a/lib/patch_ruby/version.rb b/lib/patch_ruby/version.rb index 76436f8..e8182e8 100644 --- a/lib/patch_ruby/version.rb +++ b/lib/patch_ruby/version.rb @@ -11,5 +11,5 @@ =end module Patch - VERSION = '1.24.1' + VERSION = '1.24.2' end diff --git a/spec/integration/estimates_spec.rb b/spec/integration/estimates_spec.rb index 9b12ed2..3b78a67 100644 --- a/spec/integration/estimates_spec.rb +++ b/spec/integration/estimates_spec.rb @@ -171,6 +171,20 @@ expect(create_estimate_response.data.id).not_to be_nil end + it 'supports creating ecommerce estimates' do + distance_m = 100_000_000 + package_mass_g = 10_000 + create_estimate_response = Patch::Estimate.create_ecommerce_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 'ecommerce' + expect(create_estimate_response.data.mass_g).to be >= 10_000 + end + context "when creating an air shipping estimate" do it "supports creating an estimate using airports" do air_shipping_estimate = Patch::Estimate.create_air_shipping_estimate(