deere-sdk 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2024-XX-XX
+
+### Added
+
+- Initial release
+- TypeScript SDK for John Deere Operations Center API
+- Auto-generated types from OpenAPI specifications
+- Support for 18 John Deere APIs:
+  - Organizations
+  - Fields
+  - Farms
+  - Boundaries
+  - Clients
+  - Equipment
+  - Field Operations
+  - Crop Types
+  - Products
+  - Map Layers
+  - Files
+  - Flags
+  - Guidance Lines
+  - Operators
+  - Users
+  - Assets
+  - Webhook
+  - Connection Management
+- DeereClient with automatic pagination support
+- Error handling with typed errors (DeereError, RateLimitError, AuthError)
+- Support for all John Deere environments (production, sandbox, partner, cert)

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ProductOfAmerica
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,253 @@
+# John Deere TypeScript SDK
+
+> **Unofficial** TypeScript SDK for John Deere Operations Center API
+
+This SDK provides typed access to John Deere's agricultural APIs, auto-generated from their OpenAPI specifications.
+
+## Installation
+
+```bash
+npm install deere-sdk
+# or
+pnpm add deere-sdk
+# or
+yarn add deere-sdk
+```
+
+## Quick Start
+
+```typescript
+import { Deere } from 'deere-sdk';
+
+const deere = new Deere({
+  accessToken: 'your-oauth-access-token',
+  environment: 'sandbox', // or 'production'
+});
+
+// List all organizations
+const orgs = await deere.organizations.listAll();
+console.log('Organizations:', orgs);
+
+// Get fields for an organization
+const fields = await deere.fields.listAll(orgs[0].id);
+console.log('Fields:', fields);
+
+// Get farms
+const farms = await deere.farms.listAll(orgs[0].id);
+console.log('Farms:', farms);
+
+// Get equipment
+const equipment = await deere.equipment.get();
+console.log('Equipment:', equipment);
+```
+
+## Authentication
+
+This SDK requires an OAuth 2.0 access token from John Deere. You'll need to:
+
+1. Register as a developer at [developer.deere.com](https://developer.deere.com)
+2. Create an application and get your client ID/secret
+3. Implement the OAuth 2.0 flow to obtain access tokens
+4. Use the `accessToken` in the SDK configuration
+
+### OAuth Scopes
+
+Common scopes you may need:
+- `ag1` - Read access to agricultural data
+- `ag2` - Write access to agricultural data
+- `ag3` - Additional agricultural data access
+- `offline_access` - Refresh token support
+
+## Available APIs
+
+The SDK provides access to 18 John Deere APIs:
+
+| API | Property | Description |
+|-----|----------|-------------|
+| Organizations | `deere.organizations` | Organization management |
+| Fields | `deere.fields` | Field CRUD and boundaries |
+| Farms | `deere.farms` | Farm management |
+| Boundaries | `deere.boundaries` | Field boundary management |
+| Clients | `deere.clients` | Client/customer management |
+| Equipment | `deere.equipment` | Machines and implements |
+| Field Operations | `deere.fieldOperations` | Harvests, plantings, applications |
+| Crop Types | `deere.cropTypes` | Crop type catalog |
+| Products | `deere.products` | Product catalog (seeds, chemicals) |
+| Map Layers | `deere.mapLayers` | Map layer management |
+| Files | `deere.files` | File management |
+| Flags | `deere.flags` | Field flags/markers |
+| Guidance Lines | `deere.guidanceLines` | GPS guidance lines |
+| Operators | `deere.operators` | Machine operator management |
+| Users | `deere.users` | User management |
+| Assets | `deere.assets` | Asset management |
+| Webhook | `deere.webhook` | Webhook subscriptions |
+| Connection Management | `deere.connectionManagement` | OAuth connection management |
+
+## API Examples
+
+### Organizations
+
+```typescript
+// List all organizations
+const orgs = await deere.organizations.listAll();
+
+// Get specific organization
+const org = await deere.organizations.get('org-id');
+
+// Search organizations
+const filtered = await deere.organizations.list({ orgName: 'Farm' });
+```
+
+### Fields
+
+```typescript
+// List all fields
+const fields = await deere.fields.listAll('org-id');
+
+// Get field details
+const field = await deere.fields.get('org-id', 'field-id');
+
+// Create a field
+await deere.fields.create('org-id', { name: 'North Field', ... });
+
+// Update a field
+await deere.fields.update('org-id', 'field-id', { name: 'Updated Name' });
+
+// Delete a field
+await deere.fields.delete('org-id', 'field-id');
+```
+
+### Farms
+
+```typescript
+// List all farms
+const farms = await deere.farms.listAll('org-id');
+
+// Get farm with archived filter
+const allFarms = await deere.farms.list('org-id', { recordFilter: 'all' });
+
+// Create a farm
+await deere.farms.create('org-id', { name: 'Smith Farm', clientUri: '...' });
+
+// Get fields for a farm
+const farmFields = await deere.farms.listFields('org-id', 'farm-id');
+```
+
+### Equipment
+
+```typescript
+// Get all equipment
+const equipment = await deere.equipment.get();
+
+// Filter by organization
+const orgEquipment = await deere.equipment.get({ organizationIds: [123] });
+
+// Filter by type
+const machines = await deere.equipment.get({ categories: 'Machine' });
+
+// Get equipment details
+const machine = await deere.equipment.getEquipment('equipment-id');
+```
+
+### Field Operations
+
+```typescript
+// Get field operations
+const ops = await deere.fieldOperations.list('org-id');
+
+// Filter by crop season and type
+const harvests = await deere.fieldOperations.list('org-id', {
+  cropSeason: '2024',
+  fieldOperationTypes: 'harvest'
+});
+```
+
+### Boundaries
+
+```typescript
+// List boundaries for a field
+const boundaries = await deere.boundaries.listAll('org-id', 'field-id');
+
+// Get active boundary
+const active = await deere.boundaries.getActiveBoundary('org-id', 'field-id');
+
+// Create boundary
+await deere.boundaries.create('org-id', 'field-id', {
+  name: 'Main Boundary',
+  multipolygons: [...]
+});
+```
+
+### Low-Level Client
+
+For endpoints not covered by the typed APIs:
+
+```typescript
+import { DeereClient } from 'deere-sdk';
+
+const client = new DeereClient({
+  accessToken: 'your-token',
+  environment: 'sandbox',
+});
+
+// Make raw requests
+const response = await client.get<CustomType>('/some/endpoint');
+const created = await client.post('/some/endpoint', { data: 'value' });
+
+// Follow HAL links
+const nextPage = await client.followLink(response.links[0]);
+
+// Automatic pagination
+for await (const items of client.paginate('/large/collection')) {
+  console.log(items);
+}
+```
+
+## Error Handling
+
+```typescript
+import { DeereError, RateLimitError, AuthError } from 'deere-sdk';
+
+try {
+  const fields = await deere.fields.listAll('org-id');
+} catch (error) {
+  if (error instanceof RateLimitError) {
+    console.log(`Rate limited. Retry after ${error.retryAfter} seconds`);
+  } else if (error instanceof AuthError) {
+    console.log('Authentication failed. Token may be expired.');
+  } else if (error instanceof DeereError) {
+    console.log(`API error: ${error.status} ${error.message}`);
+  }
+}
+```
+
+## Environments
+
+| Environment | URL | Use Case |
+|-------------|-----|----------|
+| `production` | api.deere.com | Live production data |
+| `sandbox` | sandboxapi.deere.com | Development/testing |
+| `partner` | partnerapi.deere.com | Partner integrations |
+| `cert` | apicert.deere.com | Certification testing |
+
+## TypeScript Support
+
+The SDK is fully typed. You can access the OpenAPI-generated types:
+
+```typescript
+import { Types } from 'deere-sdk';
+
+// Access specific API types
+type Farm = Types.Farms.components['schemas']['GetFarm'];
+type Field = Types.Fields.components['schemas']['FieldsResponse'];
+```
+
+## Disclaimer
+
+This is an **unofficial** SDK and is not affiliated with, endorsed by, or connected to John Deere or Deere & Company. Use at your own risk.
+
+John Deere and Operations Center are trademarks of Deere & Company.
+
+## License
+
+MIT

package/dist/api/assets.d.ts

@@ -0,0 +1,78 @@
+/**
+ * AssetsApi
+ *
+ * Auto-generated SDK wrapper for John Deere assets API.
+ * @generated from assets.yaml
+ */
+import type { DeereClient, RequestOptions, PaginatedResponse } from '../client.js';
+import type { components } from '../types/generated/assets.js';
+export declare class AssetsApi {
+    private readonly client;
+    constructor(client: DeereClient);
+    /**
+     * Get all assets
+     * @description This endpoint will retrieve all assets for an organization.
+     * @generated from GET /organizations/{orgId}/assets
+     */
+    list(orgId: string, params?: {
+        embed?: string;
+    }, options?: RequestOptions): Promise<unknown>;
+    /**
+     * Get all items (follows pagination automatically)
+     * @generated from GET /organizations/{orgId}/assets
+     */
+    listAll(orgId: string, params?: {
+        embed?: string;
+    }, options?: RequestOptions): Promise<unknown[]>;
+    /**
+     * Create a new asset
+     * @description This endpoint will create a new asset.
+     * @generated from POST /organizations/{orgId}/assets
+     */
+    create(orgId: string, data: Record<string, unknown>, options?: RequestOptions): Promise<void>;
+    /**
+     * Get a specific asset
+     * @description This endpoint will retrieve a specific asset by its unique ID.
+     * @generated from GET /assets/{assetId}
+     */
+    get(assetId: string, params?: {
+        embed?: string;
+    }, options?: RequestOptions): Promise<unknown>;
+    /**
+     * Update an asset
+     * @description This endpoint will update the asset by its unique id.
+     * @generated from PUT /assets/{assetId}
+     */
+    update(assetId: string, data: Record<string, unknown>, options?: RequestOptions): Promise<void>;
+    /**
+     * Delete an Asset
+     * @description This endpoint will delete an asset by its unique id.
+     * @generated from DELETE /assets/{assetId}
+     */
+    delete(assetId: string, options?: RequestOptions): Promise<void>;
+    /**
+     * Get all locations for an asset
+     * @description This endpoint will retrieve all locations for an asset. If you provide startDate and endDate then it will retrieve all the results of the given time range.
+     * @generated from GET /assets/{assetId}/locations
+     */
+    listLocations(assetId: string, params?: {
+        startDate?: string;
+        endDate?: string;
+        count?: string;
+        pageKey?: string;
+    }, options?: RequestOptions): Promise<unknown>;
+    /**
+     * Create new asset location
+     * @description This endpoint will create a new Asset Location.<br/><br/><b>We provide <a href="#markdown">Markdown support</a> for measurementData name.</b><br/><br/> <b>Please Note:</b> Only <i>links</i> are supported for a measurementData name.<br/><br/>Additionally, Asset Locations do not honor fractional seconds in their <mark>timestamps</mark>. So <mark>2019-01-01T12:34:56.900Z</mark> and <mark>2019-01-01T12:34:56Z</mark> are considered equivalent.
+     * @generated from POST /assets/{assetId}/locations
+     */
+    createLocations(assetId: string, data: Record<string, unknown>, options?: RequestOptions): Promise<void>;
+    /**
+     * Get Asset Catalog List
+     * @description This endpoint will retrieve the Asset Catalog List.
+     * @generated from GET /assetCatalog
+     */
+    getAssetcatalog(options?: RequestOptions): Promise<PaginatedResponse<components['schemas']['AssetCatalogGet']>>;
+}
+export type { components as AssetsTypes } from '../types/generated/assets.js';
+//# sourceMappingURL=assets.d.ts.map

package/dist/api/assets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../../src/api/assets.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACnF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE/D,qBAAa,SAAS;IACR,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,WAAW;IAEhD;;;;OAIG;IACG,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAOlG;;;OAGG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAQvG;;;;OAIG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKnG;;;;OAIG;IACG,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAQnG;;;;OAIG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKrG;;;;OAIG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKtE;;;;OAIG;IACG,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAWrK;;;;OAIG;IACG,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAK9G;;;;OAIG;IACG,eAAe,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC;CAItH;AAGD,YAAY,EAAE,UAAU,IAAI,WAAW,EAAE,MAAM,8BAA8B,CAAC"}

package/dist/api/assets.js

@@ -0,0 +1,115 @@
+/**
+ * AssetsApi
+ *
+ * Auto-generated SDK wrapper for John Deere assets API.
+ * @generated from assets.yaml
+ */
+export class AssetsApi {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Get all assets
+     * @description This endpoint will retrieve all assets for an organization.
+     * @generated from GET /organizations/{orgId}/assets
+     */
+    async list(orgId, params, options) {
+        const query = new URLSearchParams();
+        if (params?.embed !== undefined)
+            query.set('embed', String(params.embed));
+        const queryString = query.toString();
+        const path = `/organizations/${orgId}/assets${queryString ? `?${queryString}` : ''}`;
+        return this.client.get(path, options);
+    }
+    /**
+     * Get all items (follows pagination automatically)
+     * @generated from GET /organizations/{orgId}/assets
+     */
+    async listAll(orgId, params, options) {
+        const query = new URLSearchParams();
+        if (params?.embed !== undefined)
+            query.set('embed', String(params.embed));
+        const queryString = query.toString();
+        const path = `/organizations/${orgId}/assets${queryString ? `?${queryString}` : ''}`;
+        return this.client.getAll(path, options);
+    }
+    /**
+     * Create a new asset
+     * @description This endpoint will create a new asset.
+     * @generated from POST /organizations/{orgId}/assets
+     */
+    async create(orgId, data, options) {
+        const path = `/organizations/${orgId}/assets`;
+        await this.client.post(path, data, options);
+    }
+    /**
+     * Get a specific asset
+     * @description This endpoint will retrieve a specific asset by its unique ID.
+     * @generated from GET /assets/{assetId}
+     */
+    async get(assetId, params, options) {
+        const query = new URLSearchParams();
+        if (params?.embed !== undefined)
+            query.set('embed', String(params.embed));
+        const queryString = query.toString();
+        const path = `/assets/${assetId}${queryString ? `?${queryString}` : ''}`;
+        return this.client.get(path, options);
+    }
+    /**
+     * Update an asset
+     * @description This endpoint will update the asset by its unique id.
+     * @generated from PUT /assets/{assetId}
+     */
+    async update(assetId, data, options) {
+        const path = `/assets/${assetId}`;
+        await this.client.put(path, data, options);
+    }
+    /**
+     * Delete an Asset
+     * @description This endpoint will delete an asset by its unique id.
+     * @generated from DELETE /assets/{assetId}
+     */
+    async delete(assetId, options) {
+        const path = `/assets/${assetId}`;
+        await this.client.delete(path, options);
+    }
+    /**
+     * Get all locations for an asset
+     * @description This endpoint will retrieve all locations for an asset. If you provide startDate and endDate then it will retrieve all the results of the given time range.
+     * @generated from GET /assets/{assetId}/locations
+     */
+    async listLocations(assetId, params, options) {
+        const query = new URLSearchParams();
+        if (params?.startDate !== undefined)
+            query.set('startDate', String(params.startDate));
+        if (params?.endDate !== undefined)
+            query.set('endDate', String(params.endDate));
+        if (params?.count !== undefined)
+            query.set('count', String(params.count));
+        if (params?.pageKey !== undefined)
+            query.set('pageKey', String(params.pageKey));
+        const queryString = query.toString();
+        const path = `/assets/${assetId}/locations${queryString ? `?${queryString}` : ''}`;
+        return this.client.get(path, options);
+    }
+    /**
+     * Create new asset location
+     * @description This endpoint will create a new Asset Location.<br/><br/><b>We provide <a href="#markdown">Markdown support</a> for measurementData name.</b><br/><br/> <b>Please Note:</b> Only <i>links</i> are supported for a measurementData name.<br/><br/>Additionally, Asset Locations do not honor fractional seconds in their <mark>timestamps</mark>. So <mark>2019-01-01T12:34:56.900Z</mark> and <mark>2019-01-01T12:34:56Z</mark> are considered equivalent.
+     * @generated from POST /assets/{assetId}/locations
+     */
+    async createLocations(assetId, data, options) {
+        const path = `/assets/${assetId}/locations`;
+        await this.client.post(path, data, options);
+    }
+    /**
+     * Get Asset Catalog List
+     * @description This endpoint will retrieve the Asset Catalog List.
+     * @generated from GET /assetCatalog
+     */
+    async getAssetcatalog(options) {
+        const path = `/assetCatalog`;
+        return this.client.get(path, options);
+    }
+}
+//# sourceMappingURL=assets.js.map

package/dist/api/assets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assets.js","sourceRoot":"","sources":["../../src/api/assets.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,MAAM,OAAO,SAAS;IACS;IAA7B,YAA6B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAEpD;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,KAAa,EAAE,MAA2B,EAAE,OAAwB;QAC7E,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,kBAAkB,KAAK,UAAU,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACrF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAU,IAAI,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,KAAa,EAAE,MAA2B,EAAE,OAAwB;QAChF,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,kBAAkB,KAAK,UAAU,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACrF,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAU,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,IAA6B,EAAE,OAAwB;QACjF,MAAM,IAAI,GAAG,kBAAkB,KAAK,SAAS,CAAC;QAC9C,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,OAAe,EAAE,MAA2B,EAAE,OAAwB;QAC9E,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,WAAW,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACzE,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAU,IAAI,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,IAA6B,EAAE,OAAwB;QACnF,MAAM,IAAI,GAAG,WAAW,OAAO,EAAE,CAAC;QAClC,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,OAAwB;QACpD,MAAM,IAAI,GAAG,WAAW,OAAO,EAAE,CAAC;QAClC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,OAAe,EAAE,MAAmF,EAAE,OAAwB;QAChJ,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,MAAM,EAAE,SAAS,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QACtF,IAAI,MAAM,EAAE,OAAO,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QAChF,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,IAAI,MAAM,EAAE,OAAO,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QAChF,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,WAAW,OAAO,aAAa,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACnF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAU,IAAI,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,OAAe,EAAE,IAA6B,EAAE,OAAwB;QAC5F,MAAM,IAAI,GAAG,WAAW,OAAO,YAAY,CAAC;QAC5C,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,OAAwB;QAC5C,MAAM,IAAI,GAAG,eAAe,CAAC;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAA8D,IAAI,EAAE,OAAO,CAAC,CAAC;IACrG,CAAC;CACF"}

package/dist/api/boundaries.d.ts

@@ -0,0 +1,69 @@
+/**
+ * BoundariesApi
+ *
+ * Auto-generated SDK wrapper for John Deere boundaries API.
+ * @generated from boundaries.yaml
+ */
+import type { DeereClient, RequestOptions } from '../client.js';
+export declare class BoundariesApi {
+    private readonly client;
+    constructor(client: DeereClient);
+    /**
+     * View Boundaries in an Org
+     * @description View boundaries in an organization. <ul> <li><b>fields</b>: View the field associated with these boundaries.</li> <li><b>owningOrganizations</b>: View the organization that owns the field.</li> </ul>
+     * @generated from GET /organizations/{orgId}/boundaries
+     */
+    list(orgId: string, params?: {
+        embed?: string;
+        recordFilter?: string;
+    }, options?: RequestOptions): Promise<unknown>;
+    /**
+     * Get all items (follows pagination automatically)
+     * @generated from GET /organizations/{orgId}/boundaries
+     */
+    listAll(orgId: string, params?: {
+        embed?: string;
+        recordFilter?: string;
+    }, options?: RequestOptions): Promise<unknown[]>;
+    /**
+     * View the Boundaries of a Field
+     * @description View the boundaries of a specified field.
+     * @generated from GET /organizations/{orgId}/fields/{fieldId}/boundaries
+     */
+    listBoundaries(orgId: string, fieldId: string, params?: {
+        embed?: string;
+        recordFilter?: string;
+    }, options?: RequestOptions): Promise<unknown>;
+    /**
+     * Create a Boundary
+     * @description Create a boundary with a geometry collection for a field.
+     * @generated from POST /organizations/{orgId}/fields/{fieldId}/boundaries
+     */
+    create(orgId: string, fieldId: string, data: Record<string, unknown>, options?: RequestOptions): Promise<void>;
+    /**
+     * Generate a Boundary from a FieldOperation
+     * @description Given a <a href='/dev-docs/field-operations#overviews' target='_blank'>field operation</a>, this endpoint will generate and return a boundary that surrounds the area worked by that field operation. Any gaps in that field operation will be treated as interior rings. This endpoint returns the generated boundary, giving you the opportunity to change the boundary name, clean up any unwanted interiors, etc. before <a href='/dev-docs/boundaries#/organizations/{orgId}/fields/{fieldId}/boundaries/post' target='_blank'>POST'ing the generated boundary</a> back into Operations Center. <p>There are two cases where this API will return an HTTP 400 - Bad Request:</p> <ul> <li><b>If the field already has an active boundary.</b> In this case, please use the existing boundary - it is likely more accurate than a generated boundary.</li> <li><b>If the field has been merged.</b> In this case, a FieldOperation may only cover one part of the merged field, resulting in an inaccurate boundary.</li> </ul>
+     * @generated from GET /fieldOperations/{operationId}/boundary
+     */
+    get(operationId: string, options?: RequestOptions): Promise<unknown>;
+    /**
+     * Get a specific boundary
+     * @description This endpoint will retrieve a specific boundary.
+     * @generated from GET /organizations/{orgId}/fields/{fieldId}/boundaries/{boundaryId}
+     */
+    getBoundaries(orgId: string, fieldId: string, boundaryId: string, options?: RequestOptions): Promise<unknown>;
+    /**
+     * Update a boundary
+     * @description This endpoint will update a boundary. The shape of the object must include name, active, irrigated, sourceType, and multipolygons. All these fields can be updated, however a license is required to set sourceType to a value other than "External". If the boundary is set to active, it will mark all other boundaries in this field inactive.
+     * @generated from PUT /organizations/{orgId}/fields/{fieldId}/boundaries/{boundaryId}
+     */
+    update(orgId: string, fieldId: string, boundaryId: string, data: Record<string, unknown>, options?: RequestOptions): Promise<void>;
+    /**
+     * Delete a boundary
+     * @description This endpoint will delete a boundary.
+     * @generated from DELETE /organizations/{orgId}/fields/{fieldId}/boundaries/{boundaryId}
+     */
+    delete(orgId: string, fieldId: string, boundaryId: string, options?: RequestOptions): Promise<void>;
+}
+export type { components as BoundariesTypes } from '../types/generated/boundaries.js';
+//# sourceMappingURL=boundaries.d.ts.map

package/dist/api/boundaries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"boundaries.d.ts","sourceRoot":"","sources":["../../src/api/boundaries.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAqB,MAAM,cAAc,CAAC;AAGnF,qBAAa,aAAa;IACZ,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,WAAW;IAEhD;;;;OAIG;IACG,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAQzH;;;OAGG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAS9H;;;;OAIG;IACG,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IASpJ;;;;OAIG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKpH;;;;OAIG;IACG,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAK1E;;;;OAIG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAKnH;;;;OAIG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKxI;;;;OAIG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAI1G;AAGD,YAAY,EAAE,UAAU,IAAI,eAAe,EAAE,MAAM,kCAAkC,CAAC"}