deere-sdk 0.1.0

package/dist/types/generated/boundaries.d.ts

@@ -0,0 +1,734 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/organizations/{orgId}/boundaries": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 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>
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description Populates response with data lineage information */
+                    embed?: components["parameters"]["Embed"];
+                    /** @description Filter results based on status; defaults to active */
+                    recordFilter?: components["parameters"]["RecordFilter"];
+                };
+                header?: never;
+                path: {
+                    /** @description Organization */
+                    orgId: components["parameters"]["OrgId"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: components["responses"]["BoundariesResponse"];
+                403: components["responses"]["Forbidden"];
+                404: components["responses"]["NotFound"];
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/organizations/{orgId}/fields/{fieldId}/boundaries": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * View the Boundaries of a Field
+         * @description View the boundaries of a specified field.
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description Populates response with data lineage information */
+                    embed?: components["parameters"]["Embed"];
+                    /** @description Filter results based on status; defaults to active */
+                    recordFilter?: components["parameters"]["RecordFilter"];
+                };
+                header?: never;
+                path: {
+                    /** @description Organization */
+                    orgId: components["parameters"]["OrgId"];
+                    /** @description Field ID */
+                    id: components["parameters"]["Id"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: components["responses"]["BoundariesResponse"];
+                403: components["responses"]["Forbidden"];
+                404: components["responses"]["NotFound"];
+            };
+        };
+        put?: never;
+        /**
+         * Create a Boundary
+         * @description Create a boundary with a geometry collection for a field.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Organization ID */
+                    orgId: components["parameters"]["OrgId2"];
+                    /** @description Field GUID */
+                    fieldId: components["parameters"]["FieldId"];
+                };
+                cookie?: never;
+            };
+            requestBody?: {
+                content: {
+                    "No Header": unknown;
+                };
+            };
+            responses: {
+                200: components["responses"]["Created"];
+                400: components["responses"]["BadRequest"];
+                403: components["responses"]["Forbidden"];
+                404: components["responses"]["NotFound"];
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/fieldOperations/{operationId}/boundary": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * 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>
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: components["responses"]["BoundariesResponse2"];
+                403: components["responses"]["Forbidden"];
+                404: components["responses"]["NotFound"];
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/organizations/{orgId}/fields/{fieldId}/boundaries/{boundaryId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a specific boundary
+         * @description This endpoint will retrieve a specific boundary.
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Organization */
+                    orgId: components["parameters"]["OrgId3"];
+                    /** @description Field Id */
+                    fieldId: components["parameters"]["FieldId2"];
+                    /** @description Boundary Id */
+                    boundaryId: components["parameters"]["BoundaryId"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: components["responses"]["BoundaryResponse"];
+                403: components["responses"]["Forbidden"];
+                404: components["responses"]["NotFound"];
+            };
+        };
+        /**
+         * 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.
+         */
+        put: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Organization */
+                    orgId: components["parameters"]["OrgId3"];
+                    /** @description Field Id */
+                    fieldId: components["parameters"]["FieldId2"];
+                    /** @description Boundary Id */
+                    boundaryId: components["parameters"]["BoundaryId"];
+                };
+                cookie?: never;
+            };
+            requestBody?: components["requestBodies"]["PutRequest"];
+            responses: {
+                200: components["responses"]["Update"];
+                400: components["responses"]["BadRequest"];
+                403: components["responses"]["Forbidden"];
+                404: components["responses"]["NotFound"];
+            };
+        };
+        post?: never;
+        /**
+         * Delete a boundary
+         * @description This endpoint will delete a boundary.
+         */
+        delete: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Organization */
+                    orgId: components["parameters"]["OrgId3"];
+                    /** @description Field Id */
+                    fieldId: components["parameters"]["FieldId2"];
+                    /** @description Boundary Id */
+                    boundaryId: components["parameters"]["BoundaryId"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: components["responses"]["NoContent"];
+                403: components["responses"]["Forbidden"];
+                404: components["responses"]["NotFound"];
+            };
+        };
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        BoundaryOrgId: {
+            /**
+             * Format: uuid
+             * @description Boundary ID
+             * @example 6232611a-0303-0234-8g7d-e1e1e11871b8
+             */
+            id?: string;
+            /**
+             * @description Boundary name
+             * @example Unique_Boundary_name
+             */
+            name?: string;
+            /**
+             * @description Boundary area
+             * @example See sample response below.
+             */
+            area?: unknown;
+            /**
+             * @description Exteriors-interiors of the boundary.
+             * @example See sample response below.
+             */
+            workableArea?: unknown;
+            /**
+             * @description Describes the source of boundary (requires license to set).
+             * @example HandDrawn
+             */
+            sourceType?: string;
+            /**
+             * @description Boundary shape and exact location.
+             * @example See sample response below
+             */
+            multipolygons?: unknown;
+            /**
+             * @description Boundary type
+             * @example exterior
+             */
+            "type<sup><a href='#additional'>1</a></sup>"?: string;
+            /**
+             * @description "True" indicates that the boundary can be crossed (Ex: a waterway). "False" indicates that the boundary cannot be crossed (ex: a boulder).
+             * @example true
+             */
+            passable?: boolean;
+            /**
+             * @description Coordinates of the extent of the boundary.
+             * @example See sample response below.
+             */
+            extent?: unknown;
+            /**
+             * @description Indicates whether or not the boundary is active.
+             * @example true
+             */
+            active?: boolean;
+            /**
+             * @description Indicates whether or not the boundary is archived.
+             * @example true
+             */
+            archived?: boolean;
+            /**
+             * @description Signal Type used when defining boundary. See “dtSignalType” in the John Deere representation system for possible values.
+             * @example dtiSignalTypeRTK
+             */
+            signalType?: string;
+            /**
+             * Format: date-time
+             * @description An ISO-8601 formatted timestamp of the last modification made to this boundary.
+             * @example 2017-11-16T15:43:27.496Z
+             */
+            modifiedTime?: string;
+            /**
+             * Format: date-time
+             * @description An ISO-8601 formatted timestamp of the time this boundary was created.
+             * @example 2017-11-16T15:43:27.496Z
+             */
+            createdTime?: string;
+            /**
+             * @description Indicates whether the contained area is irrigated.
+             * @example true
+             */
+            irrigated?: boolean;
+        };
+        BoundaryOrgId2: {
+            /**
+             * Format: uuid
+             * @description Boundary ID
+             * @example 6232611a-0303-0234-8g7d-e1e1e11871b8
+             */
+            id?: string;
+            /**
+             * @description Boundary name
+             * @example AutoGenerated 2020 Seeding
+             */
+            name?: string;
+            /**
+             * @description Describes the source of boundary (requires license to set).
+             * @example Auto
+             */
+            sourceType?: string;
+            /**
+             * @description Boundary shape and exact location.
+             * @example See sample response below
+             */
+            multipolygons?: unknown;
+            /**
+             * @description Boundary type
+             * @example exterior
+             */
+            "type<sup><a href='#additional'>1</a></sup>"?: string;
+            /**
+             * @description "True" indicates that the boundary can be crossed (Ex: a waterway). "False" indicates that the boundary cannot be crossed (ex: a boulder).
+             * @example true
+             */
+            passable?: boolean;
+            /**
+             * @description Coordinates of the extent of the boundary.
+             * @example See sample response below.
+             */
+            extent?: unknown;
+            /**
+             * @description Indicates whether or not the boundary is active.
+             * @example true
+             */
+            active?: boolean;
+            /**
+             * @description Signal Type used when defining boundary. See “dtSignalType” in the John Deere representation system for possible values.
+             * @example dtiSignalTypeRTK
+             */
+            signalType?: string;
+            /**
+             * Format: date-time
+             * @description An ISO-8601 formatted timestamp of the last modification made to this boundary.
+             * @example 2017-11-16T15:43:27.496Z
+             */
+            modifiedTime?: string;
+            /**
+             * @description Indicates whether the contained area is irrigated.
+             * @example true
+             */
+            irrigated?: boolean;
+        };
+        PostBoundaryGet: {
+            /**
+             * Format: uuid
+             * @description An identifier for this boundary, which is unique within a field context.
+             * @example bed69949-df25-4319-8f6c-94c62b466126
+             */
+            id?: string;
+            /**
+             * @description Boundary name
+             * @example Unique_Boundary_name
+             */
+            name?: string;
+            /**
+             * Format: date-time
+             * @description An ISO-8601 formatted timestamp of the last modification made to this boundary.
+             * @example 2017-11-16T15:43:27.496Z
+             */
+            modifiedTime?: string;
+            /**
+             * Format: date-time
+             * @description An ISO-8601 formatted timestamp of the time this boundary was created.
+             * @example 2017-11-16T15:43:27.496Z
+             */
+            createdTime?: string;
+            /**
+             * @description The sum of all exterior polygons.
+             * @example See sample response below.
+             */
+            area?: unknown;
+            /**
+             * @description Exteriors-interiors of the boundary.
+             * @example See sample response below.
+             */
+            workableArea?: unknown;
+            /**
+             * @description Describes the source of boundary (requires license to set).
+             * @example HandDrawn
+             */
+            sourceType?: string;
+            /**
+             * @description A collection of polygons.
+             * @example See sample response below
+             */
+            multipolygons?: unknown[];
+            /**
+             * @description Coordinates of the extent of the boundary.
+             * @example See sample response below.
+             */
+            extent?: Record<string, never>;
+            /**
+             * @description Whether or not this boundary is currently in use. A field with associated boundaries will have exactly one active boundary; however, a field may also exist with no boundaries.
+             * @example true
+             */
+            active?: boolean;
+            /**
+             * @description Indicates whether or not this boundary is currently archived
+             * @example true
+             */
+            archived?: boolean;
+            /**
+             * @description Signal Type used when defining boundary. See “dtSignalType” in the John Deere representation system for possible values.
+             * @example dtiSignalTypeRTK
+             */
+            signalType?: string;
+            /**
+             * @description Indicates whether the contained area is irrigated.
+             * @example false
+             */
+            irrigated?: boolean;
+            /**
+             * @description Boundary type
+             * @example exterior
+             */
+            "type<sup><a href='#additional'>1</a></sup>"?: string;
+            /**
+             * @description "True" indicates that the boundary can be crossed (Ex: a waterway). "False" indicates that the boundary cannot be crossed (ex: a boulder).
+             * @example true
+             */
+            passable?: boolean;
+        };
+        PostBoundary: {
+            /**
+             * @description Boundary Name.
+             * @example Boundary_Unique_Name
+             */
+            name?: string;
+            /**
+             * @description Indicates whether the boundary is active in this field.
+             * @example false
+             */
+            active?: boolean;
+            /**
+             * @description Indicates whether the boundary is archived.
+             * @example false
+             */
+            archive?: boolean;
+            /**
+             * @description Indicates whether the boundary is irrigated.
+             * @example false
+             */
+            irrigated?: boolean;
+            /**
+             * @description Polygon representation of the new boundary.
+             * @example See sample request below.
+             */
+            multipolygons?: unknown;
+            /**
+             * @description Describes the source of boundary (requires license to set).
+             * @example External
+             */
+            sourceType?: string;
+            /**
+             * @description Signal Type used when defining boundary. See “dtSignalType” in the John Deere representation system for possible values.
+             * @example dtiSignalTypeRTK
+             */
+            signalType?: string;
+        };
+        PutBoundary: {
+            /**
+             * @description Boundary Name.
+             * @example Boundary01
+             */
+            name?: string;
+            /**
+             * @description Indicates whether the boundary is active in this field.
+             * @example false
+             */
+            active?: boolean;
+            /**
+             * @description Indicates whether the boundary is archived.
+             * @example false
+             */
+            archive?: boolean;
+            /**
+             * @description Indicates whether the boundary is irrigated.
+             * @example false
+             */
+            irrigated?: boolean;
+            /**
+             * @description Polygon representation of the new boundary.
+             * @example See sample request below.
+             */
+            multipolygons?: unknown;
+            /**
+             * @description Describes the source of boundary (requires license to set).
+             * @example External
+             */
+            sourceType?: string;
+            /**
+             * @description Signal Type used when defining boundary. See “dtSignalType” in the John Deere representation system for possible values.
+             * @example dtiSignalTypeRTK
+             */
+            signalType?: string;
+        };
+        BoundariesLink: {
+            /**
+             * @description Fields Link.
+             * @example https://sandboxapi.deere.com/platform/organizations/123456/fields/209b3c20-f33a-4c96-9a2c-613def198e0c
+             */
+            field?: unknown;
+            /**
+             * @description Organizations Link.
+             * @example https://sandboxapi.deere.com/platform/organizations/1234
+             */
+            owningOrganization?: unknown;
+        };
+        /** @description Stub schema for Boundary (auto-generated - original was missing) */
+        Boundary: {
+            [key: string]: unknown;
+        };
+        /** @description Error response schema for Errors (auto-generated) */
+        Errors: {
+            message?: string;
+            errors?: Record<string, never>[];
+        };
+    };
+    responses: {
+        /** @description A collection of boundaries */
+        BoundariesResponse: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/vnd.deere.axiom.v3+json": {
+                    links?: unknown;
+                    /**
+                     * Format: int32
+                     * @example 1
+                     */
+                    total?: number;
+                    values?: components["schemas"]["BoundaryOrgId"][];
+                };
+            };
+        };
+        /** @description A collection of boundaries */
+        BoundariesResponse2: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/vnd.deere.axiom.v3+json": {
+                    links?: unknown;
+                    /**
+                     * Format: int32
+                     * @example 1
+                     */
+                    total?: number;
+                    values?: components["schemas"]["BoundaryOrgId2"][];
+                };
+            };
+        };
+        /** @description A single boundary */
+        BoundaryResponse: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/vnd.deere.axiom.v3+json": {
+                    links?: unknown;
+                    /**
+                     * Format: int32
+                     * @example 1
+                     */
+                    total?: number;
+                    values?: components["schemas"]["PostBoundaryGet"][];
+                };
+            };
+        };
+        /** @description Created, with a Location header containing the URI of the newly created resource */
+        Created: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/vnd.deere.axiom.v3+json": {
+                    /**
+                     * Format: int32
+                     * @example 1
+                     */
+                    total?: number;
+                    values?: components["schemas"]["PostBoundary"][];
+                };
+            };
+        };
+        /** @description Created, with a Location header containing the URI of the newly created resource */
+        Create: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/vnd.deere.axiom.v3+json": {
+                    /**
+                     * Format: int32
+                     * @example 1
+                     */
+                    total?: number;
+                };
+            };
+        };
+        /** @description Updated, with a Location header containing the URI of the newly created resource */
+        Update: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/vnd.deere.axiom.v3+json": {
+                    /**
+                     * Format: int32
+                     * @example 1
+                     */
+                    total?: number;
+                };
+            };
+        };
+        /** @description No Content. Request Completed Succesfully. */
+        NoContent: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "No Content": unknown;
+            };
+        };
+        /** @description Request Validation failure. The boundary name must be between 1-20 characters. There must be at least one exterior ring. Each ring must have 4 or more points. The first and last point must be the same for each ring. */
+        BadRequest: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/vnd.deere.axiom.v3+json": components["schemas"]["Errors"];
+            };
+        };
+        /** @description The user does not have sufficient privileges to access this organization's boundaries. */
+        Forbidden: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+        /** @description The specified resource does not exist */
+        NotFound: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+    };
+    parameters: {
+        /** @description Organization */
+        OrgId: string;
+        /** @description Organization */
+        OrgId3: string;
+        /** @description Takes <b>METRIC</b> and <b>ENGLISH</b>. Converts measurements to the chosen system. */
+        "Accept-UOM-System": string;
+        /** @description Organization ID */
+        OrgId2: string;
+        /** @description Populates response with data lineage information */
+        Embed: string;
+        /** @description Filter results based on status; defaults to active */
+        RecordFilter: string;
+        /** @description Field ID */
+        Id: string;
+        /** @description Field GUID */
+        FieldId: string;
+        /** @description Field Id */
+        FieldId2: string;
+        /** @description Boundary Id */
+        BoundaryId: string;
+        /** @description Takes <b>METRIC</b> and <b>ENGLISH</b>. Converts measurements to the chosen system. */
+        AcceptUOMSystem: "ENGLISH" | "METRIC";
+        /** @description Allows filtering based on active boundaries */
+        Active: boolean;
+    };
+    requestBodies: {
+        /** @description Specifies Boundary details */
+        PostRequest: {
+            content: {
+                "application/vnd.deere.axiom.v3+json": components["schemas"]["Boundary"];
+            };
+        };
+        /** @description The desired Boundary to be updated */
+        PutRequest: {
+            content: {
+                "application/vnd.deere.axiom.v3+json": components["schemas"]["PutBoundary"];
+            };
+        };
+    };
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export type operations = Record<string, never>;
+//# sourceMappingURL=boundaries.d.ts.map