patch_ruby 1.2.2 → 1.4.0

data/lib/patch_ruby/api/projects_api.rb

@@ -90,6 +90,9 @@ module Patch
     # Retrieves a list of projects available for purchase on Patch's platform. 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page 
+    # @option opts [String] :country 
+    # @option opts [String] :type 
+    # @option opts [Integer] :minimum_available_mass 
     # @return [ProjectListResponse]
     def retrieve_projects(opts = {})
       data, _status_code, _headers = retrieve_projects_with_http_info(opts)
@@ -100,6 +103,9 @@ module Patch
     # Retrieves a list of projects available for purchase on Patch's platform. 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page 
+    # @option opts [String] :country 
+    # @option opts [String] :type 
+    # @option opts [Integer] :minimum_available_mass 
     # @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
@@ -111,6 +117,9 @@ module Patch
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
+      query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+      query_params[:'minimum_available_mass'] = opts[:'minimum_available_mass'] if !opts[:'minimum_available_mass'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/patch_ruby/models/allocation.rb

@@ -14,10 +14,13 @@ require 'date'
 
 module Patch
   class Allocation
+    # 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.
     attr_accessor :production
 
+    # The amount (in grams) of allocated carbon offsets.
     attr_accessor :mass_g
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -38,6 +41,13 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties
+    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

data/lib/patch_ruby/models/create_mass_estimate_request.rb

@@ -16,12 +16,15 @@ module Patch
   class CreateMassEstimateRequest
     attr_accessor :mass_g
 
+    attr_accessor :create_order
+
     attr_accessor :project_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'mass_g' => :'mass_g',
+        :'create_order' => :'create_order',
         :'project_id' => :'project_id'
       }
     end
@@ -30,10 +33,20 @@ module Patch
     def self.openapi_types
       {
         :'mass_g' => :'Integer',
+        :'create_order' => :'Boolean',
         :'project_id' => :'String'
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("create_order")
+
+      nullable_properties
+    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
@@ -64,6 +77,10 @@ module Patch
         self.mass_g = attributes[:'mass_g']
       end
 
+      if attributes.key?(:'create_order')
+        self.create_order = attributes[:'create_order']
+      end
+
       if attributes.key?(:'project_id')
         self.project_id = attributes[:'project_id']
       end
@@ -121,6 +138,7 @@ module Patch
       return true if self.equal?(o)
       self.class == o.class &&
           mass_g == o.mass_g &&
+          create_order == o.create_order &&
           project_id == o.project_id
     end
 
@@ -133,7 +151,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [mass_g, project_id].hash
+      [mass_g, create_order, project_id].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/create_order_request.rb

@@ -16,6 +16,8 @@ module Patch
   class CreateOrderRequest
     attr_accessor :mass_g
 
+    attr_accessor :total_price_cents_usd
+
     attr_accessor :project_id
 
     attr_accessor :metadata
@@ -24,6 +26,7 @@ module Patch
     def self.attribute_map
       {
         :'mass_g' => :'mass_g',
+        :'total_price_cents_usd' => :'total_price_cents_usd',
         :'project_id' => :'project_id',
         :'metadata' => :'metadata'
       }
@@ -33,11 +36,19 @@ module Patch
     def self.openapi_types
       {
         :'mass_g' => :'Integer',
+        :'total_price_cents_usd' => :'Integer',
         :'project_id' => :'String',
         :'metadata' => :'Object'
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties
+    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
@@ -68,6 +79,10 @@ module Patch
         self.mass_g = attributes[:'mass_g']
       end
 
+      if attributes.key?(:'total_price_cents_usd')
+        self.total_price_cents_usd = attributes[:'total_price_cents_usd']
+      end
+
       if attributes.key?(:'project_id')
         self.project_id = attributes[:'project_id']
       end
@@ -81,54 +96,61 @@ module Patch
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @mass_g.nil?
-        invalid_properties.push('invalid value for "mass_g", mass_g cannot be nil.')
-      end
-
-      if @mass_g > 2000000000
+      if !@mass_g.nil? && @mass_g > 2000000000
         invalid_properties.push('invalid value for "mass_g", must be smaller than or equal to 2000000000.')
       end
 
-      if @mass_g < 1
+      if !@mass_g.nil? && @mass_g < 1
         invalid_properties.push('invalid value for "mass_g", must be greater than or equal to 1.')
       end
 
+      if !@total_price_cents_usd.nil? && @total_price_cents_usd < 1
+        invalid_properties.push('invalid value for "total_price_cents_usd", must be greater than or equal to 1.')
+      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 @mass_g.nil?
-      return false if @mass_g > 2000000000
-      return false if @mass_g < 1
+      return false if !@mass_g.nil? && @mass_g > 2000000000
+      return false if !@mass_g.nil? && @mass_g < 1
+      return false if !@total_price_cents_usd.nil? && @total_price_cents_usd < 1
       true
     end
 
     # Custom attribute writer method with validation
     # @param [Object] mass_g Value to be assigned
     def mass_g=(mass_g)
-      if mass_g.nil?
-        fail ArgumentError, 'mass_g cannot be nil'
-      end
-
-      if mass_g > 2000000000
+      if !mass_g.nil? && mass_g > 2000000000
         fail ArgumentError, 'invalid value for "mass_g", must be smaller than or equal to 2000000000.'
       end
 
-      if mass_g < 1
+      if !mass_g.nil? && mass_g < 1
         fail ArgumentError, 'invalid value for "mass_g", must be greater than or equal to 1.'
       end
 
       @mass_g = mass_g
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] total_price_cents_usd Value to be assigned
+    def total_price_cents_usd=(total_price_cents_usd)
+      if !total_price_cents_usd.nil? && total_price_cents_usd < 1
+        fail ArgumentError, 'invalid value for "total_price_cents_usd", must be greater than or equal to 1.'
+      end
+
+      @total_price_cents_usd = total_price_cents_usd
+    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 &&
           mass_g == o.mass_g &&
+          total_price_cents_usd == o.total_price_cents_usd &&
           project_id == o.project_id &&
           metadata == o.metadata
     end
@@ -142,7 +164,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [mass_g, project_id, metadata].hash
+      [mass_g, total_price_cents_usd, project_id, metadata].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/create_preference_request.rb

@@ -30,6 +30,13 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties
+    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

data/lib/patch_ruby/models/error_response.rb

@@ -38,6 +38,15 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("data")
+
+      nullable_properties
+    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

data/lib/patch_ruby/models/estimate.rb

@@ -14,12 +14,19 @@ require 'date'
 
 module Patch
   class Estimate
+    # 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.
     attr_accessor :production
 
+    # The type of estimate. Available types are mass, flight, shipping, and vehicle.
     attr_accessor :type
 
+    # The estimated mass in grams for this estimate.
+    attr_accessor :mass_g
+
+    # An object returning the order associated with this estimate. See the [Order section](/?id=orders) for the full schema.
     attr_accessor :order
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -28,6 +35,7 @@ module Patch
         :'id' => :'id',
         :'production' => :'production',
         :'type' => :'type',
+        :'mass_g' => :'mass_g',
         :'order' => :'order'
       }
     end
@@ -38,10 +46,20 @@ module Patch
         :'id' => :'String',
         :'production' => :'Boolean',
         :'type' => :'String',
+        :'mass_g' => :'Integer',
         :'order' => :'Order'
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("order")
+
+      nullable_properties
+    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
@@ -80,6 +98,10 @@ module Patch
         self.type = attributes[:'type']
       end
 
+      if attributes.key?(:'mass_g')
+        self.mass_g = attributes[:'mass_g']
+      end
+
       if attributes.key?(:'order')
         self.order = attributes[:'order']
       end
@@ -121,6 +143,7 @@ module Patch
           id == o.id &&
           production == o.production &&
           type == o.type &&
+          mass_g == o.mass_g &&
           order == o.order
     end
 
@@ -133,7 +156,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, production, type, order].hash
+      [id, production, type, mass_g, order].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/estimate_list_response.rb

@@ -42,6 +42,15 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("error")
+
+      nullable_properties
+    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

data/lib/patch_ruby/models/estimate_response.rb

@@ -38,6 +38,15 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("error")
+
+      nullable_properties
+    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

data/lib/patch_ruby/models/meta_index_object.rb

@@ -34,6 +34,17 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("prev_page")
+
+      nullable_properties.add("next_page")
+
+      nullable_properties
+    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

data/lib/patch_ruby/models/order.rb

@@ -14,20 +14,31 @@ require 'date'
 
 module Patch
   class Order
+    # A unique uid for the record. UIDs will be prepended by ord_prod or ord_test depending on the mode it was created in.
     attr_accessor :id
 
+    # The amount of carbon offsets in grams purchased through this order.
     attr_accessor :mass_g
 
+    # A boolean indicating if this order is a production or test mode order.
     attr_accessor :production
 
+    # The current state of the order.
     attr_accessor :state
 
+    # The current state of the allocated carbon offsets of the order.
     attr_accessor :allocation_state
 
+    # The total price in cents USD of the carbon offsets purchased through this order.
     attr_accessor :price_cents_usd
 
+    # The Patch Fee in cents USD for this order.
+    attr_accessor :patch_fee_cents_usd
+
+    # An array containing the inventory allocations for this order.
     attr_accessor :allocations
 
+    # An optional JSON object containing metadata for this order.
     attr_accessor :metadata
 
     class EnumAttributeValidator
@@ -61,6 +72,7 @@ module Patch
         :'state' => :'state',
         :'allocation_state' => :'allocation_state',
         :'price_cents_usd' => :'price_cents_usd',
+        :'patch_fee_cents_usd' => :'patch_fee_cents_usd',
         :'allocations' => :'allocations',
         :'metadata' => :'metadata'
       }
@@ -75,11 +87,23 @@ module Patch
         :'state' => :'String',
         :'allocation_state' => :'String',
         :'price_cents_usd' => :'String',
+        :'patch_fee_cents_usd' => :'String',
         :'allocations' => :'Array<Allocation>',
         :'metadata' => :'Object'
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("price_cents_usd")
+
+      nullable_properties.add("patch_fee_cents_usd")
+
+      nullable_properties
+    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
@@ -130,6 +154,10 @@ module Patch
         self.price_cents_usd = attributes[:'price_cents_usd']
       end
 
+      if attributes.key?(:'patch_fee_cents_usd')
+        self.patch_fee_cents_usd = attributes[:'patch_fee_cents_usd']
+      end
+
       if attributes.key?(:'allocations')
         if (value = attributes[:'allocations']).is_a?(Array)
           self.allocations = value
@@ -252,6 +280,7 @@ module Patch
           state == o.state &&
           allocation_state == o.allocation_state &&
           price_cents_usd == o.price_cents_usd &&
+          patch_fee_cents_usd == o.patch_fee_cents_usd &&
           allocations == o.allocations &&
           metadata == o.metadata
     end
@@ -265,7 +294,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, mass_g, production, state, allocation_state, price_cents_usd, allocations, metadata].hash
+      [id, mass_g, production, state, allocation_state, price_cents_usd, patch_fee_cents_usd, allocations, metadata].hash
     end
 
     # Builds the object from hash