soilsidekick 3.0.0

data/docs/DynamicCareRequestEnvironment.md

@@ -0,0 +1,20 @@
+# SoilSidekick::DynamicCareRequestEnvironment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **light_exposure** | **String** |  | [optional] |
+| **humidity_level** | **String** | Approximate indoor humidity if applicable | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::DynamicCareRequestEnvironment.new(
+  light_exposure: null,
+  humidity_level: null
+)
+```
+

data/docs/DynamicCareRequestLocation.md

@@ -0,0 +1,22 @@
+# SoilSidekick::DynamicCareRequestLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **county_fips** | **String** |  |  |
+| **state_code** | **String** |  | [optional] |
+| **indoor** | **Boolean** | Whether the plant is indoors | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::DynamicCareRequestLocation.new(
+  county_fips: null,
+  state_code: null,
+  indoor: null
+)
+```
+

data/docs/EnvironmentalApi.md

@@ -0,0 +1,87 @@
+# SoilSidekick::EnvironmentalApi
+
+All URIs are relative to *https://wzgnxkoeqzvueypwzvyn.supabase.co/functions/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**calculate_environmental_impact**](EnvironmentalApi.md#calculate_environmental_impact) | **POST** /environmental-impact-engine | Calculate environmental impact |
+
+
+## calculate_environmental_impact
+
+> <EnvironmentalImpact> calculate_environmental_impact(calculate_environmental_impact_request, opts)
+
+Calculate environmental impact
+
+Assess environmental impact including runoff risk, contamination, and eco-friendly alternatives
+
+### Examples
+
+```ruby
+require 'time'
+require 'soilsidekick'
+# setup authorization
+SoilSidekick.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = SoilSidekick::EnvironmentalApi.new
+calculate_environmental_impact_request = SoilSidekick::CalculateEnvironmentalImpactRequest.new({analysis_id: 'analysis_id_example', county_fips: 'county_fips_example', soil_data: SoilSidekick::CalculateEnvironmentalImpactRequestSoilData.new}) # CalculateEnvironmentalImpactRequest | 
+opts = {
+  x_tq_context_mode: 4096, # Integer | TurboQuant extended context window size (tokens). With 3-bit KV cache, context windows up to 24K tokens are feasible within the same memory budget as standard 4K. 
+  x_tq_kv_cache_hint: 'none', # String | KV cache management hint. - `none`: No caching (default) - `reuse`: Reuse KV cache from previous request in same session (40-60% compute savings) - `persist`: Persist cache to disk for cross-session reuse 
+  x_tq_model_tier: 'auto' # String | Preferred model tier for inference. - `auto`: Server selects optimal model based on device capabilities - `gemma-2b`: Lightweight model (~0.5GB KV with TQ) - `gemma-7b`: Full model, standard KV cache - `gemma-7b-tq`: Full model with TurboQuant 3-bit KV cache (~1.3GB) 
+}
+
+begin
+  # Calculate environmental impact
+  result = api_instance.calculate_environmental_impact(calculate_environmental_impact_request, opts)
+  p result
+rescue SoilSidekick::ApiError => e
+  puts "Error when calling EnvironmentalApi->calculate_environmental_impact: #{e}"
+end
+```
+
+#### Using the calculate_environmental_impact_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EnvironmentalImpact>, Integer, Hash)> calculate_environmental_impact_with_http_info(calculate_environmental_impact_request, opts)
+
+```ruby
+begin
+  # Calculate environmental impact
+  data, status_code, headers = api_instance.calculate_environmental_impact_with_http_info(calculate_environmental_impact_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EnvironmentalImpact>
+rescue SoilSidekick::ApiError => e
+  puts "Error when calling EnvironmentalApi->calculate_environmental_impact_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **calculate_environmental_impact_request** | [**CalculateEnvironmentalImpactRequest**](CalculateEnvironmentalImpactRequest.md) |  |  |
+| **x_tq_context_mode** | **Integer** | TurboQuant extended context window size (tokens). With 3-bit KV cache, context windows up to 24K tokens are feasible within the same memory budget as standard 4K.  | [optional][default to 4096] |
+| **x_tq_kv_cache_hint** | **String** | KV cache management hint. - &#x60;none&#x60;: No caching (default) - &#x60;reuse&#x60;: Reuse KV cache from previous request in same session (40-60% compute savings) - &#x60;persist&#x60;: Persist cache to disk for cross-session reuse  | [optional][default to &#39;none&#39;] |
+| **x_tq_model_tier** | **String** | Preferred model tier for inference. - &#x60;auto&#x60;: Server selects optimal model based on device capabilities - &#x60;gemma-2b&#x60;: Lightweight model (~0.5GB KV with TQ) - &#x60;gemma-7b&#x60;: Full model, standard KV cache - &#x60;gemma-7b-tq&#x60;: Full model with TurboQuant 3-bit KV cache (~1.3GB)  | [optional][default to &#39;auto&#39;] |
+
+### Return type
+
+[**EnvironmentalImpact**](EnvironmentalImpact.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/EnvironmentalImpact.md

@@ -0,0 +1,22 @@
+# SoilSidekick::EnvironmentalImpact
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **impact_assessment** | [**EnvironmentalImpactImpactAssessment**](EnvironmentalImpactImpactAssessment.md) |  | [optional] |
+| **detailed_analysis** | [**EnvironmentalImpactDetailedAnalysis**](EnvironmentalImpactDetailedAnalysis.md) |  | [optional] |
+| **recommendations** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::EnvironmentalImpact.new(
+  impact_assessment: null,
+  detailed_analysis: null,
+  recommendations: null
+)
+```
+

data/docs/EnvironmentalImpactDetailedAnalysis.md

@@ -0,0 +1,26 @@
+# SoilSidekick::EnvironmentalImpactDetailedAnalysis
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **runoff_risk** | [**EnvironmentalImpactDetailedAnalysisRunoffRisk**](EnvironmentalImpactDetailedAnalysisRunoffRisk.md) |  | [optional] |
+| **contamination_assessment** | **Object** |  | [optional] |
+| **eco_alternatives** | [**EnvironmentalImpactDetailedAnalysisEcoAlternatives**](EnvironmentalImpactDetailedAnalysisEcoAlternatives.md) |  | [optional] |
+| **carbon_analysis** | **Object** |  | [optional] |
+| **biodiversity_assessment** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::EnvironmentalImpactDetailedAnalysis.new(
+  runoff_risk: null,
+  contamination_assessment: null,
+  eco_alternatives: null,
+  carbon_analysis: null,
+  biodiversity_assessment: null
+)
+```
+

data/docs/EnvironmentalImpactDetailedAnalysisEcoAlternatives.md

@@ -0,0 +1,18 @@
+# SoilSidekick::EnvironmentalImpactDetailedAnalysisEcoAlternatives
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **alternatives** | [**Array<EnvironmentalImpactDetailedAnalysisEcoAlternativesAlternativesInner>**](EnvironmentalImpactDetailedAnalysisEcoAlternativesAlternativesInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::EnvironmentalImpactDetailedAnalysisEcoAlternatives.new(
+  alternatives: null
+)
+```
+

data/docs/EnvironmentalImpactDetailedAnalysisEcoAlternativesAlternativesInner.md

@@ -0,0 +1,26 @@
+# SoilSidekick::EnvironmentalImpactDetailedAnalysisEcoAlternativesAlternativesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category** | **String** |  | [optional] |
+| **alternative** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **environmental_benefit** | **String** |  | [optional] |
+| **effectiveness_score** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::EnvironmentalImpactDetailedAnalysisEcoAlternativesAlternativesInner.new(
+  category: null,
+  alternative: null,
+  description: null,
+  environmental_benefit: null,
+  effectiveness_score: null
+)
+```
+

data/docs/EnvironmentalImpactDetailedAnalysisRunoffRisk.md

@@ -0,0 +1,22 @@
+# SoilSidekick::EnvironmentalImpactDetailedAnalysisRunoffRisk
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **score** | **Float** |  | [optional] |
+| **risk_level** | **String** |  | [optional] |
+| **contributing_factors** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::EnvironmentalImpactDetailedAnalysisRunoffRisk.new(
+  score: null,
+  risk_level: null,
+  contributing_factors: null
+)
+```
+

data/docs/EnvironmentalImpactImpactAssessment.md

@@ -0,0 +1,26 @@
+# SoilSidekick::EnvironmentalImpactImpactAssessment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **runoff_risk_score** | **Float** |  | [optional] |
+| **water_body_proximity** | **Float** |  | [optional] |
+| **contamination_risk** | **String** |  | [optional] |
+| **carbon_footprint_score** | **Float** |  | [optional] |
+| **biodiversity_impact** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::EnvironmentalImpactImpactAssessment.new(
+  runoff_risk_score: null,
+  water_body_proximity: null,
+  contamination_risk: null,
+  carbon_footprint_score: null,
+  biodiversity_impact: null
+)
+```
+

data/docs/Error.md

@@ -0,0 +1,22 @@
+# SoilSidekick::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::Error.new(
+  error: null,
+  message: null,
+  code: null
+)
+```
+

data/docs/GenerateSmartReportSummaryRequest.md

@@ -0,0 +1,20 @@
+# SoilSidekick::GenerateSmartReportSummaryRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **report_type** | **String** |  |  |
+| **report_data** | **Object** | Report data to summarize |  |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::GenerateSmartReportSummaryRequest.new(
+  report_type: null,
+  report_data: null
+)
+```
+

data/docs/GenerateVRTPrescriptionRequest.md

@@ -0,0 +1,22 @@
+# SoilSidekick::GenerateVRTPrescriptionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_id** | **String** |  |  |
+| **application_type** | **String** |  |  |
+| **soil_analysis_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::GenerateVRTPrescriptionRequest.new(
+  field_id: null,
+  application_type: null,
+  soil_analysis_id: null
+)
+```
+

data/docs/GeographicApi.md

@@ -0,0 +1,79 @@
+# SoilSidekick::GeographicApi
+
+All URIs are relative to *https://wzgnxkoeqzvueypwzvyn.supabase.co/functions/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**county_lookup**](GeographicApi.md#county_lookup) | **POST** /county-lookup | Search for counties |
+
+
+## county_lookup
+
+> <CountyLookup200Response> county_lookup(county_lookup_request)
+
+Search for counties
+
+Search counties by name, state, or FIPS code
+
+### Examples
+
+```ruby
+require 'time'
+require 'soilsidekick'
+# setup authorization
+SoilSidekick.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = SoilSidekick::GeographicApi.new
+county_lookup_request = SoilSidekick::CountyLookupRequest.new({term: 'Miami-Dade'}) # CountyLookupRequest | 
+
+begin
+  # Search for counties
+  result = api_instance.county_lookup(county_lookup_request)
+  p result
+rescue SoilSidekick::ApiError => e
+  puts "Error when calling GeographicApi->county_lookup: #{e}"
+end
+```
+
+#### Using the county_lookup_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CountyLookup200Response>, Integer, Hash)> county_lookup_with_http_info(county_lookup_request)
+
+```ruby
+begin
+  # Search for counties
+  data, status_code, headers = api_instance.county_lookup_with_http_info(county_lookup_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CountyLookup200Response>
+rescue SoilSidekick::ApiError => e
+  puts "Error when calling GeographicApi->county_lookup_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **county_lookup_request** | [**CountyLookupRequest**](CountyLookupRequest.md) |  |  |
+
+### Return type
+
+[**CountyLookup200Response**](CountyLookup200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/GetAgriculturalIntelligenceRequest.md

@@ -0,0 +1,20 @@
+# SoilSidekick::GetAgriculturalIntelligenceRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **county_fips** | **String** |  |  |
+| **analysis_type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::GetAgriculturalIntelligenceRequest.new(
+  county_fips: null,
+  analysis_type: null
+)
+```
+

data/docs/GetLiveAgriculturalDataRequest.md

@@ -0,0 +1,24 @@
+# SoilSidekick::GetLiveAgriculturalDataRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **county_fips** | **String** |  |  |
+| **data_types** | **Array<String>** | Types of data to fetch |  |
+| **state_code** | **String** |  |  |
+| **county_name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::GetLiveAgriculturalDataRequest.new(
+  county_fips: null,
+  data_types: null,
+  state_code: null,
+  county_name: null
+)
+```
+

data/docs/GetPlantingCalendarRequest.md

@@ -0,0 +1,20 @@
+# SoilSidekick::GetPlantingCalendarRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **county_fips** | **String** |  |  |
+| **crop_type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::GetPlantingCalendarRequest.new(
+  county_fips: null,
+  crop_type: corn
+)
+```
+

data/docs/GetSatelliteDataRequest.md

@@ -0,0 +1,20 @@
+# SoilSidekick::GetSatelliteDataRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **latitude** | **Float** |  |  |
+| **longitude** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::GetSatelliteDataRequest.new(
+  latitude: null,
+  longitude: null
+)
+```
+

data/docs/GetSeasonalPlanningAssistantRequest.md

@@ -0,0 +1,26 @@
+# SoilSidekick::GetSeasonalPlanningAssistantRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **location** | [**GetSeasonalPlanningAssistantRequestLocation**](GetSeasonalPlanningAssistantRequestLocation.md) |  |  |
+| **soil_data** | **Object** | Optional soil data for enhanced recommendations | [optional] |
+| **planning_type** | **String** |  |  |
+| **crop_preferences** | **Array<String>** |  | [optional] |
+| **timeframe** | **String** | Planning timeframe (e.g., \"3 months\", \"1 year\") | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::GetSeasonalPlanningAssistantRequest.new(
+  location: null,
+  soil_data: null,
+  planning_type: null,
+  crop_preferences: null,
+  timeframe: null
+)
+```
+

data/docs/GetSeasonalPlanningAssistantRequestLocation.md

@@ -0,0 +1,22 @@
+# SoilSidekick::GetSeasonalPlanningAssistantRequestLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **county_fips** | **String** |  | [optional] |
+| **state_code** | **String** |  | [optional] |
+| **county_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::GetSeasonalPlanningAssistantRequestLocation.new(
+  county_fips: null,
+  state_code: null,
+  county_name: null
+)
+```
+

data/docs/GetSoilDataRequest.md

@@ -0,0 +1,18 @@
+# SoilSidekick::GetSoilDataRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **county_fips** | **String** | 5-digit FIPS code |  |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::GetSoilDataRequest.new(
+  county_fips: 12345
+)
+```
+

data/docs/GetTerritorialWaterAnalyticsRequest.md

@@ -0,0 +1,22 @@
+# SoilSidekick::GetTerritorialWaterAnalyticsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **territory_type** | **String** | Type of territory to analyze | [optional] |
+| **epa_region** | **String** | EPA region identifier | [optional] |
+| **date_range** | [**GetTerritorialWaterAnalyticsRequestDateRange**](GetTerritorialWaterAnalyticsRequestDateRange.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::GetTerritorialWaterAnalyticsRequest.new(
+  territory_type: null,
+  epa_region: null,
+  date_range: null
+)
+```
+

data/docs/GetTerritorialWaterAnalyticsRequestDateRange.md

@@ -0,0 +1,20 @@
+# SoilSidekick::GetTerritorialWaterAnalyticsRequestDateRange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_date** | **Date** |  | [optional] |
+| **end_date** | **Date** |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::GetTerritorialWaterAnalyticsRequestDateRange.new(
+  start_date: null,
+  end_date: null
+)
+```
+