soilsidekick 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7527cf9be08c40d26f004c1ae64bb8a1779060e14b80feacc8281fae78334584
+  data.tar.gz: 5b5213850d4668bfd78107277779af9b2dde2934007747872d1f9be50b12a3d2
+SHA512:
+  metadata.gz: a6dce26289ebb2b372d25034055da4c630538189c1d8ededdd981f7801af06c4778035cb909a6562f246e7fa329bd9988044d52cd8be2a824511c28434fa8510
+  data.tar.gz: a183253010a0643383ff34e6919d478adab29b14b9248060401bed512374e64c9e498891a9595a22abea39a1d0fa01674a21f129e1be89587fe3dc971129870e

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,267 @@
+# soilsidekick
+
+SoilSidekick - the Ruby gem for the 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 |
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 3.0.0
+- Package version: 3.0.0
+- Generator version: 7.23.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://soilsidekick.com/support](https://soilsidekick.com/support)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build soilsidekick.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./soilsidekick-3.0.0.gem
+```
+
+(for development, run `gem install --dev ./soilsidekick-3.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'soilsidekick', '~> 3.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'soilsidekick', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+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::AIServicesApi.new
+generate_smart_report_summary_request = SoilSidekick::GenerateSmartReportSummaryRequest.new({report_type: 'soil', report_data: 3.56}) # GenerateSmartReportSummaryRequest | 
+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
+  #Generate AI report summary
+  result = api_instance.generate_smart_report_summary(generate_smart_report_summary_request, opts)
+  p result
+rescue SoilSidekick::ApiError => e
+  puts "Exception when calling AIServicesApi->generate_smart_report_summary: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://wzgnxkoeqzvueypwzvyn.supabase.co/functions/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*SoilSidekick::AIServicesApi* | [**generate_smart_report_summary**](docs/AIServicesApi.md#generate_smart_report_summary) | **POST** /smart-report-summary | Generate AI report summary
+*SoilSidekick::AIServicesApi* | [**get_agricultural_intelligence**](docs/AIServicesApi.md#get_agricultural_intelligence) | **POST** /agricultural-intelligence | Get AI-powered agricultural insights
+*SoilSidekick::AIServicesApi* | [**get_seasonal_planning_assistant**](docs/AIServicesApi.md#get_seasonal_planning_assistant) | **POST** /seasonal-planning-assistant | Get seasonal planning recommendations
+*SoilSidekick::AIServicesApi* | [**visual_crop_analysis**](docs/AIServicesApi.md#visual_crop_analysis) | **POST** /visual-crop-analysis | Analyze crop images
+*SoilSidekick::CarbonApi* | [**calculate_carbon_credits**](docs/CarbonApi.md#calculate_carbon_credits) | **POST** /carbon-credit-calculator | Calculate carbon credits
+*SoilSidekick::ConsumerPlantCareApi* | [**beginner_guidance**](docs/ConsumerPlantCareApi.md#beginner_guidance) | **POST** /beginner-guidance | Beginner-friendly plant guidance without jargon
+*SoilSidekick::ConsumerPlantCareApi* | [**dynamic_care**](docs/ConsumerPlantCareApi.md#dynamic_care) | **POST** /dynamic-care | Hyper-localized dynamic plant care recommendations
+*SoilSidekick::ConsumerPlantCareApi* | [**safe_identification**](docs/ConsumerPlantCareApi.md#safe_identification) | **POST** /safe-identification | Safe plant identification with toxic lookalike warnings
+*SoilSidekick::EnvironmentalApi* | [**calculate_environmental_impact**](docs/EnvironmentalApi.md#calculate_environmental_impact) | **POST** /environmental-impact-engine | Calculate environmental impact
+*SoilSidekick::GeographicApi* | [**county_lookup**](docs/GeographicApi.md#county_lookup) | **POST** /county-lookup | Search for counties
+*SoilSidekick::LeafEnginesApi* | [**leafengines_query**](docs/LeafEnginesApi.md#leafengines_query) | **POST** /leafengines-query | Query plant-environment compatibility
+*SoilSidekick::SatelliteDataApi* | [**get_satellite_data**](docs/SatelliteDataApi.md#get_satellite_data) | **POST** /alpha-earth-environmental-enhancement | Get satellite environmental data
+*SoilSidekick::SoilAnalysisApi* | [**get_live_agricultural_data**](docs/SoilAnalysisApi.md#get_live_agricultural_data) | **POST** /live-agricultural-data | Get live agricultural data
+*SoilSidekick::SoilAnalysisApi* | [**get_planting_calendar**](docs/SoilAnalysisApi.md#get_planting_calendar) | **POST** /multi-parameter-planting-calendar | Get planting calendar recommendations
+*SoilSidekick::SoilAnalysisApi* | [**get_soil_data**](docs/SoilAnalysisApi.md#get_soil_data) | **POST** /get-soil-data | Get soil analysis data
+*SoilSidekick::TurboQuantApi* | [**turbo_quant_capabilities**](docs/TurboQuantApi.md#turbo_quant_capabilities) | **POST** /turbo-quant-capabilities | Query TurboQuant device capabilities
+*SoilSidekick::VRTApi* | [**generate_vrt_prescription**](docs/VRTApi.md#generate_vrt_prescription) | **POST** /generate-vrt-prescription | Generate VRT prescription map
+*SoilSidekick::WaterQualityApi* | [**get_territorial_water_analytics**](docs/WaterQualityApi.md#get_territorial_water_analytics) | **POST** /territorial-water-analytics | Get territorial water analytics
+*SoilSidekick::WaterQualityApi* | [**get_water_quality**](docs/WaterQualityApi.md#get_water_quality) | **POST** /territorial-water-quality | Get water quality data
+
+
+## Documentation for Models
+
+ - [SoilSidekick::AIAnalysis](docs/AIAnalysis.md)
+ - [SoilSidekick::AIAnalysisRecommendationsInner](docs/AIAnalysisRecommendationsInner.md)
+ - [SoilSidekick::BeginnerGuidance](docs/BeginnerGuidance.md)
+ - [SoilSidekick::BeginnerGuidanceDetailedExplanation](docs/BeginnerGuidanceDetailedExplanation.md)
+ - [SoilSidekick::BeginnerGuidanceMetadata](docs/BeginnerGuidanceMetadata.md)
+ - [SoilSidekick::BeginnerGuidanceRequest](docs/BeginnerGuidanceRequest.md)
+ - [SoilSidekick::BeginnerGuidanceRequestLocation](docs/BeginnerGuidanceRequestLocation.md)
+ - [SoilSidekick::BeginnerGuidanceRequestPlantContext](docs/BeginnerGuidanceRequestPlantContext.md)
+ - [SoilSidekick::CalculateCarbonCreditsRequest](docs/CalculateCarbonCreditsRequest.md)
+ - [SoilSidekick::CalculateEnvironmentalImpactRequest](docs/CalculateEnvironmentalImpactRequest.md)
+ - [SoilSidekick::CalculateEnvironmentalImpactRequestProposedTreatmentsInner](docs/CalculateEnvironmentalImpactRequestProposedTreatmentsInner.md)
+ - [SoilSidekick::CalculateEnvironmentalImpactRequestSoilData](docs/CalculateEnvironmentalImpactRequestSoilData.md)
+ - [SoilSidekick::CalculateEnvironmentalImpactRequestWaterBodyData](docs/CalculateEnvironmentalImpactRequestWaterBodyData.md)
+ - [SoilSidekick::CarbonCreditCalculation](docs/CarbonCreditCalculation.md)
+ - [SoilSidekick::CarbonCreditCalculationCalculationDetails](docs/CarbonCreditCalculationCalculationDetails.md)
+ - [SoilSidekick::CarbonCreditCalculationCalculationDetailsMetadata](docs/CarbonCreditCalculationCalculationDetailsMetadata.md)
+ - [SoilSidekick::CarbonCreditCalculationCreditRecord](docs/CarbonCreditCalculationCreditRecord.md)
+ - [SoilSidekick::County](docs/County.md)
+ - [SoilSidekick::CountyLookup200Response](docs/CountyLookup200Response.md)
+ - [SoilSidekick::CountyLookupRequest](docs/CountyLookupRequest.md)
+ - [SoilSidekick::DynamicCare](docs/DynamicCare.md)
+ - [SoilSidekick::DynamicCareCareRecommendations](docs/DynamicCareCareRecommendations.md)
+ - [SoilSidekick::DynamicCareCareRecommendationsHumidity](docs/DynamicCareCareRecommendationsHumidity.md)
+ - [SoilSidekick::DynamicCareCareRecommendationsLight](docs/DynamicCareCareRecommendationsLight.md)
+ - [SoilSidekick::DynamicCareCareRecommendationsWatering](docs/DynamicCareCareRecommendationsWatering.md)
+ - [SoilSidekick::DynamicCareCurrentConditions](docs/DynamicCareCurrentConditions.md)
+ - [SoilSidekick::DynamicCareMetadata](docs/DynamicCareMetadata.md)
+ - [SoilSidekick::DynamicCarePlant](docs/DynamicCarePlant.md)
+ - [SoilSidekick::DynamicCareRequest](docs/DynamicCareRequest.md)
+ - [SoilSidekick::DynamicCareRequestContainerDetails](docs/DynamicCareRequestContainerDetails.md)
+ - [SoilSidekick::DynamicCareRequestEnvironment](docs/DynamicCareRequestEnvironment.md)
+ - [SoilSidekick::DynamicCareRequestLocation](docs/DynamicCareRequestLocation.md)
+ - [SoilSidekick::EnvironmentalImpact](docs/EnvironmentalImpact.md)
+ - [SoilSidekick::EnvironmentalImpactDetailedAnalysis](docs/EnvironmentalImpactDetailedAnalysis.md)
+ - [SoilSidekick::EnvironmentalImpactDetailedAnalysisEcoAlternatives](docs/EnvironmentalImpactDetailedAnalysisEcoAlternatives.md)
+ - [SoilSidekick::EnvironmentalImpactDetailedAnalysisEcoAlternativesAlternativesInner](docs/EnvironmentalImpactDetailedAnalysisEcoAlternativesAlternativesInner.md)
+ - [SoilSidekick::EnvironmentalImpactDetailedAnalysisRunoffRisk](docs/EnvironmentalImpactDetailedAnalysisRunoffRisk.md)
+ - [SoilSidekick::EnvironmentalImpactImpactAssessment](docs/EnvironmentalImpactImpactAssessment.md)
+ - [SoilSidekick::Error](docs/Error.md)
+ - [SoilSidekick::GenerateSmartReportSummaryRequest](docs/GenerateSmartReportSummaryRequest.md)
+ - [SoilSidekick::GenerateVRTPrescriptionRequest](docs/GenerateVRTPrescriptionRequest.md)
+ - [SoilSidekick::GetAgriculturalIntelligenceRequest](docs/GetAgriculturalIntelligenceRequest.md)
+ - [SoilSidekick::GetLiveAgriculturalDataRequest](docs/GetLiveAgriculturalDataRequest.md)
+ - [SoilSidekick::GetPlantingCalendarRequest](docs/GetPlantingCalendarRequest.md)
+ - [SoilSidekick::GetSatelliteDataRequest](docs/GetSatelliteDataRequest.md)
+ - [SoilSidekick::GetSeasonalPlanningAssistantRequest](docs/GetSeasonalPlanningAssistantRequest.md)
+ - [SoilSidekick::GetSeasonalPlanningAssistantRequestLocation](docs/GetSeasonalPlanningAssistantRequestLocation.md)
+ - [SoilSidekick::GetSoilDataRequest](docs/GetSoilDataRequest.md)
+ - [SoilSidekick::GetTerritorialWaterAnalyticsRequest](docs/GetTerritorialWaterAnalyticsRequest.md)
+ - [SoilSidekick::GetTerritorialWaterAnalyticsRequestDateRange](docs/GetTerritorialWaterAnalyticsRequestDateRange.md)
+ - [SoilSidekick::LeafEnginesCompatibility](docs/LeafEnginesCompatibility.md)
+ - [SoilSidekick::LeafEnginesCompatibilityData](docs/LeafEnginesCompatibilityData.md)
+ - [SoilSidekick::LeafEnginesCompatibilityDataBreakdown](docs/LeafEnginesCompatibilityDataBreakdown.md)
+ - [SoilSidekick::LeafEnginesCompatibilityDataBreakdownSoil](docs/LeafEnginesCompatibilityDataBreakdownSoil.md)
+ - [SoilSidekick::LeafEnginesCompatibilityDataMetadata](docs/LeafEnginesCompatibilityDataMetadata.md)
+ - [SoilSidekick::LeafEnginesCompatibilityUsage](docs/LeafEnginesCompatibilityUsage.md)
+ - [SoilSidekick::LeafenginesQueryRequest](docs/LeafenginesQueryRequest.md)
+ - [SoilSidekick::LeafenginesQueryRequestLocation](docs/LeafenginesQueryRequestLocation.md)
+ - [SoilSidekick::LeafenginesQueryRequestOptions](docs/LeafenginesQueryRequestOptions.md)
+ - [SoilSidekick::LeafenginesQueryRequestPlant](docs/LeafenginesQueryRequestPlant.md)
+ - [SoilSidekick::LeafenginesQueryRequestPlantCareRequirements](docs/LeafenginesQueryRequestPlantCareRequirements.md)
+ - [SoilSidekick::LeafenginesQueryRequestPlantCareRequirementsSoilPhRange](docs/LeafenginesQueryRequestPlantCareRequirementsSoilPhRange.md)
+ - [SoilSidekick::LiveAgriculturalData](docs/LiveAgriculturalData.md)
+ - [SoilSidekick::LiveAgriculturalDataData](docs/LiveAgriculturalDataData.md)
+ - [SoilSidekick::PlantingCalendar](docs/PlantingCalendar.md)
+ - [SoilSidekick::SafeIdentification](docs/SafeIdentification.md)
+ - [SoilSidekick::SafeIdentificationConfidenceBreakdown](docs/SafeIdentificationConfidenceBreakdown.md)
+ - [SoilSidekick::SafeIdentificationIdentification](docs/SafeIdentificationIdentification.md)
+ - [SoilSidekick::SafeIdentificationIdentificationPrimaryMatch](docs/SafeIdentificationIdentificationPrimaryMatch.md)
+ - [SoilSidekick::SafeIdentificationMetadata](docs/SafeIdentificationMetadata.md)
+ - [SoilSidekick::SafeIdentificationRequest](docs/SafeIdentificationRequest.md)
+ - [SoilSidekick::SafeIdentificationRequestContext](docs/SafeIdentificationRequestContext.md)
+ - [SoilSidekick::SafeIdentificationRequestLocation](docs/SafeIdentificationRequestLocation.md)
+ - [SoilSidekick::SafeIdentificationRequestLocationCoordinates](docs/SafeIdentificationRequestLocationCoordinates.md)
+ - [SoilSidekick::SafeIdentificationSafetyAnalysis](docs/SafeIdentificationSafetyAnalysis.md)
+ - [SoilSidekick::SafeIdentificationSafetyAnalysisLookalikesInner](docs/SafeIdentificationSafetyAnalysisLookalikesInner.md)
+ - [SoilSidekick::SatelliteData](docs/SatelliteData.md)
+ - [SoilSidekick::SeasonalPlanningResponse](docs/SeasonalPlanningResponse.md)
+ - [SoilSidekick::SeasonalPlanningResponseRecommendations](docs/SeasonalPlanningResponseRecommendations.md)
+ - [SoilSidekick::SeasonalPlanningResponseWeatherData](docs/SeasonalPlanningResponseWeatherData.md)
+ - [SoilSidekick::SmartReportSummary](docs/SmartReportSummary.md)
+ - [SoilSidekick::SmartReportSummarySummary](docs/SmartReportSummarySummary.md)
+ - [SoilSidekick::SoilData](docs/SoilData.md)
+ - [SoilSidekick::TerritorialWaterAnalytics](docs/TerritorialWaterAnalytics.md)
+ - [SoilSidekick::TerritorialWaterAnalyticsAnalytics](docs/TerritorialWaterAnalyticsAnalytics.md)
+ - [SoilSidekick::TurboQuantCapabilities](docs/TurboQuantCapabilities.md)
+ - [SoilSidekick::TurboQuantCapabilitiesEstimatedLatencyMs](docs/TurboQuantCapabilitiesEstimatedLatencyMs.md)
+ - [SoilSidekick::TurboQuantCapabilitiesRequest](docs/TurboQuantCapabilitiesRequest.md)
+ - [SoilSidekick::VRTPrescription](docs/VRTPrescription.md)
+ - [SoilSidekick::VRTPrescriptionZonesInner](docs/VRTPrescriptionZonesInner.md)
+ - [SoilSidekick::VisualCropAnalysis](docs/VisualCropAnalysis.md)
+ - [SoilSidekick::VisualCropAnalysisAnalysis](docs/VisualCropAnalysisAnalysis.md)
+ - [SoilSidekick::VisualCropAnalysisRequest](docs/VisualCropAnalysisRequest.md)
+ - [SoilSidekick::VisualCropAnalysisRequestLocation](docs/VisualCropAnalysisRequestLocation.md)
+ - [SoilSidekick::WaterQuality](docs/WaterQuality.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### ApiKeyAuth
+
+
+- **Type**: API key
+- **API key parameter name**: x-api-key
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AIAnalysis.md

@@ -0,0 +1,22 @@
+# SoilSidekick::AIAnalysis
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **analysis_type** | **String** |  | [optional] |
+| **confidence_score** | **Float** |  | [optional] |
+| **recommendations** | [**Array<AIAnalysisRecommendationsInner>**](AIAnalysisRecommendationsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'soilsidekick'
+
+instance = SoilSidekick::AIAnalysis.new(
+  analysis_type: null,
+  confidence_score: null,
+  recommendations: null
+)
+```
+

data/docs/AIAnalysisRecommendationsInner.md

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