deere-sdk 0.1.0

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

@@ -0,0 +1,1165 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/organizations/{organizationId}/varieties": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * View varieties for an org
+         * @description This endpoint will retrieve a collection of varieties for the specified org.
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description Filters the list based on archive status. Accepted values are ARCHIVED, AVAILABLE, and ALL. The default behavior is to return only available (non-archived) varieties. */
+                    status?: components["parameters"]["ArchiveStatus"];
+                    /** @description An embeddable list of properties which are optional by default. */
+                    embed?: components["parameters"]["VarietyEmbed"];
+                };
+                header?: never;
+                path: {
+                    /** @description The identifier of the Organization. */
+                    organizationId: components["parameters"]["OrganizationID"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description A collection of your org varieties. If any of the supported embeds are used, the associated data will be present as a field in the variety. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/vnd.deere.axiom.v3+json": components["schemas"]["VarietyCollection"];
+                    };
+                };
+                /** @description The user has not been provided access to the varieties for this org */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description The specified organization does not exist */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        /**
+         * Add a variety
+         * @description This endpoint will add a custom variety into the organization. Its name+cropName must be unique within your organization. Its crop name must be a supported crop name (see /cropTypes). There are a number of crop names that are deprecated in the system. If the crop name is set to one of these, then it will be mapped to its corresponding valid crop name. </br> </br> Additionally, POST can be used for supporting offline creation of varieties from e.g. a mobile app, by sending a payload  with an `id` generated by the client. If an `id` is present in the payload, the service checks the database for that `id`.</br> </br> In case no record is found, a new one is created with that `id` and the request is responded with 201.</br> Otherwise no creation happens and the request is responded with 409 and error message that a resource with that `id` already exists.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description The identifier of the Organization. */
+                    organizationId: components["parameters"]["OrganizationID"];
+                };
+                cookie?: never;
+            };
+            /** @description The product to add. */
+            requestBody?: {
+                content: {
+                    "application/vnd.deere.axiom.v3+json": components["schemas"]["PostVariety"];
+                };
+            };
+            responses: {
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/vnd.deere.axiom.v3+json": components["responses"]["Created"];
+                    };
+                };
+                /** @description Schema validation error. Missing one or more of the required fields (name, companyName, cropName), name exceeds length limitation, or crop type is invalid. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/vnd.deere.axiom.v3+json": components["schemas"]["Errors"];
+                    };
+                };
+                /** @description The user has not been provided write access to the variety list for the org */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description The specified organization does not exist */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description A product already exists in this org with the specified reference Erid */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/organizations/{organizationId}/varieties/{erid}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * View a specific variety
+         * @description This endpoint will return the variety with the specified erid.
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description An embeddable list of properties which are optional by default. */
+                    embed?: components["parameters"]["VarietyEmbed"];
+                };
+                header?: never;
+                path: {
+                    /** @description The identifier of the Organization. */
+                    organizationId: components["parameters"]["OrganizationID"];
+                    /**
+                     * @description A unique identifier for an entity formatted as a uuid.
+                     * @example cf09acfc-9196-4dbb-9b38-1be02673c5ff
+                     */
+                    erid: components["parameters"]["ERID"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description A variety object */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/vnd.deere.axiom.v3+json": components["schemas"]["Variety"];
+                    };
+                };
+                /** @description The user does not have sufficient privileges to access varieties in this org */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description There is no variety matching the specified Erid */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        /**
+         * Update a single variety
+         * @description This endpoint allows the custom variety to be renamed, made active/archived, or associated to a different manufacturer or crop type.
+         */
+        put: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description The identifier of the Organization. */
+                    organizationId: components["parameters"]["OrganizationID"];
+                    /**
+                     * @description A unique identifier for an entity formatted as a uuid.
+                     * @example cf09acfc-9196-4dbb-9b38-1be02673c5ff
+                     */
+                    erid: components["parameters"]["ERID"];
+                };
+                cookie?: never;
+            };
+            /** @description The updated variety object. */
+            requestBody?: {
+                content: {
+                    "application/vnd.deere.axiom.v3+json": components["schemas"]["PutVariety"];
+                };
+            };
+            responses: {
+                /** @description The update was completed successfully */
+                204: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/vnd.deere.axiom.v3+json": unknown;
+                    };
+                };
+                /** @description Schema validation error. Missing one or more of the required fields (name, companyName, cropName), name exceeds length limitation, or crop type is invalid */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/vnd.deere.axiom.v3+json": components["schemas"]["Errors"];
+                    };
+                };
+                /** @description The user does not have sufficient privileges to update varieties in this org */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description There is no variety matching the specified Erid */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/varieties/{erid}/associateToOrg/{organizationId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Adds a single reference variety to organization
+         * @description This endpoint will associate a reference variety to your organization from the global reference list.
+         *     The reference varieties are immutable, however, they can still be archived or made available.
+         *     The response headers from the GET endpoints will include the attributes that can be overridden.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /**
+                     * @description A unique identifier for an entity formatted as a uuid.
+                     * @example cf09acfc-9196-4dbb-9b38-1be02673c5ff
+                     */
+                    erid: components["parameters"]["ERID"];
+                    /** @description The identifier of the Organization. */
+                    organizationId: components["parameters"]["OrganizationID"];
+                };
+                cookie?: never;
+            };
+            /** @description The product to add. */
+            requestBody?: {
+                content: {
+                    "application/vnd.deere.axiom.v3+json": components["schemas"]["ReferenceProductPointerRequest"];
+                };
+            };
+            responses: {
+                /** @description Successful association of reference variety to org. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/vnd.deere.axiom.v3+json": components["schemas"]["ReferenceProductOverrideStatus"][];
+                    };
+                };
+                /** @description Unresolvable name conflict or other error occurred. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * Format: int64
+                             * @example 1
+                             */
+                            total?: number;
+                            errors?: components["schemas"]["Errors"][];
+                        };
+                    };
+                };
+                /** @description Invalid access to products for organization */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Organization does not exist. */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description A product already exists in this org with the specified erid. */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/varieties": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Search reference catalog varieties
+         * @description This endpoint searches the reference catalog for varieties that match the given search criteria. This data can be used in a subsequent request to create a variety in an organization. Results are limited to 100 items.
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description Performs a fuzzy search on variety and manufacturer name. The search string must be at least 3 characters long. */
+                    searchString?: string;
+                    /** @description Filters the results by crop id (see the /cropTypes API). */
+                    cropName?: string;
+                    /** @description Specifies the name of the variety from the global reference list. */
+                    productName?: string;
+                    /** @description Specifies the product manufacturer name of the variety based on the region being used. */
+                    brandName?: string;
+                    /** @description Specifies the source system product id of the variety based on the country of use. */
+                    sourceSystemProductId?: string;
+                    /** @description Specifies the region the variety data belongs to. Some data may not be available in certain regions and data will not be included in the response. */
+                    countryCode?: string;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description A collection of reference varieties matching the specified search criteria. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/vnd.deere.axiom.v3+json": components["schemas"]["ReferenceVarietyCollection"];
+                    };
+                };
+                /** @description The user does not have access to manage products. */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description No variety found with this country code. */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/varieties/{erid}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get a single reference variety.
+         * @description Single variety from industry data sources, such as CDMS.
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /**
+                     * @description A unique identifier for an entity formatted as a uuid.
+                     * @example cf09acfc-9196-4dbb-9b38-1be02673c5ff
+                     */
+                    erid: components["parameters"]["ERID"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description A single variety matching the specified erid. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/vnd.deere.axiom.v3+json": components["schemas"]["ReferenceVariety"];
+                    };
+                };
+                /** @description The user does not have access to manage products. */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description No variety found matching this erid. */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/varieties/{erid}/documents": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Reference list of documents for an associated seed variety.
+         * @description List of all the documents for a variety from industry data sources, such as CDMS.
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /**
+                     * @description A unique identifier for an entity formatted as a uuid.
+                     * @example cf09acfc-9196-4dbb-9b38-1be02673c5ff
+                     */
+                    erid: components["parameters"]["ERID"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description A collection of documents for the specified seed variety. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/vnd.deere.axiom.v3+json": components["schemas"]["DocumentCollection"];
+                    };
+                };
+                /** @description The user does not have access to manage products. */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/varieties/{erid}/setOverridesForOrg/{organizationId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * Sets organizational attributes such as isCarrier, archived, registration, etc.
+         * @description This endpoint will set attribute overrides while importing a reference variety to your organization. The reference varieties are immutable, however, they can still be archived or made available. The response headers from the GET endpoints will include the attributes that can be overridden.
+         */
+        patch: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /**
+                     * @description A unique identifier for an entity formatted as a uuid.
+                     * @example cf09acfc-9196-4dbb-9b38-1be02673c5ff
+                     */
+                    erid: components["parameters"]["ERID"];
+                    /** @description The identifier of the Organization. */
+                    organizationId: components["parameters"]["OrganizationID"];
+                };
+                cookie?: never;
+            };
+            /** @description The product to add. */
+            requestBody?: {
+                content: {
+                    "application/vnd.deere.axiom.v3+json": components["schemas"]["CommonProductPointerRequest"];
+                };
+            };
+            responses: {
+                /** @description Successful update of overrides of reference variety associated to your org. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/vnd.deere.axiom.v3+json": components["schemas"]["ReferenceProductOverrideStatus"][];
+                    };
+                };
+                /** @description Unresolvable name conflict or other error occurred. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * Format: int64
+                             * @example 1
+                             */
+                            total?: number;
+                            errors?: components["schemas"]["Errors"][];
+                        };
+                    };
+                };
+                /** @description Invalid access to reference product associated to organization */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Organization does not exist */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        BaseResourceWithoutLink: {
+            /** @example BaseResource */
+            "@type"?: string;
+            /**
+             * Format: uuid
+             * @description Primary identifier for resource.
+             * @example 1f8c12b4-126f-11ec-82a8-0242ac130003
+             */
+            id?: string;
+        };
+        Document: {
+            /** @example Document */
+            "@type": unknown;
+            /**
+             * @description Unique id of the document
+             * @example 08e930ee-4c31-41b6-b57e-8c0a8e1284a4
+             */
+            erid?: string;
+            /**
+             * @description Type of document for this product.
+             * @example 24(c) Registration
+             */
+            docType: string;
+            /**
+             * @description The Unique id of the product.
+             * @example 388ab719-277d-4032-a2c3-40a297d8f482
+             */
+            productErid: string;
+            /**
+             * @description Information about the document.
+             * @example CO-090003 R-4310 102119 For Use on Alfalfa Grown for Seed
+             */
+            description: string;
+            /**
+             * @description The filename of the document.
+             * @example ld7OD026.pdf
+             */
+            fileName: string;
+            /**
+             * Format: date
+             * @example 2017-03-22
+             */
+            readonly expirationDate?: string | null;
+        };
+        DocumentCollection: components["schemas"]["CollectionBase"] & {
+            values?: components["schemas"]["Document"][];
+        };
+        BaseResource: {
+            /** @example BaseResource */
+            "@type"?: string;
+            /**
+             * Format: uuid
+             * @description Primary identifier for resource.
+             * @example 1f8c12b4-126f-11ec-82a8-0242ac130003
+             */
+            id?: string;
+            /** @description Provides a reference to an associated object or list. */
+            links?: components["schemas"]["Link"][];
+        };
+        ReferenceVariety: components["schemas"]["BaseResource"] & {
+            /** @example ReferenceVariety */
+            "@type"?: unknown;
+            /**
+             * Format: uuid
+             * @description Primary identifier for reference variety.
+             * @example 1f8c12b4-126f-11ec-82a8-0242ac130003
+             */
+            id?: string;
+            /**
+             * Format: uuid
+             * @description product id of the reference variety
+             * @example 87b4a1e7-210b-482c-8a7a-19e9f644e914
+             */
+            "referenceId<sup>DEPRECATED</sup>"?: string;
+            /**
+             * @example VARIETY
+             * @enum {string}
+             */
+            category?: "VARIETY";
+            /**
+             * @description The common name of the reference variety.
+             * @example S73-Z5 - 50lb bag
+             */
+            name?: string;
+            /**
+             * Format: uuid
+             * @description Optional. Denotes whether this product is from the global reference list.
+             * @example 87b4a1e7-210b-482c-8a7a-19e9f644e914
+             */
+            referenceGuid?: string;
+            /**
+             * @description The name of the input manufacturer.
+             * @example NK
+             */
+            companyName?: string;
+            /**
+             * @description The identifier of the crop type that this reference variety is associated with (see the Crop Types API).
+             * @example SOYBEANS
+             */
+            cropName?: string;
+            /**
+             * @description Specifies the region the reference  variety data belongs to. Some data may not be available in certain regions and data will not be included in the response.
+             * @example USA
+             */
+            countryCode?: string;
+            /**
+             * Format: integer
+             * @description The source system for the reference variety.
+             * @example 3
+             */
+            sourceSystem?: string;
+            /**
+             * @description The source system identifier for the reference variety.
+             * @example 905P24925
+             */
+            sourceSystemProductId?: string;
+            /**
+             * Format: date-time
+             * @description product created time
+             * @example 2019-03-27T14:59:57.000Z
+             */
+            "createdTime<sup>DEPRECATED</sup>"?: string;
+            /**
+             * Format: date-time
+             * @description product modified time
+             * @example 2019-03-27T14:59:57.000Z
+             */
+            "modifiedTime<sup>DEPRECATED</sup>"?: string;
+        };
+        Link: {
+            /**
+             * @description The type of the link.
+             * @example Link
+             */
+            "@type"?: string;
+            /**
+             * @description The identifier for the associated resource. If the resource is embeddable, this is also the "embed" value.
+             * @example self
+             */
+            rel?: string;
+            /**
+             * Format: uri
+             * @description The location of the resource
+             * @example api_route
+             */
+            uri?: string;
+        };
+        CollectionBase: {
+            /** @description Provides a reference to an associated object or list. */
+            links?: components["schemas"]["Link"][];
+            /**
+             * Format: int32
+             * @example 100
+             */
+            total?: number;
+        };
+        ReferenceVarietyCollection: components["schemas"]["CollectionBase"] & {
+            values?: components["schemas"]["ReferenceVariety"][];
+        };
+        OverrideKeyValuePair: {
+            /**
+             * @description Key for override parameter when setting overrides for a reference product
+             * @example archived
+             * @enum {string}
+             */
+            key: "archived";
+            /**
+             * @description Value for override parameter, can be string, number or boolean
+             * @example true
+             */
+            value: Record<string, never>;
+        };
+        CommonProductPointerRequest: {
+            overrides?: components["schemas"]["OverrideKeyValuePair"][] | null;
+        };
+        ReferenceProductPointerRequest: {
+            /**
+             * @description Country of the product to which it belongs.
+             * @example USA
+             */
+            countryCode?: string;
+        } & components["schemas"]["CommonProductPointerRequest"];
+        VarietyCollection: components["schemas"]["CollectionBase"] & {
+            values?: components["schemas"]["Variety"][];
+        };
+        ReferenceProductOverrideStatus: {
+            /**
+             * @description Key for override parameter when setting overrides for a reference product
+             * @example archived
+             * @enum {string}
+             */
+            key?: "archived";
+            /**
+             * @description Whether or not the override was successfully applied
+             * @example true
+             */
+            success?: boolean;
+            errors?: components["schemas"]["Errors"];
+        };
+        PutVariety: {
+            /** @example Variety */
+            "@type"?: unknown;
+            /**
+             * @description The common name of the variety.
+             * @example S73-Z5 - 50lb bag
+             */
+            name: string;
+            /**
+             * @description The identifier of the crop type that this variety is associated with (see the Crop Types API). **NOTE:** See /cropTypes for the list of available crop types that are supported.
+             * @example SOYBEANS
+             */
+            cropName: string;
+            /**
+             * @description The brand of the variety.
+             * @example NK
+             */
+            companyName: string;
+            /**
+             * @example VARIETY
+             * @enum {string}
+             */
+            category?: "VARIETY";
+            /**
+             * @description Whether or not this product is actively used in your organization. A value of true will hide the variety from display in your organization.
+             * @example false
+             */
+            archived?: boolean;
+            /**
+             * Format: date-time
+             * @description product created time
+             * @example 2019-03-27T14:59:57.000Z
+             */
+            "createdTime<sup>DEPRECATED</sup>"?: string;
+            /**
+             * Format: date-time
+             * @description product modified time
+             * @example 2019-03-27T14:59:57.000Z
+             */
+            "modifiedTime<sup>DEPRECATED</sup>"?: string;
+        };
+        VarietyIdUpdate: {
+            /**
+             * @description The common name of the variety.
+             * @example RL8288HB
+             */
+            name?: string;
+            /**
+             * @description The name of the input manufacturer.
+             * @example AgVenture
+             */
+            companyName?: string;
+            /**
+             * @description The identifier of the crop type that this variety is associated with.
+             * @example CORN_WET
+             */
+            cropName?: string;
+            /**
+             * @description Whether or not this product is actively used. Defaults to false.
+             * @example false
+             */
+            archived?: boolean;
+        };
+        ChildVariety: components["schemas"]["BaseResource"] & {
+            /** @example Variety */
+            "@type"?: unknown;
+            /**
+             * Format: uuid
+             * @description The primary identifier for the variety that is unique to your organization.
+             * @example 87b4a1e7-210b-482c-8a7a-19e9f644e914
+             */
+            id?: string;
+            /**
+             * @description The common name of the variety.
+             * @example S73-Z5 - 50lb bag
+             */
+            name?: string;
+            /**
+             * @example VARIETY
+             * @enum {string}
+             */
+            category?: "VARIETY";
+            /**
+             * @description The identifier of the crop type that this variety is associated with (see the Crop Types API).
+             * @example SOYBEANS
+             */
+            cropName?: string;
+            /**
+             * @description The brand of the variety.
+             * @example NK
+             */
+            companyName?: string;
+            /**
+             * @description Whether or not this product is actively used in your organization. A value of true will hide the variety from display in your organization.
+             * @example false
+             */
+            archived?: boolean;
+            /**
+             * Format: date-time
+             * @description product created time
+             * @example 2017-03-21T21:12:53.865Z
+             */
+            "createdTime<sup>DEPRECATED</sup>"?: string;
+            /**
+             * Format: date-time
+             * @description product modified time
+             * @example 2018-04-06T15:12:52.910Z
+             */
+            readonly "modifiedTime<sup>DEPRECATED</sup>"?: string;
+            /**
+             * @description Country of the product to which it belongs
+             * @example USA
+             */
+            countryCode?: string;
+            /**
+             * @description Parent id of the child in which the product is merged
+             * @example b0241592-c95a-4a8b-a2f9-3e58168ac291
+             */
+            parentErid?: string;
+            /**
+             * @description Showing the status of cleanup.
+             * @example MERGED
+             */
+            cleanupStatus?: string;
+            /**
+             * @description Clean up action time
+             * @example 2025-09-22T11:24:43.855Z
+             */
+            cleanupActionDate?: string;
+            /** @description List of documents for the variety. For example, Tech Sheet, SDS Label. */
+            documentsList?: components["schemas"]["Document"][];
+        };
+        Variety: components["schemas"]["BaseResource"] & {
+            /** @example Variety */
+            "@type"?: unknown;
+            /**
+             * Format: uuid
+             * @description The primary identifier for the variety that is unique to your organization.
+             * @example 87b4a1e7-210b-482c-8a7a-19e9f644e914
+             */
+            id?: string;
+            /**
+             * @description The common name of the variety.
+             * @example S73-Z5 - 50lb bag
+             */
+            name?: string;
+            /**
+             * @example VARIETY
+             * @enum {string}
+             */
+            category?: "VARIETY";
+            /**
+             * @description The identifier of the crop type that this variety is associated with (see the Crop Types API).
+             * @example SOYBEANS
+             */
+            cropName?: string;
+            /**
+             * @description The brand of the variety.
+             * @example NK
+             */
+            companyName?: string;
+            /**
+             * @description Whether or not this product is actively used in your organization. A value of true will hide the variety from display in your organization.
+             * @example false
+             */
+            archived?: boolean;
+            /**
+             * Format: uuid
+             * @description Optional. Denotes whether this product is from the global reference list.
+             * @example 87b4a1e7-210b-482c-8a7a-19e9f644e914
+             */
+            referenceGuid?: string;
+            /**
+             * Format: uuid
+             * @description product id of the reference variety
+             * @example 87b4a1e7-210b-482c-8a7a-19e9f644e914
+             */
+            "referenceId<sup>DEPRECATED</sup>"?: string;
+            /**
+             * Format: date-time
+             * @description product created time
+             * @example 2017-03-21T21:12:53.865Z
+             */
+            "createdTime<sup>DEPRECATED</sup>"?: string;
+            /**
+             * Format: date-time
+             * @description product modified time
+             * @example 2018-04-06T15:12:52.910Z
+             */
+            readonly "modifiedTime<sup>DEPRECATED</sup>"?: string;
+            /**
+             * @description Country of the product to which it belongs
+             * @example USA
+             */
+            countryCode?: string;
+            /**
+             * @description Parent id of the child in which the product is merged
+             * @example b0241592-c95a-4a8b-a2f9-3e58168ac291
+             */
+            parentErid?: string;
+            /**
+             * @description Showing the status of cleanup.
+             * @example MERGED
+             */
+            cleanupStatus?: string;
+            /**
+             * @description Clean up action time
+             * @example 2025-09-22T11:24:43.855Z
+             */
+            cleanupActionDate?: string;
+            /** @description List of documents for the variety. For example, Tech Sheet, SDS Label. */
+            documentsList?: components["schemas"]["Document"][];
+            /** @description List of child products. */
+            childProducts?: components["schemas"]["ChildVariety"][];
+        };
+        /** Format: Errors/DataValidationException */
+        Errors: {
+            /** @example Errors */
+            "@type"?: string;
+            errors?: {
+                /** @example Error */
+                "@type"?: string;
+                /**
+                 * Format: uuid
+                 * @example 9b331708-10e8-4e15-8097-a9aed7455d6d
+                 */
+                guid?: string;
+                /**
+                 * @description An english description of the error.
+                 * @example The given crop type does not exist
+                 */
+                message?: string;
+                /**
+                 * @description A string constant representing the type of error.
+                 * @example validation_constraint_crop_type_does_not_exist
+                 */
+                code?: string;
+                /**
+                 * @description The name of the property or parameter deemed invalid.
+                 * @example targetCrops
+                 */
+                field?: string;
+                /**
+                 * @description The value that was supplied for this field in the request.
+                 * @example CORN_WET
+                 */
+                invalidValue?: string;
+            }[];
+            /** @example {} */
+            otherAttributes?: Record<string, never>;
+        };
+        PostVariety: {
+            /** @example Variety */
+            "@type"?: unknown;
+            /**
+             * @description The common name of the variety.
+             * @example S73-Z5 - 50lb bag
+             */
+            name: string;
+            /**
+             * @description The identifier of the crop type that this variety is associated with (see the Crop Types API).
+             * @example SOYBEANS
+             */
+            cropName: string;
+            /**
+             * @description The brand of the variety.
+             * @example NK
+             */
+            companyName: string;
+            /**
+             * @example VARIETY
+             * @enum {string}
+             */
+            category?: "VARIETY";
+            /**
+             * @description Whether or not this product is actively used in your organization. A value of true will hide the variety from display in your organization.
+             * @example false
+             */
+            archived?: boolean;
+            /**
+             * Format: date-time
+             * @description product created time
+             * @example 2017-03-21T21:12:53.865Z
+             */
+            "createdTime<sup>DEPRECATED</sup>"?: string;
+            /**
+             * Format: date-time
+             * @description product modified time
+             * @example 2018-04-06T15:12:52.910Z
+             */
+            "modifiedTime<sup>DEPRECATED</sup>"?: string;
+        };
+        VarietyCreate: {
+            /**
+             * @description The common name of the variety.
+             * @example 2C788A SXRA COR
+             */
+            name?: string;
+            /**
+             * @description The name of the input manufacturer.
+             * @example MYCOGEN SEEDS
+             */
+            companyName?: string;
+            /**
+             * @description The identifier of the crop type that this variety is associated with.
+             * @example CORN_WET
+             */
+            cropName?: string;
+            /**
+             * @description Whether or not this product is actively used.
+             * @example false
+             */
+            archived?: boolean;
+            /**
+             * @description The identifier of the associated reference variety, if applicable. This is optional, but helps to capture product lineage and improve consistency across organizations.
+             * @example 1a63a1fe-b00f-403f-81f7-c157e0234cc4
+             */
+            referenceId?: string;
+        };
+    };
+    responses: {
+        /** @description Created */
+        Created: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+    };
+    parameters: {
+        /** @description An embeddable list of properties which are optional by default. */
+        VarietyEmbed: "documents" | "showMergedProducts";
+        /** @description Filters the list based on archive status. Accepted values are ARCHIVED, AVAILABLE, and ALL. The default behavior is to return only available (non-archived) varieties. */
+        ArchiveStatus: "AVAILABLE" | "ARCHIVED" | "ALL";
+        /** @description The identifier of the Organization. */
+        OrganizationID: number;
+        /** @description The organization owning the varieties. */
+        OrgId: number;
+        /** @description Filter results based on status */
+        RecordFilter: string;
+        /** @description Embeds extra information in the org varieties response */
+        Embed: string;
+        /** @description Embeds extra information in the variety response */
+        Embed2: string;
+        /** @description x-deere-signature should be managed by the client per user per API. For a new user/new API, the first request will have a blank value for x-deere-signature. Changes can be tracked with the x-deere-signature returned in the response. If the response has not changed since the last API call, the value of x-deere-signature is not changed and the client should use the same String Token next time. */
+        "X-deere-signature": string;
+        /** @description The variety Id to find. */
+        VarietyId: string;
+        /** @description The variety Id */
+        VarietyId2: string;
+        /**
+         * @description A unique identifier for an entity formatted as a uuid.
+         * @example cf09acfc-9196-4dbb-9b38-1be02673c5ff
+         */
+        ERID: string;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export type operations = Record<string, never>;
+//# sourceMappingURL=products.d.ts.map