@soilsidekick/sdk 1.1.0

package/docs/SmartReportSummary.md

@@ -0,0 +1,38 @@
+
+# SmartReportSummary
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`summary` | [SmartReportSummarySummary](SmartReportSummarySummary.md)
+`modelUsed` | string
+
+## Example
+
+```typescript
+import type { SmartReportSummary } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "summary": null,
+  "modelUsed": null,
+} satisfies SmartReportSummary
+
+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 SmartReportSummary
+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/SmartReportSummarySummary.md

@@ -0,0 +1,40 @@
+
+# SmartReportSummarySummary
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`executiveSummary` | string
+`keyFindings` | Array<string>
+`recommendations` | Array<string>
+`riskAssessment` | string
+
+## Example
+
+```typescript
+import type { SmartReportSummarySummary } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "executiveSummary": null,
+  "keyFindings": null,
+  "recommendations": null,
+  "riskAssessment": null,
+} satisfies SmartReportSummarySummary
+
+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 SmartReportSummarySummary
+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/SoilAnalysisApi.md

@@ -0,0 +1,234 @@
+# SoilAnalysisApi
+
+All URIs are relative to *https://wzgnxkoeqzvueypwzvyn.supabase.co/functions/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getLiveAgriculturalData**](SoilAnalysisApi.md#getliveagriculturaldataoperation) | **POST** /live-agricultural-data | Get live agricultural data |
+| [**getPlantingCalendar**](SoilAnalysisApi.md#getplantingcalendaroperation) | **POST** /multi-parameter-planting-calendar | Get planting calendar recommendations |
+| [**getSoilData**](SoilAnalysisApi.md#getsoildataoperation) | **POST** /get-soil-data | Get soil analysis data |
+
+
+
+## getLiveAgriculturalData
+
+> LiveAgriculturalData getLiveAgriculturalData(getLiveAgriculturalDataRequest)
+
+Get live agricultural data
+
+Fetch real-time agricultural data from multiple federal sources (NOAA, USDA, EPA)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SoilAnalysisApi,
+} from '@soilsidekick/sdk';
+import type { GetLiveAgriculturalDataOperationRequest } 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 SoilAnalysisApi(config);
+
+  const body = {
+    // GetLiveAgriculturalDataRequest
+    getLiveAgriculturalDataRequest: ...,
+  } satisfies GetLiveAgriculturalDataOperationRequest;
+
+  try {
+    const data = await api.getLiveAgriculturalData(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getLiveAgriculturalDataRequest** | [GetLiveAgriculturalDataRequest](GetLiveAgriculturalDataRequest.md) |  | |
+
+### Return type
+
+[**LiveAgriculturalData**](LiveAgriculturalData.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)
+
+
+## getPlantingCalendar
+
+> PlantingCalendar getPlantingCalendar(getPlantingCalendarRequest)
+
+Get planting calendar recommendations
+
+Multi-parameter planting calendar with climate and soil factors
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SoilAnalysisApi,
+} from '@soilsidekick/sdk';
+import type { GetPlantingCalendarOperationRequest } 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 SoilAnalysisApi(config);
+
+  const body = {
+    // GetPlantingCalendarRequest
+    getPlantingCalendarRequest: ...,
+  } satisfies GetPlantingCalendarOperationRequest;
+
+  try {
+    const data = await api.getPlantingCalendar(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getPlantingCalendarRequest** | [GetPlantingCalendarRequest](GetPlantingCalendarRequest.md) |  | |
+
+### Return type
+
+[**PlantingCalendar**](PlantingCalendar.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)
+
+
+## getSoilData
+
+> SoilData getSoilData(getSoilDataRequest)
+
+Get soil analysis data
+
+Retrieve comprehensive soil analysis for a specific county
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SoilAnalysisApi,
+} from '@soilsidekick/sdk';
+import type { GetSoilDataOperationRequest } 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 SoilAnalysisApi(config);
+
+  const body = {
+    // GetSoilDataRequest
+    getSoilDataRequest: ...,
+  } satisfies GetSoilDataOperationRequest;
+
+  try {
+    const data = await api.getSoilData(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getSoilDataRequest** | [GetSoilDataRequest](GetSoilDataRequest.md) |  | |
+
+### Return type
+
+[**SoilData**](SoilData.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 |  * X-RateLimit-Limit - Maximum requests per window <br>  * X-RateLimit-Remaining - Remaining requests in window <br>  * X-RateLimit-Reset - Unix timestamp when limit resets <br>  |
+| **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>  |
+| **500** | Internal server error |  -  |
+
+[[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/SoilData.md

@@ -0,0 +1,54 @@
+
+# SoilData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`countyFips` | string
+`countyName` | string
+`stateCode` | string
+`phLevel` | number
+`organicMatter` | number
+`nitrogenLevel` | string
+`phosphorusLevel` | string
+`potassiumLevel` | string
+`recommendations` | string
+`analysisData` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { SoilData } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "countyFips": null,
+  "countyName": null,
+  "stateCode": null,
+  "phLevel": null,
+  "organicMatter": null,
+  "nitrogenLevel": null,
+  "phosphorusLevel": null,
+  "potassiumLevel": null,
+  "recommendations": null,
+  "analysisData": null,
+} satisfies SoilData
+
+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 SoilData
+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/TerritorialWaterAnalytics.md

@@ -0,0 +1,38 @@
+
+# TerritorialWaterAnalytics
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`analytics` | [TerritorialWaterAnalyticsAnalytics](TerritorialWaterAnalyticsAnalytics.md)
+`generatedAt` | Date
+
+## Example
+
+```typescript
+import type { TerritorialWaterAnalytics } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "analytics": null,
+  "generatedAt": null,
+} satisfies TerritorialWaterAnalytics
+
+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 TerritorialWaterAnalytics
+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/TerritorialWaterAnalyticsAnalytics.md

@@ -0,0 +1,40 @@
+
+# TerritorialWaterAnalyticsAnalytics
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`territorialCoverage` | object
+`waterQualityMetrics` | object
+`regionalInsights` | object
+`complianceStatus` | object
+
+## Example
+
+```typescript
+import type { TerritorialWaterAnalyticsAnalytics } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "territorialCoverage": null,
+  "waterQualityMetrics": null,
+  "regionalInsights": null,
+  "complianceStatus": null,
+} satisfies TerritorialWaterAnalyticsAnalytics
+
+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 TerritorialWaterAnalyticsAnalytics
+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/VRTApi.md

@@ -0,0 +1,83 @@
+# VRTApi
+
+All URIs are relative to *https://wzgnxkoeqzvueypwzvyn.supabase.co/functions/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**generateVRTPrescription**](VRTApi.md#generatevrtprescriptionoperation) | **POST** /generate-vrt-prescription | Generate VRT prescription map |
+
+
+
+## generateVRTPrescription
+
+> VRTPrescription generateVRTPrescription(generateVRTPrescriptionRequest)
+
+Generate VRT prescription map
+
+Generate variable rate technology prescription maps
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VRTApi,
+} from '@soilsidekick/sdk';
+import type { GenerateVRTPrescriptionOperationRequest } 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 VRTApi(config);
+
+  const body = {
+    // GenerateVRTPrescriptionRequest
+    generateVRTPrescriptionRequest: ...,
+  } satisfies GenerateVRTPrescriptionOperationRequest;
+
+  try {
+    const data = await api.generateVRTPrescription(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **generateVRTPrescriptionRequest** | [GenerateVRTPrescriptionRequest](GenerateVRTPrescriptionRequest.md) |  | |
+
+### Return type
+
+[**VRTPrescription**](VRTPrescription.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/docs/VRTPrescription.md

@@ -0,0 +1,40 @@
+
+# VRTPrescription
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`fieldId` | string
+`applicationType` | string
+`zones` | [Array<VRTPrescriptionZonesInner>](VRTPrescriptionZonesInner.md)
+
+## Example
+
+```typescript
+import type { VRTPrescription } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "fieldId": null,
+  "applicationType": null,
+  "zones": null,
+} satisfies VRTPrescription
+
+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 VRTPrescription
+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/VRTPrescriptionZonesInner.md

@@ -0,0 +1,38 @@
+
+# VRTPrescriptionZonesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`zoneId` | number
+`applicationRate` | number
+`geometry` | object
+
+## Example
+
+```typescript
+import type { VRTPrescriptionZonesInner } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "zoneId": null,
+  "applicationRate": null,
+  "geometry": null,
+} satisfies VRTPrescriptionZonesInner
+
+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 VRTPrescriptionZonesInner
+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/VisualCropAnalysis.md

@@ -0,0 +1,40 @@
+
+# VisualCropAnalysis
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`analysis` | [VisualCropAnalysisAnalysis](VisualCropAnalysisAnalysis.md)
+`analysisId` | string
+`timestamp` | Date
+
+## Example
+
+```typescript
+import type { VisualCropAnalysis } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "analysis": null,
+  "analysisId": null,
+  "timestamp": null,
+} satisfies VisualCropAnalysis
+
+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 VisualCropAnalysis
+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/VisualCropAnalysisAnalysis.md

@@ -0,0 +1,42 @@
+
+# VisualCropAnalysisAnalysis
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`analysisType` | string
+`confidence` | number
+`findings` | object
+`recommendations` | Array<string>
+`severity` | string
+
+## Example
+
+```typescript
+import type { VisualCropAnalysisAnalysis } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "analysisType": null,
+  "confidence": null,
+  "findings": null,
+  "recommendations": null,
+  "severity": null,
+} satisfies VisualCropAnalysisAnalysis
+
+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 VisualCropAnalysisAnalysis
+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)
+
+