@soilsidekick/sdk 1.1.0

package/docs/AIServicesApi.md

@@ -0,0 +1,308 @@
+# AIServicesApi
+
+All URIs are relative to *https://wzgnxkoeqzvueypwzvyn.supabase.co/functions/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**generateSmartReportSummary**](AIServicesApi.md#generatesmartreportsummaryoperation) | **POST** /smart-report-summary | Generate AI report summary |
+| [**getAgriculturalIntelligence**](AIServicesApi.md#getagriculturalintelligenceoperation) | **POST** /agricultural-intelligence | Get AI-powered agricultural insights |
+| [**getSeasonalPlanningAssistant**](AIServicesApi.md#getseasonalplanningassistantoperation) | **POST** /seasonal-planning-assistant | Get seasonal planning recommendations |
+| [**visualCropAnalysis**](AIServicesApi.md#visualcropanalysisoperation) | **POST** /visual-crop-analysis | Analyze crop images |
+
+
+
+## generateSmartReportSummary
+
+> SmartReportSummary generateSmartReportSummary(generateSmartReportSummaryRequest)
+
+Generate AI report summary
+
+Generate AI-powered summaries for soil or water quality reports
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AIServicesApi,
+} from '@soilsidekick/sdk';
+import type { GenerateSmartReportSummaryOperationRequest } 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 AIServicesApi(config);
+
+  const body = {
+    // GenerateSmartReportSummaryRequest
+    generateSmartReportSummaryRequest: ...,
+  } satisfies GenerateSmartReportSummaryOperationRequest;
+
+  try {
+    const data = await api.generateSmartReportSummary(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **generateSmartReportSummaryRequest** | [GenerateSmartReportSummaryRequest](GenerateSmartReportSummaryRequest.md) |  | |
+
+### Return type
+
+[**SmartReportSummary**](SmartReportSummary.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)
+
+
+## getAgriculturalIntelligence
+
+> AIAnalysis getAgriculturalIntelligence(getAgriculturalIntelligenceRequest)
+
+Get AI-powered agricultural insights
+
+Agricultural intelligence with AI recommendations
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AIServicesApi,
+} from '@soilsidekick/sdk';
+import type { GetAgriculturalIntelligenceOperationRequest } 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 AIServicesApi(config);
+
+  const body = {
+    // GetAgriculturalIntelligenceRequest
+    getAgriculturalIntelligenceRequest: ...,
+  } satisfies GetAgriculturalIntelligenceOperationRequest;
+
+  try {
+    const data = await api.getAgriculturalIntelligence(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getAgriculturalIntelligenceRequest** | [GetAgriculturalIntelligenceRequest](GetAgriculturalIntelligenceRequest.md) |  | |
+
+### Return type
+
+[**AIAnalysis**](AIAnalysis.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)
+
+
+## getSeasonalPlanningAssistant
+
+> SeasonalPlanningResponse getSeasonalPlanningAssistant(getSeasonalPlanningAssistantRequest)
+
+Get seasonal planning recommendations
+
+AI-powered seasonal planning with weather integration
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AIServicesApi,
+} from '@soilsidekick/sdk';
+import type { GetSeasonalPlanningAssistantOperationRequest } 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 AIServicesApi(config);
+
+  const body = {
+    // GetSeasonalPlanningAssistantRequest
+    getSeasonalPlanningAssistantRequest: ...,
+  } satisfies GetSeasonalPlanningAssistantOperationRequest;
+
+  try {
+    const data = await api.getSeasonalPlanningAssistant(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getSeasonalPlanningAssistantRequest** | [GetSeasonalPlanningAssistantRequest](GetSeasonalPlanningAssistantRequest.md) |  | |
+
+### Return type
+
+[**SeasonalPlanningResponse**](SeasonalPlanningResponse.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)
+
+
+## visualCropAnalysis
+
+> VisualCropAnalysis visualCropAnalysis(visualCropAnalysisRequest)
+
+Analyze crop images
+
+AI-powered visual crop analysis for pest detection, health assessment, and disease screening
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AIServicesApi,
+} from '@soilsidekick/sdk';
+import type { VisualCropAnalysisOperationRequest } 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 AIServicesApi(config);
+
+  const body = {
+    // VisualCropAnalysisRequest
+    visualCropAnalysisRequest: ...,
+  } satisfies VisualCropAnalysisOperationRequest;
+
+  try {
+    const data = await api.visualCropAnalysis(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **visualCropAnalysisRequest** | [VisualCropAnalysisRequest](VisualCropAnalysisRequest.md) |  | |
+
+### Return type
+
+[**VisualCropAnalysis**](VisualCropAnalysis.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/CalculateCarbonCreditsRequest.md

@@ -0,0 +1,42 @@
+
+# CalculateCarbonCreditsRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fieldName` | string
+`fieldSizeAcres` | number
+`soilOrganicMatter` | number
+`soilAnalysisId` | string
+`verificationType` | string
+
+## Example
+
+```typescript
+import type { CalculateCarbonCreditsRequest } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fieldName": null,
+  "fieldSizeAcres": null,
+  "soilOrganicMatter": null,
+  "soilAnalysisId": null,
+  "verificationType": null,
+} satisfies CalculateCarbonCreditsRequest
+
+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 CalculateCarbonCreditsRequest
+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/CalculateEnvironmentalImpactRequest.md

@@ -0,0 +1,42 @@
+
+# CalculateEnvironmentalImpactRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`analysisId` | string
+`countyFips` | string
+`soilData` | [CalculateEnvironmentalImpactRequestSoilData](CalculateEnvironmentalImpactRequestSoilData.md)
+`proposedTreatments` | [Array<CalculateEnvironmentalImpactRequestProposedTreatmentsInner>](CalculateEnvironmentalImpactRequestProposedTreatmentsInner.md)
+`waterBodyData` | [CalculateEnvironmentalImpactRequestWaterBodyData](CalculateEnvironmentalImpactRequestWaterBodyData.md)
+
+## Example
+
+```typescript
+import type { CalculateEnvironmentalImpactRequest } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "analysisId": null,
+  "countyFips": null,
+  "soilData": null,
+  "proposedTreatments": null,
+  "waterBodyData": null,
+} satisfies CalculateEnvironmentalImpactRequest
+
+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 CalculateEnvironmentalImpactRequest
+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/CalculateEnvironmentalImpactRequestProposedTreatmentsInner.md

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

@@ -0,0 +1,44 @@
+
+# CalculateEnvironmentalImpactRequestSoilData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`phLevel` | number
+`organicMatter` | number
+`slope` | string
+`drainage` | string
+`nitrogenLevel` | string
+`phosphorusLevel` | string
+
+## Example
+
+```typescript
+import type { CalculateEnvironmentalImpactRequestSoilData } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "phLevel": null,
+  "organicMatter": null,
+  "slope": null,
+  "drainage": null,
+  "nitrogenLevel": null,
+  "phosphorusLevel": null,
+} satisfies CalculateEnvironmentalImpactRequestSoilData
+
+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 CalculateEnvironmentalImpactRequestSoilData
+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/CalculateEnvironmentalImpactRequestWaterBodyData.md

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

@@ -0,0 +1,83 @@
+# CarbonApi
+
+All URIs are relative to *https://wzgnxkoeqzvueypwzvyn.supabase.co/functions/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**calculateCarbonCredits**](CarbonApi.md#calculatecarboncreditsoperation) | **POST** /carbon-credit-calculator | Calculate carbon credits |
+
+
+
+## calculateCarbonCredits
+
+> CarbonCreditCalculation calculateCarbonCredits(calculateCarbonCreditsRequest)
+
+Calculate carbon credits
+
+Calculate carbon credits based on field data and soil organic matter
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CarbonApi,
+} from '@soilsidekick/sdk';
+import type { CalculateCarbonCreditsOperationRequest } 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 CarbonApi(config);
+
+  const body = {
+    // CalculateCarbonCreditsRequest
+    calculateCarbonCreditsRequest: ...,
+  } satisfies CalculateCarbonCreditsOperationRequest;
+
+  try {
+    const data = await api.calculateCarbonCredits(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **calculateCarbonCreditsRequest** | [CalculateCarbonCreditsRequest](CalculateCarbonCreditsRequest.md) |  | |
+
+### Return type
+
+[**CarbonCreditCalculation**](CarbonCreditCalculation.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/CarbonCreditCalculation.md

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

@@ -0,0 +1,44 @@
+
+# CarbonCreditCalculationCalculationDetails
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`creditsEarned` | number
+`calculationMethod` | string
+`baselineCarbon` | number
+`enhancedCarbon` | number
+`verificationConfidence` | number
+`metadata` | [CarbonCreditCalculationCalculationDetailsMetadata](CarbonCreditCalculationCalculationDetailsMetadata.md)
+
+## Example
+
+```typescript
+import type { CarbonCreditCalculationCalculationDetails } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "creditsEarned": null,
+  "calculationMethod": null,
+  "baselineCarbon": null,
+  "enhancedCarbon": null,
+  "verificationConfidence": null,
+  "metadata": null,
+} satisfies CarbonCreditCalculationCalculationDetails
+
+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 CarbonCreditCalculationCalculationDetails
+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)
+
+