@soilsidekick/sdk 1.1.0

package/src/models/VisualCropAnalysisAnalysis.ts

@@ -0,0 +1,109 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SoilSidekick Pro API
+ * Agricultural intelligence and soil analysis API with tier-based access control.  ## Authentication All endpoints require an API key passed via the `Authorization` header: ``` Authorization: Bearer ss_prod_your_api_key_here ```  ## 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 
+ *
+ * The version of the OpenAPI document: 1.1.0
+ * Contact: support@soilsidekick.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface VisualCropAnalysisAnalysis
+ */
+export interface VisualCropAnalysisAnalysis {
+    /**
+     * 
+     * @type {string}
+     * @memberof VisualCropAnalysisAnalysis
+     */
+    analysisType?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof VisualCropAnalysisAnalysis
+     */
+    confidence?: number;
+    /**
+     * 
+     * @type {object}
+     * @memberof VisualCropAnalysisAnalysis
+     */
+    findings?: object;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof VisualCropAnalysisAnalysis
+     */
+    recommendations?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof VisualCropAnalysisAnalysis
+     */
+    severity?: VisualCropAnalysisAnalysisSeverityEnum;
+}
+
+
+/**
+ * @export
+ */
+export const VisualCropAnalysisAnalysisSeverityEnum = {
+    Low: 'low',
+    Medium: 'medium',
+    High: 'high'
+} as const;
+export type VisualCropAnalysisAnalysisSeverityEnum = typeof VisualCropAnalysisAnalysisSeverityEnum[keyof typeof VisualCropAnalysisAnalysisSeverityEnum];
+
+
+/**
+ * Check if a given object implements the VisualCropAnalysisAnalysis interface.
+ */
+export function instanceOfVisualCropAnalysisAnalysis(value: object): value is VisualCropAnalysisAnalysis {
+    return true;
+}
+
+export function VisualCropAnalysisAnalysisFromJSON(json: any): VisualCropAnalysisAnalysis {
+    return VisualCropAnalysisAnalysisFromJSONTyped(json, false);
+}
+
+export function VisualCropAnalysisAnalysisFromJSONTyped(json: any, ignoreDiscriminator: boolean): VisualCropAnalysisAnalysis {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'analysisType': json['analysis_type'] == null ? undefined : json['analysis_type'],
+        'confidence': json['confidence'] == null ? undefined : json['confidence'],
+        'findings': json['findings'] == null ? undefined : json['findings'],
+        'recommendations': json['recommendations'] == null ? undefined : json['recommendations'],
+        'severity': json['severity'] == null ? undefined : json['severity'],
+    };
+}
+
+export function VisualCropAnalysisAnalysisToJSON(json: any): VisualCropAnalysisAnalysis {
+    return VisualCropAnalysisAnalysisToJSONTyped(json, false);
+}
+
+export function VisualCropAnalysisAnalysisToJSONTyped(value?: VisualCropAnalysisAnalysis | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'analysis_type': value['analysisType'],
+        'confidence': value['confidence'],
+        'findings': value['findings'],
+        'recommendations': value['recommendations'],
+        'severity': value['severity'],
+    };
+}
+

package/src/models/VisualCropAnalysisRequest.ts

@@ -0,0 +1,111 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SoilSidekick Pro API
+ * Agricultural intelligence and soil analysis API with tier-based access control.  ## Authentication All endpoints require an API key passed via the `Authorization` header: ``` Authorization: Bearer ss_prod_your_api_key_here ```  ## 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 
+ *
+ * The version of the OpenAPI document: 1.1.0
+ * Contact: support@soilsidekick.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { VisualCropAnalysisRequestLocation } from './VisualCropAnalysisRequestLocation';
+import {
+    VisualCropAnalysisRequestLocationFromJSON,
+    VisualCropAnalysisRequestLocationFromJSONTyped,
+    VisualCropAnalysisRequestLocationToJSON,
+    VisualCropAnalysisRequestLocationToJSONTyped,
+} from './VisualCropAnalysisRequestLocation';
+
+/**
+ * 
+ * @export
+ * @interface VisualCropAnalysisRequest
+ */
+export interface VisualCropAnalysisRequest {
+    /**
+     * Base64 encoded image or image URL
+     * @type {string}
+     * @memberof VisualCropAnalysisRequest
+     */
+    image: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof VisualCropAnalysisRequest
+     */
+    analysisType: VisualCropAnalysisRequestAnalysisTypeEnum;
+    /**
+     * 
+     * @type {VisualCropAnalysisRequestLocation}
+     * @memberof VisualCropAnalysisRequest
+     */
+    location?: VisualCropAnalysisRequestLocation;
+    /**
+     * Type of crop being analyzed
+     * @type {string}
+     * @memberof VisualCropAnalysisRequest
+     */
+    cropType?: string;
+}
+
+
+/**
+ * @export
+ */
+export const VisualCropAnalysisRequestAnalysisTypeEnum = {
+    PestDetection: 'pest_detection',
+    CropHealth: 'crop_health',
+    DiseaseScreening: 'disease_screening'
+} as const;
+export type VisualCropAnalysisRequestAnalysisTypeEnum = typeof VisualCropAnalysisRequestAnalysisTypeEnum[keyof typeof VisualCropAnalysisRequestAnalysisTypeEnum];
+
+
+/**
+ * Check if a given object implements the VisualCropAnalysisRequest interface.
+ */
+export function instanceOfVisualCropAnalysisRequest(value: object): value is VisualCropAnalysisRequest {
+    if (!('image' in value) || value['image'] === undefined) return false;
+    if (!('analysisType' in value) || value['analysisType'] === undefined) return false;
+    return true;
+}
+
+export function VisualCropAnalysisRequestFromJSON(json: any): VisualCropAnalysisRequest {
+    return VisualCropAnalysisRequestFromJSONTyped(json, false);
+}
+
+export function VisualCropAnalysisRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): VisualCropAnalysisRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'image': json['image'],
+        'analysisType': json['analysis_type'],
+        'location': json['location'] == null ? undefined : VisualCropAnalysisRequestLocationFromJSON(json['location']),
+        'cropType': json['crop_type'] == null ? undefined : json['crop_type'],
+    };
+}
+
+export function VisualCropAnalysisRequestToJSON(json: any): VisualCropAnalysisRequest {
+    return VisualCropAnalysisRequestToJSONTyped(json, false);
+}
+
+export function VisualCropAnalysisRequestToJSONTyped(value?: VisualCropAnalysisRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'image': value['image'],
+        'analysis_type': value['analysisType'],
+        'location': VisualCropAnalysisRequestLocationToJSON(value['location']),
+        'crop_type': value['cropType'],
+    };
+}
+

package/src/models/VisualCropAnalysisRequestLocation.ts

@@ -0,0 +1,81 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SoilSidekick Pro API
+ * Agricultural intelligence and soil analysis API with tier-based access control.  ## Authentication All endpoints require an API key passed via the `Authorization` header: ``` Authorization: Bearer ss_prod_your_api_key_here ```  ## 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 
+ *
+ * The version of the OpenAPI document: 1.1.0
+ * Contact: support@soilsidekick.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface VisualCropAnalysisRequestLocation
+ */
+export interface VisualCropAnalysisRequestLocation {
+    /**
+     * 
+     * @type {string}
+     * @memberof VisualCropAnalysisRequestLocation
+     */
+    countyFips?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof VisualCropAnalysisRequestLocation
+     */
+    countyName?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof VisualCropAnalysisRequestLocation
+     */
+    stateCode?: string;
+}
+
+/**
+ * Check if a given object implements the VisualCropAnalysisRequestLocation interface.
+ */
+export function instanceOfVisualCropAnalysisRequestLocation(value: object): value is VisualCropAnalysisRequestLocation {
+    return true;
+}
+
+export function VisualCropAnalysisRequestLocationFromJSON(json: any): VisualCropAnalysisRequestLocation {
+    return VisualCropAnalysisRequestLocationFromJSONTyped(json, false);
+}
+
+export function VisualCropAnalysisRequestLocationFromJSONTyped(json: any, ignoreDiscriminator: boolean): VisualCropAnalysisRequestLocation {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'countyFips': json['county_fips'] == null ? undefined : json['county_fips'],
+        'countyName': json['county_name'] == null ? undefined : json['county_name'],
+        'stateCode': json['state_code'] == null ? undefined : json['state_code'],
+    };
+}
+
+export function VisualCropAnalysisRequestLocationToJSON(json: any): VisualCropAnalysisRequestLocation {
+    return VisualCropAnalysisRequestLocationToJSONTyped(json, false);
+}
+
+export function VisualCropAnalysisRequestLocationToJSONTyped(value?: VisualCropAnalysisRequestLocation | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'county_fips': value['countyFips'],
+        'county_name': value['countyName'],
+        'state_code': value['stateCode'],
+    };
+}
+

package/src/models/WaterQuality.ts

@@ -0,0 +1,125 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SoilSidekick Pro API
+ * Agricultural intelligence and soil analysis API with tier-based access control.  ## Authentication All endpoints require an API key passed via the `Authorization` header: ``` Authorization: Bearer ss_prod_your_api_key_here ```  ## 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 
+ *
+ * The version of the OpenAPI document: 1.1.0
+ * Contact: support@soilsidekick.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface WaterQuality
+ */
+export interface WaterQuality {
+    /**
+     * 
+     * @type {string}
+     * @memberof WaterQuality
+     */
+    countyFips?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof WaterQuality
+     */
+    ph?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof WaterQuality
+     */
+    dissolvedOxygen?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof WaterQuality
+     */
+    turbidity?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof WaterQuality
+     */
+    nitrates?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof WaterQuality
+     */
+    phosphates?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof WaterQuality
+     */
+    contaminationRisk?: WaterQualityContaminationRiskEnum;
+}
+
+
+/**
+ * @export
+ */
+export const WaterQualityContaminationRiskEnum = {
+    Low: 'low',
+    Medium: 'medium',
+    High: 'high'
+} as const;
+export type WaterQualityContaminationRiskEnum = typeof WaterQualityContaminationRiskEnum[keyof typeof WaterQualityContaminationRiskEnum];
+
+
+/**
+ * Check if a given object implements the WaterQuality interface.
+ */
+export function instanceOfWaterQuality(value: object): value is WaterQuality {
+    return true;
+}
+
+export function WaterQualityFromJSON(json: any): WaterQuality {
+    return WaterQualityFromJSONTyped(json, false);
+}
+
+export function WaterQualityFromJSONTyped(json: any, ignoreDiscriminator: boolean): WaterQuality {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'countyFips': json['county_fips'] == null ? undefined : json['county_fips'],
+        'ph': json['ph'] == null ? undefined : json['ph'],
+        'dissolvedOxygen': json['dissolved_oxygen'] == null ? undefined : json['dissolved_oxygen'],
+        'turbidity': json['turbidity'] == null ? undefined : json['turbidity'],
+        'nitrates': json['nitrates'] == null ? undefined : json['nitrates'],
+        'phosphates': json['phosphates'] == null ? undefined : json['phosphates'],
+        'contaminationRisk': json['contamination_risk'] == null ? undefined : json['contamination_risk'],
+    };
+}
+
+export function WaterQualityToJSON(json: any): WaterQuality {
+    return WaterQualityToJSONTyped(json, false);
+}
+
+export function WaterQualityToJSONTyped(value?: WaterQuality | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'county_fips': value['countyFips'],
+        'ph': value['ph'],
+        'dissolved_oxygen': value['dissolvedOxygen'],
+        'turbidity': value['turbidity'],
+        'nitrates': value['nitrates'],
+        'phosphates': value['phosphates'],
+        'contamination_risk': value['contaminationRisk'],
+    };
+}
+

package/src/models/index.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './AIAnalysis';
+export * from './AIAnalysisRecommendationsInner';
+export * from './CalculateCarbonCreditsRequest';
+export * from './CalculateEnvironmentalImpactRequest';
+export * from './CalculateEnvironmentalImpactRequestProposedTreatmentsInner';
+export * from './CalculateEnvironmentalImpactRequestSoilData';
+export * from './CalculateEnvironmentalImpactRequestWaterBodyData';
+export * from './CarbonCreditCalculation';
+export * from './CarbonCreditCalculationCalculationDetails';
+export * from './CarbonCreditCalculationCalculationDetailsMetadata';
+export * from './CarbonCreditCalculationCreditRecord';
+export * from './County';
+export * from './CountyLookup200Response';
+export * from './CountyLookupRequest';
+export * from './EnvironmentalImpact';
+export * from './EnvironmentalImpactDetailedAnalysis';
+export * from './EnvironmentalImpactDetailedAnalysisEcoAlternatives';
+export * from './EnvironmentalImpactDetailedAnalysisEcoAlternativesAlternativesInner';
+export * from './EnvironmentalImpactDetailedAnalysisRunoffRisk';
+export * from './EnvironmentalImpactImpactAssessment';
+export * from './GenerateSmartReportSummaryRequest';
+export * from './GenerateVRTPrescriptionRequest';
+export * from './GetAgriculturalIntelligenceRequest';
+export * from './GetLiveAgriculturalDataRequest';
+export * from './GetPlantingCalendarRequest';
+export * from './GetSatelliteDataRequest';
+export * from './GetSeasonalPlanningAssistantRequest';
+export * from './GetSeasonalPlanningAssistantRequestLocation';
+export * from './GetSoilDataRequest';
+export * from './GetTerritorialWaterAnalyticsRequest';
+export * from './GetTerritorialWaterAnalyticsRequestDateRange';
+export * from './GetWaterQualityRequest';
+export * from './LeafEnginesCompatibility';
+export * from './LeafEnginesCompatibilityData';
+export * from './LeafEnginesCompatibilityDataBreakdown';
+export * from './LeafEnginesCompatibilityDataBreakdownSoil';
+export * from './LeafEnginesCompatibilityDataMetadata';
+export * from './LeafEnginesCompatibilityUsage';
+export * from './LeafenginesQueryRequest';
+export * from './LeafenginesQueryRequestLocation';
+export * from './LeafenginesQueryRequestOptions';
+export * from './LeafenginesQueryRequestPlant';
+export * from './LeafenginesQueryRequestPlantCareRequirements';
+export * from './LeafenginesQueryRequestPlantCareRequirementsSoilPhRange';
+export * from './LiveAgriculturalData';
+export * from './LiveAgriculturalDataData';
+export * from './ModelError';
+export * from './PlantingCalendar';
+export * from './SatelliteData';
+export * from './SeasonalPlanningResponse';
+export * from './SeasonalPlanningResponseRecommendations';
+export * from './SeasonalPlanningResponseWeatherData';
+export * from './SmartReportSummary';
+export * from './SmartReportSummarySummary';
+export * from './SoilData';
+export * from './TerritorialWaterAnalytics';
+export * from './TerritorialWaterAnalyticsAnalytics';
+export * from './VRTPrescription';
+export * from './VRTPrescriptionZonesInner';
+export * from './VisualCropAnalysis';
+export * from './VisualCropAnalysisAnalysis';
+export * from './VisualCropAnalysisRequest';
+export * from './VisualCropAnalysisRequestLocation';
+export * from './WaterQuality';