@soilsidekick/sdk 1.1.0

package/dist/esm/models/WaterQuality.d.ts

@@ -0,0 +1,77 @@
+/**
+ * SoilSidekick Pro API
+ * Agricultural intelligence and soil analysis API with tier-based access control.  ## Authentication All endpoints require an API key passed via the `Authorization` header: ``` Authorization: Bearer ss_prod_your_api_key_here ```  ## Rate Limiting Rate limits are enforced based on your subscription tier: - **Free**: 10 req/min, 100 req/hour, 1,000 req/day - **Starter**: 30 req/min, 500 req/hour, 5,000 req/day - **Pro**: 100 req/min, 2,000 req/hour, 25,000 req/day - **Enterprise**: 500 req/min, 10,000 req/hour, 100,000 req/day  Rate limit information is returned in response headers: - `X-RateLimit-Limit`: Maximum requests in window - `X-RateLimit-Remaining`: Remaining requests in window - `X-RateLimit-Reset`: Unix timestamp when limit resets
+ *
+ * The version of the OpenAPI document: 1.1.0
+ * Contact: support@soilsidekick.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface WaterQuality
+ */
+export interface WaterQuality {
+    /**
+     *
+     * @type {string}
+     * @memberof WaterQuality
+     */
+    countyFips?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof WaterQuality
+     */
+    ph?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof WaterQuality
+     */
+    dissolvedOxygen?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof WaterQuality
+     */
+    turbidity?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof WaterQuality
+     */
+    nitrates?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof WaterQuality
+     */
+    phosphates?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof WaterQuality
+     */
+    contaminationRisk?: WaterQualityContaminationRiskEnum;
+}
+/**
+ * @export
+ */
+export declare const WaterQualityContaminationRiskEnum: {
+    readonly Low: "low";
+    readonly Medium: "medium";
+    readonly High: "high";
+};
+export type WaterQualityContaminationRiskEnum = typeof WaterQualityContaminationRiskEnum[keyof typeof WaterQualityContaminationRiskEnum];
+/**
+ * Check if a given object implements the WaterQuality interface.
+ */
+export declare function instanceOfWaterQuality(value: object): value is WaterQuality;
+export declare function WaterQualityFromJSON(json: any): WaterQuality;
+export declare function WaterQualityFromJSONTyped(json: any, ignoreDiscriminator: boolean): WaterQuality;
+export declare function WaterQualityToJSON(json: any): WaterQuality;
+export declare function WaterQualityToJSONTyped(value?: WaterQuality | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WaterQuality.js

@@ -0,0 +1,61 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SoilSidekick Pro API
+ * Agricultural intelligence and soil analysis API with tier-based access control.  ## Authentication All endpoints require an API key passed via the `Authorization` header: ``` Authorization: Bearer ss_prod_your_api_key_here ```  ## Rate Limiting Rate limits are enforced based on your subscription tier: - **Free**: 10 req/min, 100 req/hour, 1,000 req/day - **Starter**: 30 req/min, 500 req/hour, 5,000 req/day - **Pro**: 100 req/min, 2,000 req/hour, 25,000 req/day - **Enterprise**: 500 req/min, 10,000 req/hour, 100,000 req/day  Rate limit information is returned in response headers: - `X-RateLimit-Limit`: Maximum requests in window - `X-RateLimit-Remaining`: Remaining requests in window - `X-RateLimit-Reset`: Unix timestamp when limit resets
+ *
+ * The version of the OpenAPI document: 1.1.0
+ * Contact: support@soilsidekick.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @export
+ */
+export const WaterQualityContaminationRiskEnum = {
+    Low: 'low',
+    Medium: 'medium',
+    High: 'high'
+};
+/**
+ * Check if a given object implements the WaterQuality interface.
+ */
+export function instanceOfWaterQuality(value) {
+    return true;
+}
+export function WaterQualityFromJSON(json) {
+    return WaterQualityFromJSONTyped(json, false);
+}
+export function WaterQualityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'countyFips': json['county_fips'] == null ? undefined : json['county_fips'],
+        'ph': json['ph'] == null ? undefined : json['ph'],
+        'dissolvedOxygen': json['dissolved_oxygen'] == null ? undefined : json['dissolved_oxygen'],
+        'turbidity': json['turbidity'] == null ? undefined : json['turbidity'],
+        'nitrates': json['nitrates'] == null ? undefined : json['nitrates'],
+        'phosphates': json['phosphates'] == null ? undefined : json['phosphates'],
+        'contaminationRisk': json['contamination_risk'] == null ? undefined : json['contamination_risk'],
+    };
+}
+export function WaterQualityToJSON(json) {
+    return WaterQualityToJSONTyped(json, false);
+}
+export function WaterQualityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'county_fips': value['countyFips'],
+        'ph': value['ph'],
+        'dissolved_oxygen': value['dissolvedOxygen'],
+        'turbidity': value['turbidity'],
+        'nitrates': value['nitrates'],
+        'phosphates': value['phosphates'],
+        'contamination_risk': value['contaminationRisk'],
+    };
+}

package/dist/esm/models/index.d.ts

@@ -0,0 +1,64 @@
+export * from './AIAnalysis';
+export * from './AIAnalysisRecommendationsInner';
+export * from './CalculateCarbonCreditsRequest';
+export * from './CalculateEnvironmentalImpactRequest';
+export * from './CalculateEnvironmentalImpactRequestProposedTreatmentsInner';
+export * from './CalculateEnvironmentalImpactRequestSoilData';
+export * from './CalculateEnvironmentalImpactRequestWaterBodyData';
+export * from './CarbonCreditCalculation';
+export * from './CarbonCreditCalculationCalculationDetails';
+export * from './CarbonCreditCalculationCalculationDetailsMetadata';
+export * from './CarbonCreditCalculationCreditRecord';
+export * from './County';
+export * from './CountyLookup200Response';
+export * from './CountyLookupRequest';
+export * from './EnvironmentalImpact';
+export * from './EnvironmentalImpactDetailedAnalysis';
+export * from './EnvironmentalImpactDetailedAnalysisEcoAlternatives';
+export * from './EnvironmentalImpactDetailedAnalysisEcoAlternativesAlternativesInner';
+export * from './EnvironmentalImpactDetailedAnalysisRunoffRisk';
+export * from './EnvironmentalImpactImpactAssessment';
+export * from './GenerateSmartReportSummaryRequest';
+export * from './GenerateVRTPrescriptionRequest';
+export * from './GetAgriculturalIntelligenceRequest';
+export * from './GetLiveAgriculturalDataRequest';
+export * from './GetPlantingCalendarRequest';
+export * from './GetSatelliteDataRequest';
+export * from './GetSeasonalPlanningAssistantRequest';
+export * from './GetSeasonalPlanningAssistantRequestLocation';
+export * from './GetSoilDataRequest';
+export * from './GetTerritorialWaterAnalyticsRequest';
+export * from './GetTerritorialWaterAnalyticsRequestDateRange';
+export * from './GetWaterQualityRequest';
+export * from './LeafEnginesCompatibility';
+export * from './LeafEnginesCompatibilityData';
+export * from './LeafEnginesCompatibilityDataBreakdown';
+export * from './LeafEnginesCompatibilityDataBreakdownSoil';
+export * from './LeafEnginesCompatibilityDataMetadata';
+export * from './LeafEnginesCompatibilityUsage';
+export * from './LeafenginesQueryRequest';
+export * from './LeafenginesQueryRequestLocation';
+export * from './LeafenginesQueryRequestOptions';
+export * from './LeafenginesQueryRequestPlant';
+export * from './LeafenginesQueryRequestPlantCareRequirements';
+export * from './LeafenginesQueryRequestPlantCareRequirementsSoilPhRange';
+export * from './LiveAgriculturalData';
+export * from './LiveAgriculturalDataData';
+export * from './ModelError';
+export * from './PlantingCalendar';
+export * from './SatelliteData';
+export * from './SeasonalPlanningResponse';
+export * from './SeasonalPlanningResponseRecommendations';
+export * from './SeasonalPlanningResponseWeatherData';
+export * from './SmartReportSummary';
+export * from './SmartReportSummarySummary';
+export * from './SoilData';
+export * from './TerritorialWaterAnalytics';
+export * from './TerritorialWaterAnalyticsAnalytics';
+export * from './VRTPrescription';
+export * from './VRTPrescriptionZonesInner';
+export * from './VisualCropAnalysis';
+export * from './VisualCropAnalysisAnalysis';
+export * from './VisualCropAnalysisRequest';
+export * from './VisualCropAnalysisRequestLocation';
+export * from './WaterQuality';

package/dist/esm/models/index.js

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './AIAnalysis';
+export * from './AIAnalysisRecommendationsInner';
+export * from './CalculateCarbonCreditsRequest';
+export * from './CalculateEnvironmentalImpactRequest';
+export * from './CalculateEnvironmentalImpactRequestProposedTreatmentsInner';
+export * from './CalculateEnvironmentalImpactRequestSoilData';
+export * from './CalculateEnvironmentalImpactRequestWaterBodyData';
+export * from './CarbonCreditCalculation';
+export * from './CarbonCreditCalculationCalculationDetails';
+export * from './CarbonCreditCalculationCalculationDetailsMetadata';
+export * from './CarbonCreditCalculationCreditRecord';
+export * from './County';
+export * from './CountyLookup200Response';
+export * from './CountyLookupRequest';
+export * from './EnvironmentalImpact';
+export * from './EnvironmentalImpactDetailedAnalysis';
+export * from './EnvironmentalImpactDetailedAnalysisEcoAlternatives';
+export * from './EnvironmentalImpactDetailedAnalysisEcoAlternativesAlternativesInner';
+export * from './EnvironmentalImpactDetailedAnalysisRunoffRisk';
+export * from './EnvironmentalImpactImpactAssessment';
+export * from './GenerateSmartReportSummaryRequest';
+export * from './GenerateVRTPrescriptionRequest';
+export * from './GetAgriculturalIntelligenceRequest';
+export * from './GetLiveAgriculturalDataRequest';
+export * from './GetPlantingCalendarRequest';
+export * from './GetSatelliteDataRequest';
+export * from './GetSeasonalPlanningAssistantRequest';
+export * from './GetSeasonalPlanningAssistantRequestLocation';
+export * from './GetSoilDataRequest';
+export * from './GetTerritorialWaterAnalyticsRequest';
+export * from './GetTerritorialWaterAnalyticsRequestDateRange';
+export * from './GetWaterQualityRequest';
+export * from './LeafEnginesCompatibility';
+export * from './LeafEnginesCompatibilityData';
+export * from './LeafEnginesCompatibilityDataBreakdown';
+export * from './LeafEnginesCompatibilityDataBreakdownSoil';
+export * from './LeafEnginesCompatibilityDataMetadata';
+export * from './LeafEnginesCompatibilityUsage';
+export * from './LeafenginesQueryRequest';
+export * from './LeafenginesQueryRequestLocation';
+export * from './LeafenginesQueryRequestOptions';
+export * from './LeafenginesQueryRequestPlant';
+export * from './LeafenginesQueryRequestPlantCareRequirements';
+export * from './LeafenginesQueryRequestPlantCareRequirementsSoilPhRange';
+export * from './LiveAgriculturalData';
+export * from './LiveAgriculturalDataData';
+export * from './ModelError';
+export * from './PlantingCalendar';
+export * from './SatelliteData';
+export * from './SeasonalPlanningResponse';
+export * from './SeasonalPlanningResponseRecommendations';
+export * from './SeasonalPlanningResponseWeatherData';
+export * from './SmartReportSummary';
+export * from './SmartReportSummarySummary';
+export * from './SoilData';
+export * from './TerritorialWaterAnalytics';
+export * from './TerritorialWaterAnalyticsAnalytics';
+export * from './VRTPrescription';
+export * from './VRTPrescriptionZonesInner';
+export * from './VisualCropAnalysis';
+export * from './VisualCropAnalysisAnalysis';
+export * from './VisualCropAnalysisRequest';
+export * from './VisualCropAnalysisRequestLocation';
+export * from './WaterQuality';

package/dist/esm/runtime.d.ts

@@ -0,0 +1,184 @@
+/**
+ * SoilSidekick Pro API
+ * Agricultural intelligence and soil analysis API with tier-based access control.  ## Authentication All endpoints require an API key passed via the `Authorization` header: ``` Authorization: Bearer ss_prod_your_api_key_here ```  ## Rate Limiting Rate limits are enforced based on your subscription tier: - **Free**: 10 req/min, 100 req/hour, 1,000 req/day - **Starter**: 30 req/min, 500 req/hour, 5,000 req/day - **Pro**: 100 req/min, 2,000 req/hour, 25,000 req/day - **Enterprise**: 500 req/min, 10,000 req/hour, 100,000 req/day  Rate limit information is returned in response headers: - `X-RateLimit-Limit`: Maximum requests in window - `X-RateLimit-Remaining`: Remaining requests in window - `X-RateLimit-Reset`: Unix timestamp when limit resets
+ *
+ * The version of the OpenAPI document: 1.1.0
+ * Contact: support@soilsidekick.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function exists(json: any, key: string): boolean;
+export declare function mapValues(data: any, fn: (item: any) => any): {
+    [key: string]: any;
+};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}