@soilsidekick/sdk 1.1.0

package/docs/LeafEnginesCompatibilityUsage.md

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

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

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

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

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

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

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

@@ -0,0 +1,46 @@
+
+# LiveAgriculturalData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`countyFips` | string
+`countyName` | string
+`stateCode` | string
+`data` | [LiveAgriculturalDataData](LiveAgriculturalDataData.md)
+`sources` | Array<string>
+`timestamp` | Date
+`cacheStatus` | string
+
+## Example
+
+```typescript
+import type { LiveAgriculturalData } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "countyFips": null,
+  "countyName": null,
+  "stateCode": null,
+  "data": null,
+  "sources": null,
+  "timestamp": null,
+  "cacheStatus": null,
+} satisfies LiveAgriculturalData
+
+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 LiveAgriculturalData
+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/LiveAgriculturalDataData.md

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

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

@@ -0,0 +1,42 @@
+
+# PlantingCalendar
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cropType` | string
+`optimalPlantingWindow` | [GetTerritorialWaterAnalyticsRequestDateRange](GetTerritorialWaterAnalyticsRequestDateRange.md)
+`climateFactors` | object
+`soilFactors` | object
+`recommendations` | Array<string>
+
+## Example
+
+```typescript
+import type { PlantingCalendar } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "cropType": null,
+  "optimalPlantingWindow": null,
+  "climateFactors": null,
+  "soilFactors": null,
+  "recommendations": null,
+} satisfies PlantingCalendar
+
+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 PlantingCalendar
+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/SatelliteData.md

@@ -0,0 +1,42 @@
+
+# SatelliteData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ndvi` | number
+`evi` | number
+`soilMoisture` | number
+`temperature` | number
+`cloudCover` | number
+
+## Example
+
+```typescript
+import type { SatelliteData } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ndvi": null,
+  "evi": null,
+  "soilMoisture": null,
+  "temperature": null,
+  "cloudCover": null,
+} satisfies SatelliteData
+
+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 SatelliteData
+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/SatelliteDataApi.md

@@ -0,0 +1,83 @@
+# SatelliteDataApi
+
+All URIs are relative to *https://wzgnxkoeqzvueypwzvyn.supabase.co/functions/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getSatelliteData**](SatelliteDataApi.md#getsatellitedataoperation) | **POST** /alpha-earth-environmental-enhancement | Get satellite environmental data |
+
+
+
+## getSatelliteData
+
+> SatelliteData getSatelliteData(getSatelliteDataRequest)
+
+Get satellite environmental data
+
+AlphaEarth satellite intelligence integration
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SatelliteDataApi,
+} from '@soilsidekick/sdk';
+import type { GetSatelliteDataOperationRequest } 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 SatelliteDataApi(config);
+
+  const body = {
+    // GetSatelliteDataRequest
+    getSatelliteDataRequest: ...,
+  } satisfies GetSatelliteDataOperationRequest;
+
+  try {
+    const data = await api.getSatelliteData(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getSatelliteDataRequest** | [GetSatelliteDataRequest](GetSatelliteDataRequest.md) |  | |
+
+### Return type
+
+[**SatelliteData**](SatelliteData.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/SeasonalPlanningResponse.md

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

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

@@ -0,0 +1,44 @@
+
+# SeasonalPlanningResponseWeatherData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`currentSeason` | string
+`temperature` | string
+`rainfall` | string
+`frostDates` | object
+`growingSeason` | string
+`zone` | string
+
+## Example
+
+```typescript
+import type { SeasonalPlanningResponseWeatherData } from '@soilsidekick/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "currentSeason": null,
+  "temperature": null,
+  "rainfall": null,
+  "frostDates": null,
+  "growingSeason": null,
+  "zone": null,
+} satisfies SeasonalPlanningResponseWeatherData
+
+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 SeasonalPlanningResponseWeatherData
+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)
+
+