@soilsidekick/sdk 1.1.0

package/docs/CarbonCreditCalculationCalculationDetailsMetadata.md

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

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

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

@@ -0,0 +1,34 @@
+
+# CountyLookup200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`counties` | [Array<County>](County.md)
+
+## Example
+
+```typescript
+import type { CountyLookup200Response } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "counties": null,
+} satisfies CountyLookup200Response
+
+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 CountyLookup200Response
+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/CountyLookupRequest.md

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

@@ -0,0 +1,83 @@
+# EnvironmentalApi
+
+All URIs are relative to *https://wzgnxkoeqzvueypwzvyn.supabase.co/functions/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**calculateEnvironmentalImpact**](EnvironmentalApi.md#calculateenvironmentalimpactoperation) | **POST** /environmental-impact-engine | Calculate environmental impact |
+
+
+
+## calculateEnvironmentalImpact
+
+> EnvironmentalImpact calculateEnvironmentalImpact(calculateEnvironmentalImpactRequest)
+
+Calculate environmental impact
+
+Assess environmental impact including runoff risk, contamination, and eco-friendly alternatives
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EnvironmentalApi,
+} from '@soilsidekick/sdk';
+import type { CalculateEnvironmentalImpactOperationRequest } 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 EnvironmentalApi(config);
+
+  const body = {
+    // CalculateEnvironmentalImpactRequest
+    calculateEnvironmentalImpactRequest: ...,
+  } satisfies CalculateEnvironmentalImpactOperationRequest;
+
+  try {
+    const data = await api.calculateEnvironmentalImpact(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **calculateEnvironmentalImpactRequest** | [CalculateEnvironmentalImpactRequest](CalculateEnvironmentalImpactRequest.md) |  | |
+
+### Return type
+
+[**EnvironmentalImpact**](EnvironmentalImpact.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/EnvironmentalImpact.md

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

@@ -0,0 +1,42 @@
+
+# EnvironmentalImpactDetailedAnalysis
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`runoffRisk` | [EnvironmentalImpactDetailedAnalysisRunoffRisk](EnvironmentalImpactDetailedAnalysisRunoffRisk.md)
+`contaminationAssessment` | object
+`ecoAlternatives` | [EnvironmentalImpactDetailedAnalysisEcoAlternatives](EnvironmentalImpactDetailedAnalysisEcoAlternatives.md)
+`carbonAnalysis` | object
+`biodiversityAssessment` | object
+
+## Example
+
+```typescript
+import type { EnvironmentalImpactDetailedAnalysis } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "runoffRisk": null,
+  "contaminationAssessment": null,
+  "ecoAlternatives": null,
+  "carbonAnalysis": null,
+  "biodiversityAssessment": null,
+} satisfies EnvironmentalImpactDetailedAnalysis
+
+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 EnvironmentalImpactDetailedAnalysis
+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/EnvironmentalImpactDetailedAnalysisEcoAlternatives.md

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

@@ -0,0 +1,42 @@
+
+# EnvironmentalImpactDetailedAnalysisEcoAlternativesAlternativesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`category` | string
+`alternative` | string
+`description` | string
+`environmentalBenefit` | string
+`effectivenessScore` | number
+
+## Example
+
+```typescript
+import type { EnvironmentalImpactDetailedAnalysisEcoAlternativesAlternativesInner } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "category": null,
+  "alternative": null,
+  "description": null,
+  "environmentalBenefit": null,
+  "effectivenessScore": null,
+} satisfies EnvironmentalImpactDetailedAnalysisEcoAlternativesAlternativesInner
+
+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 EnvironmentalImpactDetailedAnalysisEcoAlternativesAlternativesInner
+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/EnvironmentalImpactDetailedAnalysisRunoffRisk.md

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

@@ -0,0 +1,42 @@
+
+# EnvironmentalImpactImpactAssessment
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`runoffRiskScore` | number
+`waterBodyProximity` | number
+`contaminationRisk` | string
+`carbonFootprintScore` | number
+`biodiversityImpact` | string
+
+## Example
+
+```typescript
+import type { EnvironmentalImpactImpactAssessment } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "runoffRiskScore": null,
+  "waterBodyProximity": null,
+  "contaminationRisk": null,
+  "carbonFootprintScore": null,
+  "biodiversityImpact": null,
+} satisfies EnvironmentalImpactImpactAssessment
+
+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 EnvironmentalImpactImpactAssessment
+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/GenerateSmartReportSummaryRequest.md

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

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

@@ -0,0 +1,82 @@
+# GeographicApi
+
+All URIs are relative to *https://wzgnxkoeqzvueypwzvyn.supabase.co/functions/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**countyLookup**](GeographicApi.md#countylookupoperation) | **POST** /county-lookup | Search for counties |
+
+
+
+## countyLookup
+
+> CountyLookup200Response countyLookup(countyLookupRequest)
+
+Search for counties
+
+Search counties by name, state, or FIPS code
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GeographicApi,
+} from '@soilsidekick/sdk';
+import type { CountyLookupOperationRequest } 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 GeographicApi(config);
+
+  const body = {
+    // CountyLookupRequest
+    countyLookupRequest: ...,
+  } satisfies CountyLookupOperationRequest;
+
+  try {
+    const data = await api.countyLookup(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **countyLookupRequest** | [CountyLookupRequest](CountyLookupRequest.md) |  | |
+
+### Return type
+
+[**CountyLookup200Response**](CountyLookup200Response.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 |  -  |
+| **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)
+