@soilsidekick/sdk 1.1.0

package/docs/VisualCropAnalysisRequest.md

@@ -0,0 +1,40 @@
+
+# VisualCropAnalysisRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`image` | string
+`analysisType` | string
+`location` | [VisualCropAnalysisRequestLocation](VisualCropAnalysisRequestLocation.md)
+`cropType` | string
+
+## Example
+
+```typescript
+import type { VisualCropAnalysisRequest } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "image": null,
+  "analysisType": null,
+  "location": null,
+  "cropType": null,
+} satisfies VisualCropAnalysisRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as VisualCropAnalysisRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/VisualCropAnalysisRequestLocation.md

@@ -0,0 +1,38 @@
+
+# VisualCropAnalysisRequestLocation
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`countyFips` | string
+`countyName` | string
+`stateCode` | string
+
+## Example
+
+```typescript
+import type { VisualCropAnalysisRequestLocation } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "countyFips": null,
+  "countyName": null,
+  "stateCode": null,
+} satisfies VisualCropAnalysisRequestLocation
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as VisualCropAnalysisRequestLocation
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WaterQuality.md

@@ -0,0 +1,46 @@
+
+# WaterQuality
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`countyFips` | string
+`ph` | number
+`dissolvedOxygen` | number
+`turbidity` | number
+`nitrates` | number
+`phosphates` | number
+`contaminationRisk` | string
+
+## Example
+
+```typescript
+import type { WaterQuality } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "countyFips": null,
+  "ph": null,
+  "dissolvedOxygen": null,
+  "turbidity": null,
+  "nitrates": null,
+  "phosphates": null,
+  "contaminationRisk": null,
+} satisfies WaterQuality
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WaterQuality
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WaterQualityApi.md

@@ -0,0 +1,158 @@
+# WaterQualityApi
+
+All URIs are relative to *https://wzgnxkoeqzvueypwzvyn.supabase.co/functions/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getTerritorialWaterAnalytics**](WaterQualityApi.md#getterritorialwateranalyticsoperation) | **POST** /territorial-water-analytics | Get territorial water analytics |
+| [**getWaterQuality**](WaterQualityApi.md#getwaterqualityoperation) | **POST** /territorial-water-quality | Get water quality data |
+
+
+
+## getTerritorialWaterAnalytics
+
+> TerritorialWaterAnalytics getTerritorialWaterAnalytics(getTerritorialWaterAnalyticsRequest)
+
+Get territorial water analytics
+
+Generate territorial water quality analytics across regions
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WaterQualityApi,
+} from '@soilsidekick/sdk';
+import type { GetTerritorialWaterAnalyticsOperationRequest } from '@soilsidekick/sdk';
+
+async function example() {
+  console.log("🚀 Testing @soilsidekick/sdk SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new WaterQualityApi(config);
+
+  const body = {
+    // GetTerritorialWaterAnalyticsRequest
+    getTerritorialWaterAnalyticsRequest: ...,
+  } satisfies GetTerritorialWaterAnalyticsOperationRequest;
+
+  try {
+    const data = await api.getTerritorialWaterAnalytics(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getTerritorialWaterAnalyticsRequest** | [GetTerritorialWaterAnalyticsRequest](GetTerritorialWaterAnalyticsRequest.md) |  | |
+
+### Return type
+
+[**TerritorialWaterAnalytics**](TerritorialWaterAnalytics.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+| **401** | Authentication required or invalid API key |  -  |
+| **403** | Tier restriction - upgrade required |  -  |
+| **429** | Rate limit exceeded |  * X-RateLimit-Limit -  <br>  * X-RateLimit-Remaining -  <br>  * X-RateLimit-Reset -  <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getWaterQuality
+
+> WaterQuality getWaterQuality(getWaterQualityRequest)
+
+Get water quality data
+
+Retrieve water quality metrics for a specific county
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WaterQualityApi,
+} from '@soilsidekick/sdk';
+import type { GetWaterQualityOperationRequest } from '@soilsidekick/sdk';
+
+async function example() {
+  console.log("🚀 Testing @soilsidekick/sdk SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new WaterQualityApi(config);
+
+  const body = {
+    // GetWaterQualityRequest
+    getWaterQualityRequest: ...,
+  } satisfies GetWaterQualityOperationRequest;
+
+  try {
+    const data = await api.getWaterQuality(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getWaterQualityRequest** | [GetWaterQualityRequest](GetWaterQualityRequest.md) |  | |
+
+### Return type
+
+[**WaterQuality**](WaterQuality.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful response |  -  |
+| **401** | Authentication required or invalid API key |  -  |
+| **403** | Tier restriction - upgrade required |  -  |
+| **429** | Rate limit exceeded |  * X-RateLimit-Limit -  <br>  * X-RateLimit-Remaining -  <br>  * X-RateLimit-Reset -  <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@soilsidekick/sdk",
+  "version": "1.1.0",
+  "description": "OpenAPI client for @soilsidekick/sdk",
+  "author": "OpenAPI-Generator",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^4.0 || ^5.0"
+  }
+}

package/package.json.save

@@ -0,0 +1,8 @@
+{
+  "name": "@soilsidekick/sdk",
+  "version": "1.1.0",
+  "publishConfig": {
+    "access": "public"
+  }
+}
+

package/src/apis/AIServicesApi.ts

@@ -0,0 +1,247 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  AIAnalysis,
+  GenerateSmartReportSummaryRequest,
+  GetAgriculturalIntelligenceRequest,
+  GetSeasonalPlanningAssistantRequest,
+  SeasonalPlanningResponse,
+  SmartReportSummary,
+  VisualCropAnalysis,
+  VisualCropAnalysisRequest,
+} from '../models/index';
+import {
+    AIAnalysisFromJSON,
+    AIAnalysisToJSON,
+    GenerateSmartReportSummaryRequestFromJSON,
+    GenerateSmartReportSummaryRequestToJSON,
+    GetAgriculturalIntelligenceRequestFromJSON,
+    GetAgriculturalIntelligenceRequestToJSON,
+    GetSeasonalPlanningAssistantRequestFromJSON,
+    GetSeasonalPlanningAssistantRequestToJSON,
+    SeasonalPlanningResponseFromJSON,
+    SeasonalPlanningResponseToJSON,
+    SmartReportSummaryFromJSON,
+    SmartReportSummaryToJSON,
+    VisualCropAnalysisFromJSON,
+    VisualCropAnalysisToJSON,
+    VisualCropAnalysisRequestFromJSON,
+    VisualCropAnalysisRequestToJSON,
+} from '../models/index';
+
+export interface GenerateSmartReportSummaryOperationRequest {
+    generateSmartReportSummaryRequest: GenerateSmartReportSummaryRequest;
+}
+
+export interface GetAgriculturalIntelligenceOperationRequest {
+    getAgriculturalIntelligenceRequest: GetAgriculturalIntelligenceRequest;
+}
+
+export interface GetSeasonalPlanningAssistantOperationRequest {
+    getSeasonalPlanningAssistantRequest: GetSeasonalPlanningAssistantRequest;
+}
+
+export interface VisualCropAnalysisOperationRequest {
+    visualCropAnalysisRequest: VisualCropAnalysisRequest;
+}
+
+/**
+ * 
+ */
+export class AIServicesApi extends runtime.BaseAPI {
+
+    /**
+     * Generate AI-powered summaries for soil or water quality reports
+     * Generate AI report summary
+     */
+    async generateSmartReportSummaryRaw(requestParameters: GenerateSmartReportSummaryOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SmartReportSummary>> {
+        if (requestParameters['generateSmartReportSummaryRequest'] == null) {
+            throw new runtime.RequiredError(
+                'generateSmartReportSummaryRequest',
+                'Required parameter "generateSmartReportSummaryRequest" was null or undefined when calling generateSmartReportSummary().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/smart-report-summary`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: GenerateSmartReportSummaryRequestToJSON(requestParameters['generateSmartReportSummaryRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SmartReportSummaryFromJSON(jsonValue));
+    }
+
+    /**
+     * Generate AI-powered summaries for soil or water quality reports
+     * Generate AI report summary
+     */
+    async generateSmartReportSummary(requestParameters: GenerateSmartReportSummaryOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SmartReportSummary> {
+        const response = await this.generateSmartReportSummaryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Agricultural intelligence with AI recommendations
+     * Get AI-powered agricultural insights
+     */
+    async getAgriculturalIntelligenceRaw(requestParameters: GetAgriculturalIntelligenceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AIAnalysis>> {
+        if (requestParameters['getAgriculturalIntelligenceRequest'] == null) {
+            throw new runtime.RequiredError(
+                'getAgriculturalIntelligenceRequest',
+                'Required parameter "getAgriculturalIntelligenceRequest" was null or undefined when calling getAgriculturalIntelligence().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/agricultural-intelligence`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: GetAgriculturalIntelligenceRequestToJSON(requestParameters['getAgriculturalIntelligenceRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AIAnalysisFromJSON(jsonValue));
+    }
+
+    /**
+     * Agricultural intelligence with AI recommendations
+     * Get AI-powered agricultural insights
+     */
+    async getAgriculturalIntelligence(requestParameters: GetAgriculturalIntelligenceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AIAnalysis> {
+        const response = await this.getAgriculturalIntelligenceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * AI-powered seasonal planning with weather integration
+     * Get seasonal planning recommendations
+     */
+    async getSeasonalPlanningAssistantRaw(requestParameters: GetSeasonalPlanningAssistantOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SeasonalPlanningResponse>> {
+        if (requestParameters['getSeasonalPlanningAssistantRequest'] == null) {
+            throw new runtime.RequiredError(
+                'getSeasonalPlanningAssistantRequest',
+                'Required parameter "getSeasonalPlanningAssistantRequest" was null or undefined when calling getSeasonalPlanningAssistant().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/seasonal-planning-assistant`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: GetSeasonalPlanningAssistantRequestToJSON(requestParameters['getSeasonalPlanningAssistantRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SeasonalPlanningResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * AI-powered seasonal planning with weather integration
+     * Get seasonal planning recommendations
+     */
+    async getSeasonalPlanningAssistant(requestParameters: GetSeasonalPlanningAssistantOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SeasonalPlanningResponse> {
+        const response = await this.getSeasonalPlanningAssistantRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * AI-powered visual crop analysis for pest detection, health assessment, and disease screening
+     * Analyze crop images
+     */
+    async visualCropAnalysisRaw(requestParameters: VisualCropAnalysisOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VisualCropAnalysis>> {
+        if (requestParameters['visualCropAnalysisRequest'] == null) {
+            throw new runtime.RequiredError(
+                'visualCropAnalysisRequest',
+                'Required parameter "visualCropAnalysisRequest" was null or undefined when calling visualCropAnalysis().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/visual-crop-analysis`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: VisualCropAnalysisRequestToJSON(requestParameters['visualCropAnalysisRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => VisualCropAnalysisFromJSON(jsonValue));
+    }
+
+    /**
+     * AI-powered visual crop analysis for pest detection, health assessment, and disease screening
+     * Analyze crop images
+     */
+    async visualCropAnalysis(requestParameters: VisualCropAnalysisOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VisualCropAnalysis> {
+        const response = await this.visualCropAnalysisRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/CarbonApi.ts

@@ -0,0 +1,82 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  CalculateCarbonCreditsRequest,
+  CarbonCreditCalculation,
+} from '../models/index';
+import {
+    CalculateCarbonCreditsRequestFromJSON,
+    CalculateCarbonCreditsRequestToJSON,
+    CarbonCreditCalculationFromJSON,
+    CarbonCreditCalculationToJSON,
+} from '../models/index';
+
+export interface CalculateCarbonCreditsOperationRequest {
+    calculateCarbonCreditsRequest: CalculateCarbonCreditsRequest;
+}
+
+/**
+ * 
+ */
+export class CarbonApi extends runtime.BaseAPI {
+
+    /**
+     * Calculate carbon credits based on field data and soil organic matter
+     * Calculate carbon credits
+     */
+    async calculateCarbonCreditsRaw(requestParameters: CalculateCarbonCreditsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CarbonCreditCalculation>> {
+        if (requestParameters['calculateCarbonCreditsRequest'] == null) {
+            throw new runtime.RequiredError(
+                'calculateCarbonCreditsRequest',
+                'Required parameter "calculateCarbonCreditsRequest" was null or undefined when calling calculateCarbonCredits().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/carbon-credit-calculator`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CalculateCarbonCreditsRequestToJSON(requestParameters['calculateCarbonCreditsRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CarbonCreditCalculationFromJSON(jsonValue));
+    }
+
+    /**
+     * Calculate carbon credits based on field data and soil organic matter
+     * Calculate carbon credits
+     */
+    async calculateCarbonCredits(requestParameters: CalculateCarbonCreditsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CarbonCreditCalculation> {
+        const response = await this.calculateCarbonCreditsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}