patch_ruby 1.23.0 → 1.24.2

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 `placed` or `draft` 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,22 +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
+    # @option opts [PlaceOrderRequest] :place_order_request 
     # @return [OrderResponse]
-    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}))
+    def place_order(id, opts = {})
+    
+      data, _status_code, _headers = place_order_with_http_info(id, opts)
       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'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
+    # @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
@@ -206,7 +206,7 @@ module Patch
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'place_order_request'])
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts)
 
       # return_type
       return_type = opts[:debug_return_type] || 'OrderResponse'
@@ -232,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 = {})
@@ -296,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

@@ -37,7 +37,7 @@ module Patch
     end
 
     # Retrieves a project
-    # Retrieves a project available on Patch's platform. 
+    # Retrieves a project available on Patch's platform. 
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :accept_language 
@@ -107,7 +107,7 @@ module Patch
     end
 
     # Retrieves a list of projects
-    # Retrieves a list of projects available for purchase on Patch's platform. 
+    # 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 

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

data/lib/patch_ruby/models/create_air_shipping_estimate_request.rb

@@ -0,0 +1,374 @@
+=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 CreateAirShippingEstimateRequest
+    attr_accessor :destination_airport
+
+    attr_accessor :origin_airport
+
+    attr_accessor :aircraft_code
+
+    attr_accessor :aircraft_type
+
+    attr_accessor :freight_mass_g
+
+    attr_accessor :emissions_scope
+
+    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
+      {
+        :'destination_airport' => :'destination_airport',
+        :'origin_airport' => :'origin_airport',
+        :'aircraft_code' => :'aircraft_code',
+        :'aircraft_type' => :'aircraft_type',
+        :'freight_mass_g' => :'freight_mass_g',
+        :'emissions_scope' => :'emissions_scope',
+        :'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
+      {
+        :'destination_airport' => :'String',
+        :'origin_airport' => :'String',
+        :'aircraft_code' => :'String',
+        :'aircraft_type' => :'String',
+        :'freight_mass_g' => :'Integer',
+        :'emissions_scope' => :'String',
+        :'project_id' => :'String',
+        :'create_order' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'destination_airport',
+        :'origin_airport',
+        :'aircraft_code',
+        :'aircraft_type',
+        :'emissions_scope',
+        :'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::CreateAirShippingEstimateRequestsApi::OPERATIONS') && Patch::CreateAirShippingEstimateRequestsApi::OPERATIONS.include?(message)
+        Patch::CreateAirShippingEstimateRequestsApi.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::CreateAirShippingEstimateRequest` 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::CreateAirShippingEstimateRequest`. 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?(:'destination_airport')
+        self.destination_airport = attributes[:'destination_airport']
+      end
+
+      if attributes.key?(:'origin_airport')
+        self.origin_airport = attributes[:'origin_airport']
+      end
+
+      if attributes.key?(:'aircraft_code')
+        self.aircraft_code = attributes[:'aircraft_code']
+      end
+
+      if attributes.key?(:'aircraft_type')
+        self.aircraft_type = attributes[:'aircraft_type']
+      else
+        self.aircraft_type = 'unknown'
+      end
+
+      if attributes.key?(:'freight_mass_g')
+        self.freight_mass_g = attributes[:'freight_mass_g']
+      end
+
+      if attributes.key?(:'emissions_scope')
+        self.emissions_scope = attributes[:'emissions_scope']
+      else
+        self.emissions_scope = 'ttw'
+      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 !@freight_mass_g.nil? && @freight_mass_g > 2000000000
+        invalid_properties.push('invalid value for "freight_mass_g", must be smaller than or equal to 2000000000.')
+      end
+
+      if !@freight_mass_g.nil? && @freight_mass_g < 0
+        invalid_properties.push('invalid value for "freight_mass_g", must be greater than or equal to 0.')
+      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?
+      aircraft_type_validator = EnumAttributeValidator.new('String', ["passenger", "cargo", "unknown"])
+      return false unless aircraft_type_validator.valid?(@aircraft_type)
+      return false if !@freight_mass_g.nil? && @freight_mass_g > 2000000000
+      return false if !@freight_mass_g.nil? && @freight_mass_g < 0
+      emissions_scope_validator = EnumAttributeValidator.new('String', ["wtt", "ttw", "wtw"])
+      return false unless emissions_scope_validator.valid?(@emissions_scope)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] aircraft_type Object to be assigned
+    def aircraft_type=(aircraft_type)
+      validator = EnumAttributeValidator.new('String', ["passenger", "cargo", "unknown"])
+      unless validator.valid?(aircraft_type)
+        fail ArgumentError, "invalid value for \"aircraft_type\", must be one of #{validator.allowable_values}."
+      end
+      @aircraft_type = aircraft_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] freight_mass_g Value to be assigned
+    def freight_mass_g=(freight_mass_g)
+      if !freight_mass_g.nil? && freight_mass_g > 2000000000
+        fail ArgumentError, 'invalid value for "freight_mass_g", must be smaller than or equal to 2000000000.'
+      end
+
+      if !freight_mass_g.nil? && freight_mass_g < 0
+        fail ArgumentError, 'invalid value for "freight_mass_g", must be greater than or equal to 0.'
+      end
+
+      @freight_mass_g = freight_mass_g
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] emissions_scope Object to be assigned
+    def emissions_scope=(emissions_scope)
+      validator = EnumAttributeValidator.new('String', ["wtt", "ttw", "wtw"])
+      unless validator.valid?(emissions_scope)
+        fail ArgumentError, "invalid value for \"emissions_scope\", must be one of #{validator.allowable_values}."
+      end
+      @emissions_scope = emissions_scope
+    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 &&
+          destination_airport == o.destination_airport &&
+          origin_airport == o.origin_airport &&
+          aircraft_code == o.aircraft_code &&
+          aircraft_type == o.aircraft_type &&
+          freight_mass_g == o.freight_mass_g &&
+          emissions_scope == o.emissions_scope &&
+          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
+      [destination_airport, origin_airport, aircraft_code, aircraft_type, freight_mass_g, emissions_scope, 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<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\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