patch_ruby 1.24.2 → 2.1.1

data/lib/patch_ruby/models/meta_index_object.rb

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

data/lib/patch_ruby/models/order.rb

@@ -1,9 +1,9 @@
 =begin
-#Patch API V1
+#Patch API V2
 
 #The core API used to integrate with Patch's service
 
-The version of the OpenAPI document: v1
+The version of the OpenAPI document: 2
 Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.3.1
@@ -21,9 +21,6 @@ module Patch
     # The timestamp at which the order was created
     attr_accessor :created_at
 
-    # DEPRECATED, use `amount` and `unit` fields instead. 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 demo mode order.
     attr_accessor :production
 
@@ -45,26 +42,14 @@ module Patch
     # The currency code for the `price` and `patch_fee`.
     attr_accessor :currency
 
-    # DEPRECATED. Indicates if the order has been fully allocated to projects.
-    attr_accessor :allocation_state
-
-    # DEPRECATED, use the `price` and `currency` fields instead. The total price in cents USD of the carbon offsets purchased through this order.
-    attr_accessor :price_cents_usd
-
-    # DEPRECATED, use the `patch_fee` and `currency` fields instead. The Patch Fee in cents USD for this order.
-    attr_accessor :patch_fee_cents_usd
-
-    # DEPRECATED. An array containing the inventory allocations for this order.
-    attr_accessor :allocations
-
-    # The url of this order in the public registry.
+    # The URL of this order in the public registry. Use this URL to access the order's accompanying certificate.
     attr_accessor :registry_url
 
     # An optional JSON object containing metadata for this order.
     attr_accessor :metadata
 
-    # An array containing the inventory allocated for this order. Inventory is grouped by project, vintage year, and price.
-    attr_accessor :inventory
+    # An array containing the line items allocated for this order. Line items are grouped by project, vintage year, and price.
+    attr_accessor :line_items
 
     # An object containing the name & email of the party the inventory will be issued to.
     attr_accessor :issued_to
@@ -96,7 +81,6 @@ module Patch
       {
         :'id' => :'id',
         :'created_at' => :'created_at',
-        :'mass_g' => :'mass_g',
         :'production' => :'production',
         :'state' => :'state',
         :'amount' => :'amount',
@@ -104,13 +88,9 @@ module Patch
         :'price' => :'price',
         :'patch_fee' => :'patch_fee',
         :'currency' => :'currency',
-        :'allocation_state' => :'allocation_state',
-        :'price_cents_usd' => :'price_cents_usd',
-        :'patch_fee_cents_usd' => :'patch_fee_cents_usd',
-        :'allocations' => :'allocations',
         :'registry_url' => :'registry_url',
         :'metadata' => :'metadata',
-        :'inventory' => :'inventory',
+        :'line_items' => :'line_items',
         :'issued_to' => :'issued_to'
       }
     end
@@ -125,7 +105,6 @@ module Patch
       {
         :'id' => :'String',
         :'created_at' => :'Time',
-        :'mass_g' => :'Integer',
         :'production' => :'Boolean',
         :'state' => :'String',
         :'amount' => :'Integer',
@@ -133,13 +112,9 @@ module Patch
         :'price' => :'Integer',
         :'patch_fee' => :'Integer',
         :'currency' => :'String',
-        :'allocation_state' => :'String',
-        :'price_cents_usd' => :'Integer',
-        :'patch_fee_cents_usd' => :'Integer',
-        :'allocations' => :'Array<Allocation>',
         :'registry_url' => :'String',
         :'metadata' => :'Object',
-        :'inventory' => :'Array<OrderInventory>',
+        :'line_items' => :'Array<OrderLineItem>',
         :'issued_to' => :'OrderIssuedTo'
       }
     end
@@ -147,8 +122,6 @@ module Patch
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'price_cents_usd',
-        :'patch_fee_cents_usd',
       ])
     end
 
@@ -187,10 +160,6 @@ module Patch
         self.created_at = attributes[:'created_at']
       end
 
-      if attributes.key?(:'mass_g')
-        self.mass_g = attributes[:'mass_g']
-      end
-
       if attributes.key?(:'production')
         self.production = attributes[:'production']
       end
@@ -219,24 +188,6 @@ module Patch
         self.currency = attributes[:'currency']
       end
 
-      if attributes.key?(:'allocation_state')
-        self.allocation_state = attributes[:'allocation_state']
-      end
-
-      if attributes.key?(:'price_cents_usd')
-        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
-        end
-      end
-
       if attributes.key?(:'registry_url')
         self.registry_url = attributes[:'registry_url']
       end
@@ -245,9 +196,9 @@ module Patch
         self.metadata = attributes[:'metadata']
       end
 
-      if attributes.key?(:'inventory')
-        if (value = attributes[:'inventory']).is_a?(Array)
-          self.inventory = value
+      if attributes.key?(:'line_items')
+        if (value = attributes[:'line_items']).is_a?(Array)
+          self.line_items = value
         end
       end
 
@@ -267,18 +218,6 @@ module Patch
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @mass_g.nil?
-        invalid_properties.push('invalid value for "mass_g", mass_g cannot be nil.')
-      end
-
-      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
-        invalid_properties.push('invalid value for "mass_g", must be greater than or equal to 0.')
-      end
-
       if @production.nil?
         invalid_properties.push('invalid value for "production", production cannot be nil.')
       end
@@ -291,8 +230,8 @@ module Patch
         invalid_properties.push('invalid value for "amount", amount cannot be nil.')
       end
 
-      if @amount > 100000000000
-        invalid_properties.push('invalid value for "amount", must be smaller than or equal to 100000000000.')
+      if @amount > 100000000000000
+        invalid_properties.push('invalid value for "amount", must be smaller than or equal to 100000000000000.')
       end
 
       if @amount < 0
@@ -315,10 +254,6 @@ module Patch
         invalid_properties.push('invalid value for "currency", currency cannot be nil.')
       end
 
-      if @allocation_state.nil?
-        invalid_properties.push('invalid value for "allocation_state", allocation_state cannot be nil.')
-      end
-
       if @metadata.nil?
         invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
       end
@@ -330,45 +265,21 @@ module Patch
     # @return true if the model is valid
     def valid?
       return false if @id.nil?
-      return false if @mass_g.nil?
-      return false if @mass_g > 100000000000
-      return false if @mass_g < 0
       return false if @production.nil?
       return false if @state.nil?
       state_validator = EnumAttributeValidator.new('String', ["draft", "reserved", "placed", "processing", "complete", "cancelled"])
       return false unless state_validator.valid?(@state)
       return false if @amount.nil?
-      return false if @amount > 100000000000
+      return false if @amount > 100000000000000
       return false if @amount < 0
       return false if @unit.nil?
       return false if @price.nil?
       return false if @patch_fee.nil?
       return false if @currency.nil?
-      return false if @allocation_state.nil?
-      allocation_state_validator = EnumAttributeValidator.new('String', ["pending", "allocated"])
-      return false unless allocation_state_validator.valid?(@allocation_state)
       return false if @metadata.nil?
       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 > 100000000000
-        fail ArgumentError, 'invalid value for "mass_g", must be smaller than or equal to 100000000000.'
-      end
-
-      if mass_g < 0
-        fail ArgumentError, 'invalid value for "mass_g", must be greater than or equal to 0.'
-      end
-
-      @mass_g = mass_g
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] state Object to be assigned
     def state=(state)
@@ -386,8 +297,8 @@ module Patch
         fail ArgumentError, 'amount cannot be nil'
       end
 
-      if amount > 100000000000
-        fail ArgumentError, 'invalid value for "amount", must be smaller than or equal to 100000000000.'
+      if amount > 100000000000000
+        fail ArgumentError, 'invalid value for "amount", must be smaller than or equal to 100000000000000.'
       end
 
       if amount < 0
@@ -397,16 +308,6 @@ module Patch
       @amount = amount
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] allocation_state Object to be assigned
-    def allocation_state=(allocation_state)
-      validator = EnumAttributeValidator.new('String', ["pending", "allocated"])
-      unless validator.valid?(allocation_state)
-        fail ArgumentError, "invalid value for \"allocation_state\", must be one of #{validator.allowable_values}."
-      end
-      @allocation_state = allocation_state
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -414,7 +315,6 @@ module Patch
       self.class == o.class &&
           id == o.id &&
           created_at == o.created_at &&
-          mass_g == o.mass_g &&
           production == o.production &&
           state == o.state &&
           amount == o.amount &&
@@ -422,13 +322,9 @@ module Patch
           price == o.price &&
           patch_fee == o.patch_fee &&
           currency == o.currency &&
-          allocation_state == o.allocation_state &&
-          price_cents_usd == o.price_cents_usd &&
-          patch_fee_cents_usd == o.patch_fee_cents_usd &&
-          allocations == o.allocations &&
           registry_url == o.registry_url &&
           metadata == o.metadata &&
-          inventory == o.inventory &&
+          line_items == o.line_items &&
           issued_to == o.issued_to
     end
 
@@ -441,7 +337,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created_at, mass_g, production, state, amount, unit, price, patch_fee, currency, allocation_state, price_cents_usd, patch_fee_cents_usd, allocations, registry_url, metadata, inventory, issued_to].hash
+      [id, created_at, production, state, amount, unit, price, patch_fee, currency, registry_url, metadata, line_items, issued_to].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/order_issued_to.rb

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

data/lib/patch_ruby/models/{order_inventory.rb → order_line_item.rb}

@@ -1,9 +1,9 @@
 =begin
-#Patch API V1
+#Patch API V2
 
 #The core API used to integrate with Patch's service
 
-The version of the OpenAPI document: v1
+The version of the OpenAPI document: 2
 Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.3.1
@@ -14,13 +14,22 @@ require 'date'
 require 'time'
 
 module Patch
-  class OrderInventory
+  class OrderLineItem
+    # The identifier for this order line item
+    attr_accessor :id
+
     # An object containing information about the project associated with the inventory allocated.
     attr_accessor :project
 
     # The year in which the climate impacts of the project occurred, or will occur.
     attr_accessor :vintage_year
 
+    # The starting year in which the climate impacts of the project occurred, or will occur.
+    attr_accessor :vintage_start_year
+
+    # The ending year in which the climate impacts of the project occurred, or will occur.
+    attr_accessor :vintage_end_year
+
     # The amount ordered for the given project and vintage year.
     attr_accessor :amount
 
@@ -36,8 +45,11 @@ module Patch
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'id' => :'id',
         :'project' => :'project',
         :'vintage_year' => :'vintage_year',
+        :'vintage_start_year' => :'vintage_start_year',
+        :'vintage_end_year' => :'vintage_end_year',
         :'amount' => :'amount',
         :'unit' => :'unit',
         :'price' => :'price',
@@ -53,8 +65,11 @@ module Patch
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'project' => :'OrderInventoryProject',
+        :'id' => :'String',
+        :'project' => :'OrderLineItemProject',
         :'vintage_year' => :'Integer',
+        :'vintage_start_year' => :'Integer',
+        :'vintage_end_year' => :'Integer',
         :'amount' => :'Integer',
         :'unit' => :'String',
         :'price' => :'Integer',
@@ -73,8 +88,8 @@ module Patch
     # 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::OrderInventorysApi::OPERATIONS') && Patch::OrderInventorysApi::OPERATIONS.include?(message)
-        Patch::OrderInventorysApi.new.send(message, *args)
+      if Object.const_defined?('Patch::OrderLineItemsApi::OPERATIONS') && Patch::OrderLineItemsApi::OPERATIONS.include?(message)
+        Patch::OrderLineItemsApi.new.send(message, *args)
       else
         super
       end
@@ -84,17 +99,21 @@ module Patch
     # @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::OrderInventory` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Patch::OrderLineItem` 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::OrderInventory`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Patch::OrderLineItem`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
       if attributes.key?(:'project')
         if (value = attributes[:'project']).is_a?(Hash)
           self.project = value
@@ -106,6 +125,14 @@ module Patch
         self.vintage_year = attributes[:'vintage_year']
       end
 
+      if attributes.key?(:'vintage_start_year')
+        self.vintage_start_year = attributes[:'vintage_start_year']
+      end
+
+      if attributes.key?(:'vintage_end_year')
+        self.vintage_end_year = attributes[:'vintage_end_year']
+      end
+
       if attributes.key?(:'amount')
         self.amount = attributes[:'amount']
       end
@@ -135,6 +162,14 @@ module Patch
         invalid_properties.push('invalid value for "vintage_year", vintage_year cannot be nil.')
       end
 
+      if @vintage_start_year.nil?
+        invalid_properties.push('invalid value for "vintage_start_year", vintage_start_year cannot be nil.')
+      end
+
+      if @vintage_end_year.nil?
+        invalid_properties.push('invalid value for "vintage_end_year", vintage_end_year cannot be nil.')
+      end
+
       if @amount.nil?
         invalid_properties.push('invalid value for "amount", amount cannot be nil.')
       end
@@ -159,6 +194,8 @@ module Patch
     def valid?
       return false if @project.nil?
       return false if @vintage_year.nil?
+      return false if @vintage_start_year.nil?
+      return false if @vintage_end_year.nil?
       return false if @amount.nil?
       return false if @unit.nil?
       return false if @price.nil?
@@ -171,8 +208,11 @@ module Patch
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          id == o.id &&
           project == o.project &&
           vintage_year == o.vintage_year &&
+          vintage_start_year == o.vintage_start_year &&
+          vintage_end_year == o.vintage_end_year &&
           amount == o.amount &&
           unit == o.unit &&
           price == o.price &&
@@ -188,7 +228,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [project, vintage_year, amount, unit, price, currency].hash
+      [id, project, vintage_year, vintage_start_year, vintage_end_year, amount, unit, price, currency].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/{order_inventory_project.rb → order_line_item_project.rb}

@@ -1,9 +1,9 @@
 =begin
-#Patch API V1
+#Patch API V2
 
 #The core API used to integrate with Patch's service
 
-The version of the OpenAPI document: v1
+The version of the OpenAPI document: 2
 Contact: engineering@usepatch.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.3.1
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Patch
-  class OrderInventoryProject
+  class OrderLineItemProject
     # The unique uid for a project. UIDs will be prepended by pro_prod or pro_test depending on the mode it was created in.
     attr_accessor :id
 
@@ -53,8 +53,8 @@ module Patch
     # 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::OrderInventoryProjectsApi::OPERATIONS') && Patch::OrderInventoryProjectsApi::OPERATIONS.include?(message)
-        Patch::OrderInventoryProjectsApi.new.send(message, *args)
+      if Object.const_defined?('Patch::OrderLineItemProjectsApi::OPERATIONS') && Patch::OrderLineItemProjectsApi::OPERATIONS.include?(message)
+        Patch::OrderLineItemProjectsApi.new.send(message, *args)
       else
         super
       end
@@ -64,13 +64,13 @@ module Patch
     # @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::OrderInventoryProject` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Patch::OrderLineItemProject` 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::OrderInventoryProject`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Patch::OrderLineItemProject`. 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
       }