soilsidekick 3.0.0

data/lib/soilsidekick/models/generate_vrt_prescription_request.rb

@@ -0,0 +1,223 @@
+=begin
+#SoilSidekick Pro API
+
+#Agricultural intelligence and soil analysis API with tier-based access control.  ## What's New in 1.2.0 - **Consumer Plant Care APIs**: Three new endpoints addressing top pain points in plant ID apps:   - `/safe-identification`: Toxic lookalike warnings and environmental context   - `/dynamic-care`: Hyper-localized, real-time care recommendations   - `/beginner-guidance`: Judgment-free, jargon-free plant guidance  ## Authentication All endpoints require an API key passed via the `x-api-key` header: ``` x-api-key: ak_your_api_key_here ```  API keys are generated through the dashboard and use the `ak_*` format.  ## Rate Limiting Rate limits are enforced based on your subscription tier: - **Free**: 10 req/min, 100 req/hour, 1,000 req/day - **Starter**: 30 req/min, 500 req/hour, 5,000 req/day - **Pro**: 100 req/min, 2,000 req/hour, 25,000 req/day - **Enterprise**: 500 req/min, 10,000 req/hour, 100,000 req/day  Rate limit information is returned in response headers: - `X-RateLimit-Limit`: Maximum requests in window - `X-RateLimit-Remaining`: Remaining requests in window - `X-RateLimit-Reset`: Unix timestamp when limit resets  ## Response Time SLAs All endpoints return response time headers for performance monitoring: - `X-Response-Time`: Human-readable response time (e.g., \"245ms\") - `X-Response-Time-Ms`: Response time in milliseconds - `X-Response-Time-Target`: Target response time for this endpoint - `X-Response-Time-Max`: Maximum acceptable response time - `X-Response-Time-Status`: Performance status (`optimal`, `acceptable`, `exceeded`)  ### Response Time Targets by Category  | Category | Target | Maximum | Endpoints | |----------|--------|---------|-----------| | **Fast** | 200ms | 500ms | county-lookup, check-subscription | | **Standard** | 500ms | 1,500ms | get-soil-data, territorial-water-quality | | **Complex** | 2,000ms | 5,000ms | agricultural-intelligence, gpt5-chat, visual-crop-analysis | | **Heavy** | 5,000ms | 15,000ms | live-agricultural-data, generate-vrt-prescription | 
+
+The version of the OpenAPI document: 3.0.0
+Contact: support@soilsidekickpro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SoilSidekick
+  class GenerateVRTPrescriptionRequest < ApiModelBase
+    attr_accessor :field_id
+
+    attr_accessor :application_type
+
+    attr_accessor :soil_analysis_id
+
+    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
+      {
+        :'field_id' => :'field_id',
+        :'application_type' => :'application_type',
+        :'soil_analysis_id' => :'soil_analysis_id'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'field_id' => :'String',
+        :'application_type' => :'String',
+        :'soil_analysis_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `SoilSidekick::GenerateVRTPrescriptionRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SoilSidekick::GenerateVRTPrescriptionRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'field_id')
+        self.field_id = attributes[:'field_id']
+      else
+        self.field_id = nil
+      end
+
+      if attributes.key?(:'application_type')
+        self.application_type = attributes[:'application_type']
+      else
+        self.application_type = nil
+      end
+
+      if attributes.key?(:'soil_analysis_id')
+        self.soil_analysis_id = attributes[:'soil_analysis_id']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @field_id.nil?
+        invalid_properties.push('invalid value for "field_id", field_id cannot be nil.')
+      end
+
+      if @application_type.nil?
+        invalid_properties.push('invalid value for "application_type", application_type cannot be nil.')
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @field_id.nil?
+      return false if @application_type.nil?
+      application_type_validator = EnumAttributeValidator.new('String', ["fertilizer", "seed", "pesticide"])
+      return false unless application_type_validator.valid?(@application_type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] field_id Value to be assigned
+    def field_id=(field_id)
+      if field_id.nil?
+        fail ArgumentError, 'field_id cannot be nil'
+      end
+
+      @field_id = field_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] application_type Object to be assigned
+    def application_type=(application_type)
+      validator = EnumAttributeValidator.new('String', ["fertilizer", "seed", "pesticide"])
+      unless validator.valid?(application_type)
+        fail ArgumentError, "invalid value for \"application_type\", must be one of #{validator.allowable_values}."
+      end
+      @application_type = application_type
+    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 &&
+          field_id == o.field_id &&
+          application_type == o.application_type &&
+          soil_analysis_id == o.soil_analysis_id
+    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
+      [field_id, application_type, soil_analysis_id].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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
+
+  end
+
+end

data/lib/soilsidekick/models/get_agricultural_intelligence_request.rb

@@ -0,0 +1,225 @@
+=begin
+#SoilSidekick Pro API
+
+#Agricultural intelligence and soil analysis API with tier-based access control.  ## What's New in 1.2.0 - **Consumer Plant Care APIs**: Three new endpoints addressing top pain points in plant ID apps:   - `/safe-identification`: Toxic lookalike warnings and environmental context   - `/dynamic-care`: Hyper-localized, real-time care recommendations   - `/beginner-guidance`: Judgment-free, jargon-free plant guidance  ## Authentication All endpoints require an API key passed via the `x-api-key` header: ``` x-api-key: ak_your_api_key_here ```  API keys are generated through the dashboard and use the `ak_*` format.  ## Rate Limiting Rate limits are enforced based on your subscription tier: - **Free**: 10 req/min, 100 req/hour, 1,000 req/day - **Starter**: 30 req/min, 500 req/hour, 5,000 req/day - **Pro**: 100 req/min, 2,000 req/hour, 25,000 req/day - **Enterprise**: 500 req/min, 10,000 req/hour, 100,000 req/day  Rate limit information is returned in response headers: - `X-RateLimit-Limit`: Maximum requests in window - `X-RateLimit-Remaining`: Remaining requests in window - `X-RateLimit-Reset`: Unix timestamp when limit resets  ## Response Time SLAs All endpoints return response time headers for performance monitoring: - `X-Response-Time`: Human-readable response time (e.g., \"245ms\") - `X-Response-Time-Ms`: Response time in milliseconds - `X-Response-Time-Target`: Target response time for this endpoint - `X-Response-Time-Max`: Maximum acceptable response time - `X-Response-Time-Status`: Performance status (`optimal`, `acceptable`, `exceeded`)  ### Response Time Targets by Category  | Category | Target | Maximum | Endpoints | |----------|--------|---------|-----------| | **Fast** | 200ms | 500ms | county-lookup, check-subscription | | **Standard** | 500ms | 1,500ms | get-soil-data, territorial-water-quality | | **Complex** | 2,000ms | 5,000ms | agricultural-intelligence, gpt5-chat, visual-crop-analysis | | **Heavy** | 5,000ms | 15,000ms | live-agricultural-data, generate-vrt-prescription | 
+
+The version of the OpenAPI document: 3.0.0
+Contact: support@soilsidekickpro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SoilSidekick
+  class GetAgriculturalIntelligenceRequest < ApiModelBase
+    attr_accessor :county_fips
+
+    attr_accessor :analysis_type
+
+    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
+      {
+        :'county_fips' => :'county_fips',
+        :'analysis_type' => :'analysis_type'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'county_fips' => :'String',
+        :'analysis_type' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `SoilSidekick::GetAgriculturalIntelligenceRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SoilSidekick::GetAgriculturalIntelligenceRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'county_fips')
+        self.county_fips = attributes[:'county_fips']
+      else
+        self.county_fips = nil
+      end
+
+      if attributes.key?(:'analysis_type')
+        self.analysis_type = attributes[:'analysis_type']
+      else
+        self.analysis_type = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @county_fips.nil?
+        invalid_properties.push('invalid value for "county_fips", county_fips cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^[0-9]{5}$/)
+      if @county_fips !~ pattern
+        invalid_properties.push("invalid value for \"county_fips\", must conform to the pattern #{pattern}.")
+      end
+
+      if @analysis_type.nil?
+        invalid_properties.push('invalid value for "analysis_type", analysis_type cannot be nil.')
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @county_fips.nil?
+      return false if @county_fips !~ Regexp.new(/^[0-9]{5}$/)
+      return false if @analysis_type.nil?
+      analysis_type_validator = EnumAttributeValidator.new('String', ["crop_recommendation", "yield_prediction", "pest_analysis"])
+      return false unless analysis_type_validator.valid?(@analysis_type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] county_fips Value to be assigned
+    def county_fips=(county_fips)
+      if county_fips.nil?
+        fail ArgumentError, 'county_fips cannot be nil'
+      end
+
+      pattern = Regexp.new(/^[0-9]{5}$/)
+      if county_fips !~ pattern
+        fail ArgumentError, "invalid value for \"county_fips\", must conform to the pattern #{pattern}."
+      end
+
+      @county_fips = county_fips
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] analysis_type Object to be assigned
+    def analysis_type=(analysis_type)
+      validator = EnumAttributeValidator.new('String', ["crop_recommendation", "yield_prediction", "pest_analysis"])
+      unless validator.valid?(analysis_type)
+        fail ArgumentError, "invalid value for \"analysis_type\", must be one of #{validator.allowable_values}."
+      end
+      @analysis_type = analysis_type
+    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 &&
+          county_fips == o.county_fips &&
+          analysis_type == o.analysis_type
+    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
+      [county_fips, analysis_type].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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
+
+  end
+
+end