patch_ruby 1.15.1 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d306d8bd83ffdd48383cdc925e8c0a8ee37db778d519d8541b8ee57e999b18d6
-  data.tar.gz: b107f76975cb46cc0598481ffdc8f8ba4de6a02f6d467009686b29517c391182
+  metadata.gz: 9b155fa6ec075f760c3a917898b8e970995c500ff5b3d31488216e018d98418c
+  data.tar.gz: 212fccee52313135c68c8568df430d6bce2e41de56610c84c5badb2b5c7d13e0
 SHA512:
-  metadata.gz: bf3c7d236266c4df42832a9f7312951e90785d9bd4ba6a76a58b36b7ab41612bef0e9e13493657a6898a836e8e0f746156205e39da9c4a4b6f15acf4ee906eec
-  data.tar.gz: 874b7efa8ddd9dbd677a9a54f35651d13178aeec2b21ec0094e0a7c91b19593d9c7405fb9f9cdf959afac0de7353744ac854a1a0797dde37fd000c71e50fa749
+  metadata.gz: d0af1c92005e56b3a1249cef852bf0cd6005d4e734c9a237bed90c1704f8ef676a725fad3c7d95daee0e83bfbfbaaefedebf7bcc71c69ad3cd7d6d89ae5917f6
+  data.tar.gz: 46bf38a886fd7c4767b3cd5a87794e55b683c0ffeaecd688700b2d9b028460608bff5d355aef0d591807e12208497d9b8cecb13e38c27aba7c81d79e7637fe37

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.17.0] - 2022-01-11
+
+### Changed
+
+- Set the order allocatations array as optional.
+
+## [1.16.1] - 2022-01-07
+
+### Changed
+
+- No feature changes. Updates the openapi-generator version.
+
+## [1.16.0] - 2021-12-07
+
+### Removed
+
+- Removes the `preferences` endpoints (deprecated)
+
+## [1.15.2] - 2021-11-08
+
+### Added
+
+- Adds highlights to project responses
+
 ## [1.15.1] - 2021-11-04
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    patch_ruby (1.15.1)
+    patch_ruby (1.17.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -22,7 +22,7 @@ GEM
       ffi (>= 1.15.0)
     factory_bot (6.2.0)
       activesupport (>= 5.0.0)
-    ffi (1.15.4)
+    ffi (1.15.5)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
@@ -70,6 +70,8 @@ GEM
     zeitwerk (2.4.2)
 
 PLATFORMS
+  arm64-darwin-20
+  arm64-darwin-21
   x86_64-darwin-20
 
 DEPENDENCIES

data/README.md

@@ -53,9 +53,6 @@ end
 
 In Patch, orders represent a purchase of carbon offsets or negative emissions by mass. Place orders directly if you know the amount of carbon dioxide you would like to sequester. If you do not know how much to purchase, use an estimate.
 
-In Patch, orders represent a purchase of carbon offsets or negative emissions by mass.
-Place orders directly if you know the amount of carbon dioxide you would like to sequester.
-If you do not know how much to purchase, use an estimate.
 You can also create an order with a maximum desired price, and we'll allocate enough mass to
 fulfill the order for you.
 
@@ -218,7 +215,13 @@ page = 1 # Pass in which page of preferences you'd like
 Patch::Preference.retrieve_preferences(page: page)
 ```
 
-## Development
+## Contributing
+
+While we value open-source contributions to this SDK, the core of this library is generated programmatically. Complex additions made directly to the library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
+
+On the other hand, contributions to the README, as well as new test cases are always very welcome!
+
+### Testing locally
 
 To build the gem locally, run:
 
@@ -232,20 +235,16 @@ This will create a .gem file. To install the local gem:
 gem install patch_ruby-1.x.x.gem
 ```
 
-Install dependencies:
-
-```bash
-bundle install
-```
+### Running tests
 
-Set up required environment variables:
+Set up the required environment variable.
 
 ```bash
 export SANDBOX_API_KEY=<SANDBOX API KEY>
 ```
 
-Run tests:
+then run the tests:
 
 ```bash
-bundle exec rspec
+make test
 ```

data/lib/patch_ruby/api/estimates_api.rb

@@ -4,9 +4,9 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 
@@ -65,7 +65,10 @@ module Patch
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      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] || {}
@@ -131,7 +134,10 @@ module Patch
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      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] || {}
@@ -197,7 +203,10 @@ module Patch
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      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] || {}
@@ -263,7 +272,10 @@ module Patch
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      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] || {}
@@ -329,7 +341,10 @@ module Patch
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      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] || {}
@@ -395,7 +410,10 @@ module Patch
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      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] || {}
@@ -432,7 +450,7 @@ module Patch
     # @param [Hash] opts the optional parameters
     # @return [EstimateResponse]
     def retrieve_estimate(id, opts = {})
-      
+    
       data, _status_code, _headers = retrieve_estimate_with_http_info(id, opts)
       data
     end
@@ -496,7 +514,7 @@ module Patch
     # @option opts [Integer] :page 
     # @return [EstimateListResponse]
     def retrieve_estimates(opts = {})
-      
+    
       data, _status_code, _headers = retrieve_estimates_with_http_info(opts)
       data
     end

data/lib/patch_ruby/api/orders_api.rb

@@ -4,9 +4,9 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 
@@ -33,7 +33,7 @@ module Patch
     # @param [Hash] opts the optional parameters
     # @return [OrderResponse]
     def cancel_order(id, opts = {})
-      
+    
       data, _status_code, _headers = cancel_order_with_http_info(id, opts)
       data
     end
@@ -126,7 +126,10 @@ module Patch
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      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] || {}
@@ -163,7 +166,7 @@ module Patch
     # @param [Hash] opts the optional parameters
     # @return [OrderResponse]
     def place_order(id, opts = {})
-      
+    
       data, _status_code, _headers = place_order_with_http_info(id, opts)
       data
     end
@@ -227,7 +230,7 @@ module Patch
     # @param [Hash] opts the optional parameters
     # @return [OrderResponse]
     def retrieve_order(id, opts = {})
-      
+    
       data, _status_code, _headers = retrieve_order_with_http_info(id, opts)
       data
     end
@@ -294,7 +297,7 @@ module Patch
     # @option opts [String] :metadata_example2 
     # @return [OrderListResponse]
     def retrieve_orders(opts = {})
-      
+    
       data, _status_code, _headers = retrieve_orders_with_http_info(opts)
       data
     end

data/lib/patch_ruby/api/projects_api.rb

@@ -4,9 +4,9 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 
@@ -30,7 +30,7 @@ module Patch
     # @param [Hash] opts the optional parameters
     # @return [ProjectResponse]
     def retrieve_project(id, opts = {})
-      
+    
       data, _status_code, _headers = retrieve_project_with_http_info(id, opts)
       data
     end
@@ -97,7 +97,7 @@ module Patch
     # @option opts [Integer] :minimum_available_mass 
     # @return [ProjectListResponse]
     def retrieve_projects(opts = {})
-      
+    
       data, _status_code, _headers = retrieve_projects_with_http_info(opts)
       data
     end

data/lib/patch_ruby/api/technology_types_api.rb

@@ -4,9 +4,9 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 
@@ -28,7 +28,7 @@ module Patch
     # @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

data/lib/patch_ruby/api_client.rb

@@ -4,9 +4,9 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 
@@ -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.15.1"
+      @user_agent = "patch-ruby/1.17.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -296,7 +296,7 @@ module Patch
       @config.base_url(opts[:operation]) + path
     end
 
-    # Update hearder and query params based on authentication settings.
+    # Update header and query params based on authentication settings.
     #
     # @param [Hash] header_params Header parameters
     # @param [Hash] query_params Query parameters
@@ -335,8 +335,8 @@ module Patch
     # @param [Array] content_types array for Content-Type
     # @return [String] the Content-Type header  (e.g. application/json)
     def select_header_content_type(content_types)
-      # use application/json by default
-      return 'application/json' if content_types.nil? || content_types.empty?
+      # return nil by default
+      return if content_types.nil? || content_types.empty?
       # use JSON when present, otherwise use the first one
       json_content_type = content_types.find { |s| json_mime?(s) }
       json_content_type || content_types.first

data/lib/patch_ruby/api_error.rb

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

data/lib/patch_ruby/configuration.rb

@@ -4,9 +4,9 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 
@@ -147,13 +147,13 @@ module Patch
       @server_operation_variables = {}
       @api_key = {}
       @api_key_prefix = {}
-      @timeout = 0
       @client_side_validation = true
       @verify_ssl = true
       @verify_ssl_host = true
       @params_encoding = nil
       @cert_file = nil
       @key_file = nil
+      @timeout = 0
       @debugging = false
       @inject_format = false
       @force_ending_format = false
@@ -229,12 +229,12 @@ module Patch
     def server_settings
       [
         {
-          url: "https://{defaultHost}",
+          url: "{defaultUrl}",
           description: "No description provided",
           variables: {
-            defaultHost: {
+            defaultUrl: {
                 description: "No description provided",
-                default_value: "api.patch.io",
+                default_value: "https://api.patch.io",
               }
             }
         }

data/lib/patch_ruby/models/allocation.rb

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

data/lib/patch_ruby/models/create_bitcoin_estimate_request.rb

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

data/lib/patch_ruby/models/create_ethereum_estimate_request.rb

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

data/lib/patch_ruby/models/create_flight_estimate_request.rb

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

data/lib/patch_ruby/models/create_mass_estimate_request.rb

@@ -4,9 +4,9 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 
@@ -101,8 +101,8 @@ module Patch
         invalid_properties.push('invalid value for "mass_g", mass_g cannot be nil.')
       end
 
-      if @mass_g > 2000000000
-        invalid_properties.push('invalid value for "mass_g", must be smaller than or equal to 2000000000.')
+      if @mass_g > 100000000000
+        invalid_properties.push('invalid value for "mass_g", must be smaller than or equal to 100000000000.')
       end
 
       if @mass_g < 0
@@ -116,7 +116,7 @@ module Patch
     # @return true if the model is valid
     def valid?
       return false if @mass_g.nil?
-      return false if @mass_g > 2000000000
+      return false if @mass_g > 100000000000
       return false if @mass_g < 0
       true
     end
@@ -128,8 +128,8 @@ module Patch
         fail ArgumentError, 'mass_g cannot be nil'
       end
 
-      if mass_g > 2000000000
-        fail ArgumentError, 'invalid value for "mass_g", must be smaller than or equal to 2000000000.'
+      if mass_g > 100000000000
+        fail ArgumentError, 'invalid value for "mass_g", must be smaller than or equal to 100000000000.'
       end
 
       if mass_g < 0

data/lib/patch_ruby/models/create_order_request.rb

@@ -4,9 +4,9 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 
@@ -102,8 +102,8 @@ module Patch
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if !@mass_g.nil? && @mass_g > 2000000000
-        invalid_properties.push('invalid value for "mass_g", must be smaller than or equal to 2000000000.')
+      if !@mass_g.nil? && @mass_g > 100000000000
+        invalid_properties.push('invalid value for "mass_g", must be smaller than or equal to 100000000000.')
       end
 
       if !@mass_g.nil? && @mass_g < 0
@@ -120,7 +120,7 @@ module Patch
     # 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 !@mass_g.nil? && @mass_g > 2000000000
+      return false if !@mass_g.nil? && @mass_g > 100000000000
       return false if !@mass_g.nil? && @mass_g < 0
       return false if !@total_price_cents_usd.nil? && @total_price_cents_usd < 1
       true
@@ -129,8 +129,8 @@ module Patch
     # Custom attribute writer method with validation
     # @param [Object] mass_g Value to be assigned
     def mass_g=(mass_g)
-      if !mass_g.nil? && mass_g > 2000000000
-        fail ArgumentError, 'invalid value for "mass_g", must be smaller than or equal to 2000000000.'
+      if !mass_g.nil? && mass_g > 100000000000
+        fail ArgumentError, 'invalid value for "mass_g", must be smaller than or equal to 100000000000.'
       end
 
       if !mass_g.nil? && mass_g < 0

data/lib/patch_ruby/models/create_shipping_estimate_request.rb

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

data/lib/patch_ruby/models/create_success_response.rb

@@ -4,9 +4,9 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 
@@ -43,6 +43,7 @@ module Patch
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'error'
       ])
     end
 
@@ -90,10 +91,6 @@ module Patch
         invalid_properties.push('invalid value for "success", success cannot be nil.')
       end
 
-      if @error.nil?
-        invalid_properties.push('invalid value for "error", error cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -101,7 +98,6 @@ module Patch
     # @return true if the model is valid
     def valid?
       return false if @success.nil?
-      return false if @error.nil?
       true
     end
 

data/lib/patch_ruby/models/create_vehicle_estimate_request.rb

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

data/lib/patch_ruby/models/error_response.rb

@@ -4,9 +4,9 @@
 #The core API used to integrate with Patch's service
 
 The version of the OpenAPI document: v1
-Contact: developers@usepatch.com
+Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 
@@ -47,6 +47,7 @@ module Patch
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'error',
         :'data'
       ])
     end
@@ -99,10 +100,6 @@ module Patch
         invalid_properties.push('invalid value for "success", success cannot be nil.')
       end
 
-      if @error.nil?
-        invalid_properties.push('invalid value for "error", error cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -110,7 +107,6 @@ module Patch
     # @return true if the model is valid
     def valid?
       return false if @success.nil?
-      return false if @error.nil?
       true
     end