patch_ruby 1.20.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e38c237237f243dcdefd64f39b87d2f052f5df647ba2c160971f68757bfdfc4
-  data.tar.gz: b129e13caef807d8c28ec975173881fb78a39df1a2c979d55958e3409a262f8d
+  metadata.gz: 025a65865a5414587e8820d3cb5d236859e543e9047f6695279e1be22d789c52
+  data.tar.gz: bb4cb5ce332b266de2cbe6cc4ca59d41335a1e216a654e3057c9c613622e8eaf
 SHA512:
-  metadata.gz: 8b2e3c8486b47e5a3b7c7f7fd773f83773ffcab9da7c11d0fa04ea0ec29127179b81d76d68e383a2a4816aeb26fef7e23243e2c32b8b48b09f285e1d0f235383
-  data.tar.gz: 0a7d3ce9b60026bfaab7687785e34f4397e7d7c4fb5fe4095b8003918f32cae12bfe092ef426b6ba580ad5cfafae408b02fd2b06675600a400249496294146f7
+  metadata.gz: d0bcea18ad0b42d5f997c2021c5d40925f40158b4eb8c6d8f185162d89d9d956e0a01fe8bd28f8f6741f6144b176cbdd6df2d4034f65371a6aec92e521e60756
+  data.tar.gz: bc4e566299bc9534b41d2339a8d75df40a74398d64a672c17f3560feb0dad65efa0840202aff644ecdbc4c1272c08e621455a5841d7ba1b353c3cd27454a2d55

data/CHANGELOG.md

@@ -5,6 +5,33 @@ 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.23.0] - 2022-06-03
+
+### Added
+
+- Adds support for the `issued_to` parameter on `orders`, to add support for creating and placing orders on behalf of another party.
+
+## [1.22.0] - 2022-05-16
+
+### Added
+
+- Adds support for the `accept_language` option on `projects`, to add support for the `Accept-Language` header.
+
+## [1.21.0] - 2022-05-03
+
+### Added
+
+- Adds optional `total_price` and `currency` field to `order` creation
+- Adds optional `amount` and `unit` field to `order` creation
+- Adds inventory to `project` responses
+- Adds inventory to `order` responses
+
+### Changed
+
+- Deprecates `mass_g` and `total_price_cents_usd` fields for create `order` requests
+- Deprecates `average_price_per_tonne_cents_usd` and `remaining_mass_g` from `project` responses
+- Deprecates `price_cents_usd`, `patch_fee_cents_usd`, and `mass_g` from `order` responses
+
 ## [1.20.0] - 2022-04-18
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    patch_ruby (1.20.0)
+    patch_ruby (1.23.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -73,6 +73,8 @@ PLATFORMS
   arm64-darwin-20
   arm64-darwin-21
   x86_64-darwin-20
+  x86_64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   factory_bot (~> 6.2)

data/README.md

@@ -51,9 +51,9 @@ end
 
 ### Orders
 
-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 amount. 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
+You can also create an order with a maximum desired price, and we'll allocate enough to
 fulfill the order for you.
 
 [API Reference](https://docs.patch.io/#/?id=orders)
@@ -62,23 +62,31 @@ fulfill the order for you.
 
 ```ruby
 # Create an order - you can create an order
-# providing either mass_g or total_price_cents_usd, but not both
+# providing either amount (and unit) or total_price (and currency), but not both
 
-# Create order with mass
-mass = 1_000_000 # Pass in the mass in grams (i.e. 1 metric tonne)
-Patch::Order.create_order(mass_g: mass)
+# Create order with amount
+amount = 1_000_000 # Pass in the amount in unit specified
+unit = "g"
+Patch::Order.create_order(amount: amount, unit: unit)
+
+# Create an order with total price
+total_price = 5_00 # Pass in the total price in smallest currency unit (ie cents for USD).
+currency = "USD"
+Patch::Order.create_order(total_price: total_price, currency: currency)
 
-# Create an order with maximum total price
-total_price_cents_usd = 5_00 # Pass in the total price in cents (i.e. 5 dollars)
-Patch::Order.create_order(total_price_cents_usd: total_price_cents_usd)
+# Create an order with issued_to field (optional)
+total_price = 5_00 # Pass in the total price in smallest currency unit (ie cents for USD).
+currency = "USD"
+issued_to = {email: "envimpact@companya.com", name: "Company A"}
+Patch::Order.create_order(total_price: total_price, currency: currency, issued_to: issued_to)
 
 ## 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::Order.create_order(mass_g: mass, project_id: project_id)
+Patch::Order.create_order(amount: amount, unit: unit, project_id: project_id)
 
 ## Orders also accept a metadata field (optional)
 metadata = {user: "john doe"}
-Patch::Order.create_order(mass_g: mass, metadata: metadata)
+Patch::Order.create_order(amount: amount, unit: unit, metadata: metadata)
 
 # Retrieve an order
 order_id = 'ord_test_1234' # Pass in the order's id
@@ -88,6 +96,11 @@ Patch::Order.retrieve_order(order_id)
 order_id = 'ord_test_1234' # Pass in the order's id
 Patch::Order.place_order(order_id)
 
+## Placing an order on behalf of another party with the issued_to field (optional)
+order_id = 'ord_test_1234' # Pass in the order's id
+issued_to = {email: "envimpact@companya.com", name: "Company A"}
+Patch::Order.place_order(order_id, issued_to: issued_to)
+
 # Cancel an order
 order_id = 'ord_test_1234' # Pass in the order's id
 Patch::Order.cancel_order(order_id)
@@ -187,6 +200,15 @@ Patch::Project.retrieve_projects(type: type)
 # Retrieve a list of projects with at least 100 grams of available offsets
 minimum_available_mass = 100
 Patch::Project.retrieve_projects(minimum_available_mass: minimum_available_mass)
+
+# Retrieve a project in a different language
+# See http://docs.patch.test:3000/#/internationalization for more information and support
+project_id = 'pro_test_1234'
+Patch::Project.retrieve_project(project_id, accept_language: 'fr')
+
+# Retrieve a list of projects in a different language
+# See http://docs.patch.test:3000/#/internationalization for more information and support
+Patch::Project.retrieve_projects(accept_language: 'fr')
 ```
 ## Contributing
 
@@ -208,6 +230,25 @@ This will create a .gem file. To install the local gem:
 gem install patch_ruby-1.x.x.gem
 ```
 
+Once you have installed the gem, you can easily test with `irb`. Here's an example of testing Order creation:
+```bash
+brett@Bretts-MacBook-Pro patch-ruby $ irb
+irb(main):001:0> require 'patch_ruby'
+=> true
+irb(main):002:0>
+irb(main):003:1* Patch.configure do |config|
+irb(main):004:1*   # Configure the Patch gem with your API key here
+irb(main):005:1*   config.access_token = ENV['SANDBOX_API_KEY']
+irb(main):006:0> end
+=> "[REDACTED]"
+irb(main):007:0> total_price = 5_00
+=> 500
+irb(main):008:0> currency = "USD"
+=> "USD"
+irb(main):009:0> issued_to = {email: "envimpact@companya.com", name: "Company A"}
+irb(main):010:0> Patch::Order.create_order(total_price: total_price, currency: currency, issued_to: issued_to)
+```
+
 ### Running tests
 
 Set up the required environment variable.

data/lib/patch_ruby/api/orders_api.rb

@@ -28,19 +28,19 @@ module Patch
       @api_client = api_client
     end
     # Cancel an order
-    # Cancelling an order removes the associated offset allocation from an order. You will not be charged for cancelled orders. Only orders in the `draft` or `placed` state can be cancelled. 
-    # @param id [String] 
+    # Cancelling an order removes the associated offset allocation from an order. You will not be charged for cancelled orders. Only orders in the `draft` or `placed` state can be cancelled.
+    # @param id [String]
     # @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
 
     # Cancel an order
-    # Cancelling an order removes the associated offset allocation from an order. You will not be charged for cancelled orders. Only orders in the `draft` or `placed` state can be cancelled. 
-    # @param id [String] 
+    # Cancelling an order removes the associated offset allocation from an order. You will not be charged for cancelled orders. Only orders in the `draft` or `placed` state can be cancelled.
+    # @param id [String]
     # @param [Hash] opts the optional parameters
     # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
     def cancel_order_with_http_info(id, opts = {})
@@ -92,19 +92,19 @@ module Patch
     end
 
     # Creates an order
-    # Creates an order in the `placed` or `draft` state. 
-    # @param create_order_request [CreateOrderRequest] 
+    # Creates an order in the `placed` or `draft` state.
+    # @param create_order_request [CreateOrderRequest]
     # @param [Hash] opts the optional parameters
     # @return [OrderResponse]
     def create_order(create_order_request = {}, opts = {})
-      _create_order_request = Patch::CreateOrderRequest.new(create_order_request) 
+      _create_order_request = Patch::CreateOrderRequest.new(create_order_request)
       data, _status_code, _headers = create_order_with_http_info(_create_order_request, opts)
       data
     end
 
     # Creates an order
-    # Creates an order in the &#x60;placed&#x60; or &#x60;draft&#x60; state. 
-    # @param create_order_request [CreateOrderRequest] 
+    # Creates an order in the &#x60;placed&#x60; or &#x60;draft&#x60; state.
+    # @param create_order_request [CreateOrderRequest]
     # @param [Hash] opts the optional parameters
     # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
     def create_order_with_http_info(create_order_request, opts = {})
@@ -161,20 +161,22 @@ module Patch
     end
 
     # Place an order
-    # Placing an order confirms an order's allocation of offsets. Only orders that are in the `draft` state can be placed 
-    # @param id [String] 
+    # Placing an order confirms an order's allocation of offsets. Only orders that are in the `draft` state can be placed
+    # @param id [String]
     # @param [Hash] opts the optional parameters
+    # @option opts [PlaceOrderRequest] :place_order_request
     # @return [OrderResponse]
-    def place_order(id, opts = {})
-    
-      data, _status_code, _headers = place_order_with_http_info(id, opts)
+    def place_order(id, place_order_request = {}, opts = {})
+      _place_order_request = Patch::PlaceOrderRequest.new(place_order_request)
+      data, _status_code, _headers = place_order_with_http_info(id, opts.merge!({place_order_request: place_order_request}))
       data
     end
 
     # Place an order
-    # Placing an order confirms an order&#39;s allocation of offsets. Only orders that are in the &#x60;draft&#x60; state can be placed 
-    # @param id [String] 
+    # Placing an order confirms an order&#39;s allocation of offsets. Only orders that are in the &#x60;draft&#x60; state can be placed
+    # @param id [String]
     # @param [Hash] opts the optional parameters
+    # @option opts [PlaceOrderRequest] :place_order_request
     # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
     def place_order_with_http_info(id, opts = {})
       if @api_client.config.debugging
@@ -194,12 +196,17 @@ module Patch
       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]
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'place_order_request'])
 
       # return_type
       return_type = opts[:debug_return_type] || 'OrderResponse'
@@ -225,19 +232,19 @@ module Patch
     end
 
     # Retrieves an order
-    # Retrieves a given order and its allocation offsets or negative emissions. You can only retrieve orders associated with the organization you are querying for. 
-    # @param id [String] 
+    # Retrieves a given order and its allocation offsets or negative emissions. You can only retrieve orders associated with the organization you are querying for.
+    # @param id [String]
     # @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
 
     # Retrieves an order
-    # Retrieves a given order and its allocation offsets or negative emissions. You can only retrieve orders associated with the organization you are querying for. 
-    # @param id [String] 
+    # Retrieves a given order and its allocation offsets or negative emissions. You can only retrieve orders associated with the organization you are querying for.
+    # @param id [String]
     # @param [Hash] opts the optional parameters
     # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
     def retrieve_order_with_http_info(id, opts = {})
@@ -289,26 +296,26 @@ module Patch
     end
 
     # Retrieves a list of orders
-    # Retrieves a list of orders and its allocation offsets or negative emissions. You can only retrieve orders associated with the organization you are querying for. 
+    # Retrieves a list of orders and its allocation offsets or negative emissions. You can only retrieve orders associated with the organization you are querying for.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page 
-    # @option opts [String] :metadata 
-    # @option opts [String] :metadata_example1 
-    # @option opts [String] :metadata_example2 
+    # @option opts [Integer] :page
+    # @option opts [String] :metadata
+    # @option opts [String] :metadata_example1
+    # @option opts [String] :metadata_example2
     # @return [OrderListResponse]
     def retrieve_orders(opts = {})
-    
+
       data, _status_code, _headers = retrieve_orders_with_http_info(opts)
       data
     end
 
     # Retrieves a list of orders
-    # Retrieves a list of orders and its allocation offsets or negative emissions. You can only retrieve orders associated with the organization you are querying for. 
+    # Retrieves a list of orders and its allocation offsets or negative emissions. You can only retrieve orders associated with the organization you are querying for.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page 
-    # @option opts [String] :metadata 
-    # @option opts [String] :metadata_example1 
-    # @option opts [String] :metadata_example2 
+    # @option opts [Integer] :page
+    # @option opts [String] :metadata
+    # @option opts [String] :metadata_example1
+    # @option opts [String] :metadata_example2
     # @return [Array<(OrderListResponse, Integer, Hash)>] OrderListResponse data, response status code and response headers
     def retrieve_orders_with_http_info(opts = {})
       if @api_client.config.debugging

data/lib/patch_ruby/api/projects_api.rb

@@ -28,6 +28,7 @@ module Patch
     # Retrieves a project available on Patch's platform. 
     # @param id [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :accept_language 
     # @return [ProjectResponse]
     def retrieve_project(id, opts = {})
     
@@ -39,6 +40,7 @@ module Patch
     # Retrieves a project available on Patch's platform. 
     # @param id [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :accept_language 
     # @return [Array<(ProjectResponse, Integer, Hash)>] ProjectResponse data, response status code and response headers
     def retrieve_project_with_http_info(id, opts = {})
       if @api_client.config.debugging
@@ -58,6 +60,7 @@ module Patch
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -95,6 +98,7 @@ module Patch
     # @option opts [String] :country 
     # @option opts [String] :type 
     # @option opts [Integer] :minimum_available_mass 
+    # @option opts [String] :accept_language 
     # @return [ProjectListResponse]
     def retrieve_projects(opts = {})
     
@@ -109,6 +113,7 @@ module Patch
     # @option opts [String] :country 
     # @option opts [String] :type 
     # @option opts [Integer] :minimum_available_mass 
+    # @option opts [String] :accept_language 
     # @return [Array<(ProjectListResponse, Integer, Hash)>] ProjectListResponse data, response status code and response headers
     def retrieve_projects_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -128,6 +133,7 @@ module Patch
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}

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

data/lib/patch_ruby/models/allocation.rb

@@ -18,7 +18,7 @@ module Patch
     # A unique uid for the record. UIDs will be prepended by all_prod or all_test depending on the mode it was created in.
     attr_accessor :id
 
-    # A boolean indicating if this project is a production or test mode project.
+    # A boolean indicating if this project is a production or demo mode project.
     attr_accessor :production
 
     # The amount (in grams) of allocated carbon offsets.

data/lib/patch_ruby/models/create_order_request.rb

@@ -27,6 +27,16 @@ module Patch
 
     attr_accessor :vintage_year
 
+    attr_accessor :total_price
+
+    attr_accessor :currency
+
+    attr_accessor :amount
+
+    attr_accessor :unit
+
+    attr_accessor :issued_to
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -57,7 +67,12 @@ module Patch
         :'project_id' => :'project_id',
         :'metadata' => :'metadata',
         :'state' => :'state',
-        :'vintage_year' => :'vintage_year'
+        :'vintage_year' => :'vintage_year',
+        :'total_price' => :'total_price',
+        :'currency' => :'currency',
+        :'amount' => :'amount',
+        :'unit' => :'unit',
+        :'issued_to' => :'issued_to'
       }
     end
 
@@ -74,7 +89,12 @@ module Patch
         :'project_id' => :'String',
         :'metadata' => :'Object',
         :'state' => :'String',
-        :'vintage_year' => :'Integer'
+        :'vintage_year' => :'Integer',
+        :'total_price' => :'Integer',
+        :'currency' => :'String',
+        :'amount' => :'Integer',
+        :'unit' => :'String',
+        :'issued_to' => :'V1OrdersIssuedTo'
       }
     end
 
@@ -86,7 +106,12 @@ module Patch
         :'project_id',
         :'metadata',
         :'state',
-        :'vintage_year'
+        :'vintage_year',
+        :'total_price',
+        :'currency',
+        :'amount',
+        :'unit',
+        :'issued_to'
       ])
     end
 
@@ -140,6 +165,26 @@ module Patch
       if attributes.key?(:'vintage_year')
         self.vintage_year = attributes[:'vintage_year']
       end
+
+      if attributes.key?(:'total_price')
+        self.total_price = attributes[:'total_price']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'unit')
+        self.unit = attributes[:'unit']
+      end
+
+      if attributes.key?(:'issued_to')
+        self.issued_to = attributes[:'issued_to']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -166,6 +211,18 @@ module Patch
         invalid_properties.push('invalid value for "vintage_year", must be greater than or equal to 1900.')
       end
 
+      if !@total_price.nil? && @total_price < 1
+        invalid_properties.push('invalid value for "total_price", must be greater than or equal to 1.')
+      end
+
+      if !@amount.nil? && @amount > 100000000000
+        invalid_properties.push('invalid value for "amount", must be smaller than or equal to 100000000000.')
+      end
+
+      if !@amount.nil? && @amount < 0
+        invalid_properties.push('invalid value for "amount", must be greater than or equal to 0.')
+      end
+
       invalid_properties
     end
 
@@ -179,6 +236,11 @@ module Patch
       return false unless state_validator.valid?(@state)
       return false if !@vintage_year.nil? && @vintage_year > 2100
       return false if !@vintage_year.nil? && @vintage_year < 1900
+      return false if !@total_price.nil? && @total_price < 1
+      return false if !@amount.nil? && @amount > 100000000000
+      return false if !@amount.nil? && @amount < 0
+      unit_validator = EnumAttributeValidator.new('String', ["g", "Wh"])
+      return false unless unit_validator.valid?(@unit)
       true
     end
 
@@ -230,6 +292,40 @@ module Patch
       @vintage_year = vintage_year
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] total_price Value to be assigned
+    def total_price=(total_price)
+      if !total_price.nil? && total_price < 1
+        fail ArgumentError, 'invalid value for "total_price", must be greater than or equal to 1.'
+      end
+
+      @total_price = total_price
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] amount Value to be assigned
+    def amount=(amount)
+      if !amount.nil? && amount > 100000000000
+        fail ArgumentError, 'invalid value for "amount", must be smaller than or equal to 100000000000.'
+      end
+
+      if !amount.nil? && amount < 0
+        fail ArgumentError, 'invalid value for "amount", must be greater than or equal to 0.'
+      end
+
+      @amount = amount
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] unit Object to be assigned
+    def unit=(unit)
+      validator = EnumAttributeValidator.new('String', ["g", "Wh"])
+      unless validator.valid?(unit)
+        fail ArgumentError, "invalid value for \"unit\", must be one of #{validator.allowable_values}."
+      end
+      @unit = unit
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -240,7 +336,12 @@ module Patch
           project_id == o.project_id &&
           metadata == o.metadata &&
           state == o.state &&
-          vintage_year == o.vintage_year
+          vintage_year == o.vintage_year &&
+          total_price == o.total_price &&
+          currency == o.currency &&
+          amount == o.amount &&
+          unit == o.unit &&
+          issued_to == o.issued_to
     end
 
     # @see the `==` method
@@ -252,7 +353,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [mass_g, total_price_cents_usd, project_id, metadata, state, vintage_year].hash
+      [mass_g, total_price_cents_usd, project_id, metadata, state, vintage_year, total_price, currency, amount, unit, issued_to].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/estimate.rb

@@ -18,7 +18,7 @@ module Patch
     # A unique uid for the record. UIDs will be prepended by est_prod or est_test depending on the mode it was created in.
     attr_accessor :id
 
-    # A boolean indicating if this estimate is a production or test mode estimate.
+    # A boolean indicating if this estimate is a production or demo mode estimate.
     attr_accessor :production
 
     # The type of estimate. Available types are mass, flight, shipping, vehicle, and crypto.