@soilsidekick/sdk 1.1.0

package/docs/GetAgriculturalIntelligenceRequest.md

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

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

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

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

@@ -0,0 +1,42 @@
+
+# GetSeasonalPlanningAssistantRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`location` | [GetSeasonalPlanningAssistantRequestLocation](GetSeasonalPlanningAssistantRequestLocation.md)
+`soilData` | object
+`planningType` | string
+`cropPreferences` | Array<string>
+`timeframe` | string
+
+## Example
+
+```typescript
+import type { GetSeasonalPlanningAssistantRequest } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "location": null,
+  "soilData": null,
+  "planningType": null,
+  "cropPreferences": null,
+  "timeframe": null,
+} satisfies GetSeasonalPlanningAssistantRequest
+
+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 GetSeasonalPlanningAssistantRequest
+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/GetSeasonalPlanningAssistantRequestLocation.md

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

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

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

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

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

@@ -0,0 +1,83 @@
+# LeafEnginesApi
+
+All URIs are relative to *https://wzgnxkoeqzvueypwzvyn.supabase.co/functions/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**leafenginesQuery**](LeafEnginesApi.md#leafenginesqueryoperation) | **POST** /leafengines-query | Query plant-environment compatibility |
+
+
+
+## leafenginesQuery
+
+> LeafEnginesCompatibility leafenginesQuery(leafenginesQueryRequest)
+
+Query plant-environment compatibility
+
+LeafEngines API for plant compatibility scoring with environmental factors
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LeafEnginesApi,
+} from '@soilsidekick/sdk';
+import type { LeafenginesQueryOperationRequest } 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 LeafEnginesApi(config);
+
+  const body = {
+    // LeafenginesQueryRequest
+    leafenginesQueryRequest: ...,
+  } satisfies LeafenginesQueryOperationRequest;
+
+  try {
+    const data = await api.leafenginesQuery(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **leafenginesQueryRequest** | [LeafenginesQueryRequest](LeafenginesQueryRequest.md) |  | |
+
+### Return type
+
+[**LeafEnginesCompatibility**](LeafEnginesCompatibility.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/LeafEnginesCompatibility.md

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

@@ -0,0 +1,48 @@
+
+# LeafEnginesCompatibilityData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`overallScore` | number
+`soilCompatibility` | number
+`waterCompatibility` | number
+`climateCompatibility` | number
+`breakdown` | [LeafEnginesCompatibilityDataBreakdown](LeafEnginesCompatibilityDataBreakdown.md)
+`recommendations` | Array<string>
+`riskLevel` | string
+`metadata` | [LeafEnginesCompatibilityDataMetadata](LeafEnginesCompatibilityDataMetadata.md)
+
+## Example
+
+```typescript
+import type { LeafEnginesCompatibilityData } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "overallScore": null,
+  "soilCompatibility": null,
+  "waterCompatibility": null,
+  "climateCompatibility": null,
+  "breakdown": null,
+  "recommendations": null,
+  "riskLevel": null,
+  "metadata": null,
+} satisfies LeafEnginesCompatibilityData
+
+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 LeafEnginesCompatibilityData
+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/LeafEnginesCompatibilityDataBreakdown.md

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

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

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