deere-sdk 0.1.0

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

@@ -0,0 +1,2599 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/equipment": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get equipment
+         * @description This resource allows the client to view the list of a user's equipment. It can be called with a filter for specific organizations, machine or implement types, but can also be called without a filter to provide a list of all equipment accessible by the user across each organization the user has access to. Equipment will only be returned from organizations the user has access to and are connected to the calling application. If the client requests multiple organizations in the filter, and a user or the client does not have access to that organization, the entire response will be a 403 Forbidden. Please see the OAuth 2 documentation <a  href='#oAuth2' target='_blank'>here</a> for more details on obtaining a user token and connecting the user’s organizations to your application..
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description List of OrganizationEquipment Ids (these ids are unique across all orgs) */
+                    ids?: components["parameters"]["OrganizationEquipmentIds"];
+                    /** @description List of serial numbers of the equipment */
+                    serialNumbers?: components["parameters"]["EquipmentSerialNumbers"];
+                    /** @description List of OrganizationIds */
+                    organizationIds?: components["parameters"]["OrganizationIds"];
+                    /** @description List of PrincipalIds */
+                    principalIds?: components["parameters"]["PrincipalIds"];
+                    capableOf?: components["parameters"]["CapableOf"];
+                    categories?: components["parameters"]["Categories"];
+                    "organizationRole.type"?: components["parameters"]["Role"];
+                    /** @description true or false */
+                    archived?: components["parameters"]["Archived"];
+                    /** @description embed 'pairingDetails' is only supported along with 'devices' or 'equipment' embeds */
+                    embed?: components["parameters"]["EmbedForList"];
+                    /**
+                     * @description Refers to starting record value
+                     * @example 200
+                     */
+                    pageOffset?: components["parameters"]["PageOffset"];
+                    /**
+                     * @description Refers to number of items per page(default 100 max 5000)
+                     * @example 200
+                     */
+                    itemLimit?: components["parameters"]["ItemLimit"];
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Equipment(s) found based on the query parameters and filters. */
+                200: components["responses"]["GetEquipment"];
+                /** @description Bad Request - No query parameters provided. */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Errors"];
+                    };
+                };
+                /**
+                 * @description Authorization Error
+                 *     - user/applications does not have access to api or resource
+                 *     or
+                 *     - user does not have required permissions/BusinessActivities for the org.
+                 */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/organizations/{organizationId}/equipment": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create equipment
+         * @description This resource allows the client to create a piece of equipment within a user’s organization. <br><br> <b>Getting Started</b><br>The process of contributing equipment to John Deere can be broken down into three primary steps. <ol> <li> Determine the Equipment’s model IDs</li> <li> Create the Equipment</li> <li> Contribute Measurements. Please see the <a  href='/dev-docs/equipment-measurement' target='_blank'>Equipment Measurements (POST) API</a> for more information on uploading measurements for the created equipment.</li> </ol> <b>Determining the Equipment’s model</b> <ol> <li> Call the GET /equipmentMakes API endpoint to get a list of all equipment makes and a respective “id” of the equipment make you require.</li> <li> Call the GET /equipmentMakes/{id}/equipmentISGTypes endpoint to get a list of associated equipment ISG types for that specific equipment make and obtain a respective “id” for a specific ISG type you require.</li> <li> Call the GET /equipmentMakes/{id}/equipmentISGTypes/{id}/equipmentModels to obtain the final “id” of the equipment model you require.</li> <li> Alternatively, you may call the GET /equipmentModels endpoint if you know the model name you are searching for. For example /equipmentModels?equipmentModelName=9RX*&embed=make,isgType which will include all models with search string results and include make and isgType “id” as well as model “id”.</li> </ol> <b>Creating the Equipment</b><br/> Make a POST request to the /organizations/{orgId}/equipment API to create the piece of equipment in the user’s org. <ul> <li>In this request you will provide the type of the equipment, a serialNumber  (optional), name (displayed to the user in Operations Center), and the equipment model IDs.</li> <ul> <li><b>type:</b> Machine or Implement</li> <li><b>serialNumber:</b> A string identifier that is 30 characters or fewer. Must be unique within an organization.</li> <li><b>name:</b> The name displayed in Operation Center, 30 characters or fewer. Must be unique within an organization.</li> <li><b>model:</b> The id for the Model of the vehicle, found from the API in the previous step of this document. </li> </ul> <li> A successful POST will result in a 201 Created response. The “location” header in the response will contain the URI to the new equipment, with the final segment being the organization specific machine ID (ie “https://equipmentapi.deere.com/isg/equipment/12345” is a link to the machine 12345).</li> <li>If you attempt to create a machine with a serialNumber that already exists in that organization, you get a response code 400 Bad Request. The body will include the error information.</li> </ul>
+         */
+        post: operations["createEquipment"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/equipment/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * View equipment details by Id
+         * @description This resource allows the client to view the details of one piece of equipment.
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description embed 'pairingDetails' is only supported along with 'devices' or 'equipment' embeds */
+                    embed?: components["parameters"]["Embed"];
+                };
+                header?: never;
+                path: {
+                    /** @example 1111 */
+                    id: components["parameters"]["id"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Equipment found by Id or Serial Number */
+                200: components["responses"]["GetEquipmentById"];
+                /**
+                 * @description Authorization Error
+                 *     - user/applications does not have access to api or resource
+                 *     or
+                 *     - user does not have required permissions/BusinessActivities for the org.
+                 */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Equipment not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        /**
+         * Update equipment
+         * @description This resource allows the client to update a piece of equipment within a user’s organization. Clients will only be able to update a piece of equipment that was contributed via the POST /equipment API. John Deere controlled equipment can only be managed via the Equipment application in Operations Center.
+         */
+        put: operations["putEquipment"];
+        post?: never;
+        /**
+         * Delete equipment
+         * @description This resource allows the client to delete a piece of equipment within a user’s organization. Clients will only be able to delete a piece of equipment that was contributed via the POST /equipment API. John Deere controlled equipment can only be managed via the Equipment application in Operations Center.
+         */
+        delete: operations["deleteEquipment"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/equipmentMakes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get equipment makes
+         * @description This resource allows the client to view equipment makes and their associated IDs and names.
+         */
+        get: operations["getEquipmentMakes"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/equipmentMakes/{equipmentMakeId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * View equipment by make Id
+         * @description This resource allows the client to view equipment makes by an equipment make ID.
+         */
+        get: operations["getEquipmentMakesById"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/equipmentMakes/{equipmentMakeId}/equipmentTypes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get equipment types by make id
+         * @deprecated
+         * @description This resource allows the client to view equipment types by providing an equipment make ID.
+         */
+        get: operations["getEquipmentTypesByMakeId"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/equipmentTypes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get equipment types
+         * @deprecated
+         * @description This resource allows the client to view equipment types and their associated IDs and names.
+         */
+        get: operations["getEquipmentTypes"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/equipmentModels": {
+        parameters: {
+            query?: {
+                /**
+                 * @description Embed additional attributes if required.
+                 * @example [
+                 *       "make",
+                 *       "type"
+                 *     ]
+                 */
+                embed?: components["parameters"]["EmbedV1"];
+                /**
+                 * @description It should be equipment model name
+                 * @example [
+                 *       "9RX420",
+                 *       "9RX*"
+                 *     ]
+                 */
+                equipmentModelName?: components["parameters"]["EquipmentModelName"];
+            };
+            header?: never;
+            path: {
+                /** @description Deprecated value should be false */
+                deprecated: components["parameters"]["Deprecated"];
+            };
+            cookie?: never;
+        };
+        /**
+         * Get equipment models
+         * @description This resource allows the client to view equipment models in our reference database and their associated IDs and names.
+         */
+        get: operations["getEquipmentModels"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/equipmentISGTypes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get equipment ISG types
+         * @description This operation retrieves a list of Equipment ISG Types based on the supplied query parameters.
+         */
+        get: operations["getEquipmentISGTypes"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/equipmentMakes/{equipmentMakeId}/equipmentISGTypes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get equipment ISG types by make id
+         * @description This operation retrieves a list of Equipment ISG Types for given makeId. <br/>
+         */
+        get: operations["getEquipmentISGTypesByMakeId"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/equipmentMakes/{equipmentMakeId}/equipmentISGTypes/{equipmentISGTypeId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get equipment ISG type by make id and ISG type id
+         * @description This operation retrieves a single Equipment ISG Type for given makeId and isgTypeId.. <br/>
+         */
+        get: operations["getEquipmentISGTypeByMakeIdAndISGTypeId"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/equipmentMakes/{equipmentMakeId}/equipmentISGTypes/{equipmentISGTypeId}/equipmentModels": {
+        parameters: {
+            query?: {
+                /** @description Whether to filter isg types by the deprecated flag */
+                deprecated?: components["parameters"]["deprecated"];
+                /**
+                 * @description The organization ids to get Equipment Models for.
+                 *     If provided, then only non-certified models will be returned.
+                 *     If not provided, then only certified models will be returned.
+                 */
+                organizationIds?: components["parameters"]["organizationIds"];
+            };
+            header?: never;
+            path: {
+                /** @description ID for Equipment Make */
+                equipmentMakeId: components["parameters"]["EquipmentMakeId"];
+                /** @description ID for Equipment ISG Type */
+                equipmentISGTypeId: components["parameters"]["EquipmentISGTypeId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * Get equipment models by make id and ISG type id
+         * @description This operation retrieves a list of Equipment Models based on given makeId and ISGtypeId.
+         */
+        get: operations["getEquipmentModelsByMakeIdAndISGTypeId"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/equipmentMakes/{equipmentMakeId}/equipmentISGTypes/{equipmentISGTypeId}/equipmentModels/{equipmentModelId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description ID for Equipment Make */
+                equipmentMakeId: components["parameters"]["EquipmentMakeId"];
+                /** @description ID for Equipment ISG Type */
+                equipmentISGTypeId: components["parameters"]["EquipmentISGTypeId"];
+                /** @description ID for Equipment Model */
+                equipmentModelId: components["parameters"]["EquipmentModelId"];
+            };
+            cookie?: never;
+        };
+        /**
+         * Get equipment model by make id, ISG type id and model id
+         * @description This operation retrieves a single Equipment Model based on given makeId, isgTypeId and modelId.
+         */
+        get: operations["getEquipmentModelsByMakeIdAndISGTypeIdAndModelId"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        Error: {
+            /**
+             * @description An english description of the error
+             * @example <parameter> was invalid because <reason>
+             */
+            message?: string;
+            /**
+             * @description A string constant representing the type of error
+             * @example 400
+             */
+            code?: string;
+            /**
+             * @description The name of the property or parameter deemed invalid
+             * @example Machine.serialNumber
+             */
+            field?: string;
+            /**
+             * Format: uuid
+             * @description A reference to this encounter of the error, for traceability and troubleshooting
+             * @example 9b331708-10e8-4e15-8097-a9aed7455d6d
+             */
+            gud?: string;
+            /**
+             * @description The value that was supplied for this field in the request
+             * @example null
+             */
+            invalidValue?: string;
+        };
+        Errors: components["schemas"]["Error"][];
+        /** Link */
+        link: {
+            /** @example nextPage */
+            rel?: string;
+            /**
+             * @description This will be the relative URL. Users will prefix the base url as per their requirements.
+             * @example /equipment?pageOffset=10&itemSize=10
+             */
+            uri?: string;
+        };
+        /**
+         * EquipmentIsgType
+         * @description Represents the ISG type of equipment, including its name, unique identifier, category, deprecation status, and metadata.
+         * @example {
+         *       "name": "Tractor",
+         *       "ERID": "82115264-9385-460c-bfbe-177a59445fd9",
+         *       "category": "Machine",
+         *       "allowsCustomModel": true,
+         *       "isgMarketSegment": "Agriculture",
+         *       "deprecated": false,
+         *       "recordMetaData": {
+         *         "createdBy": "user123",
+         *         "createdAt": "2023-10-01T12:00:00Z",
+         *         "updatedBy": "user456",
+         *         "updatedAt": "2023-10-02T12:00:00Z"
+         *       }
+         *     }
+         */
+        "equipment-isg-type": {
+            "@type": "equipment-isg-type";
+        } & (Omit<components["schemas"]["resource"], "@type"> & {
+            /**
+             * @description The name of the ISG equipment type.
+             * @example Tractor
+             */
+            name?: string;
+            /**
+             * @description Unique identifier for the ISG equipment type.
+             * @example 82115264-9385-460c-bfbe-177a59445fd9
+             */
+            ERID?: string;
+            /**
+             * @description The category of the ISG equipment type.
+             * @example Machine
+             * @enum {string}
+             */
+            category?: "Machine" | "Implement" | "Unknown";
+            /**
+             * @description Indicates if the equipment ISG type allows custom models.
+             * @example true
+             */
+            allowsCustomModel?: boolean;
+            /**
+             * @description The ISG market segment of the equipment ISG type.
+             * @example Agriculture
+             * @enum {string}
+             */
+            isgMarketSegment?: "Unknown" | "Agriculture" | "Construction" | "Engines & Components" | "Forestry" | "Turf";
+            /**
+             * @description Indicates if the ISG equipment type is deprecated.
+             * @example false
+             */
+            deprecated?: boolean;
+        });
+        /**
+         * @description Data structure for record metadata capturing information about the creation and last update of an entity.
+         *     For more information on Record Metadata visit [this confluence page](https://confluence.deere.com/x/eSGLDg).
+         *     NOTES
+         *     * Some attributes are only visible if the API Client has the required license.
+         *     * Attributes dealing with modification will be null if the entity has been created but not modified. (Some legacy data may have set the create and modify timestamp at time of creation.)
+         */
+        RecordMetadata: {
+            /**
+             * @default RecordMetadata
+             * @example RecordMetadata
+             */
+            "@type": string;
+            /**
+             * @description User involved in creating the entity.  Only viewable with the RECORD_METADATA license
+             * @example XYZ_USER
+             */
+            createdByUser?: string;
+            /**
+             * @description User involved in modifying the entity.  Only viewable with the RECORD_METADATA license
+             * @example XYZ_USER
+             */
+            lastModifiedByUser?: string;
+            /**
+             * @description Timestamp of entity creation
+             * @example 2018-04-30T10:23:50.000Z
+             */
+            readonly userCreationTimestamp?: string;
+            /**
+             * @description Timestamp of entity modification
+             * @example 2018-05-01T08:11:23.000Z
+             */
+            readonly userLastModifiedTimestamp?: string;
+            /**
+             * Format: uuid
+             * @description This is the specific instance of an application that created the entity.  At this time, it only applies
+             *     to Displays.  Only viewable with the RECORD_METADATA license.
+             * @example 0235d40e-02d0-44cb-a126-fff21173fc1f
+             */
+            readonly createdBySourceNode?: string;
+            /**
+             * Format: uuid
+             * @description This is the specific instance of an application that modified the entity.  At this time, it only applies
+             *     to Displays.  Only viewable with the RECORD_METADATA license
+             * @example 0235d40e-02d0-44cb-a126-fff21173fc1f
+             */
+            readonly lastModifiedSourceNode?: string;
+            /**
+             * @description Derived off of a client key (application that created) via Application Registry lookup. The
+             *     Application Registry ID for the Ops Center Unknown Application (43796410-2f2c-4321-a259-8dd8af04e973)
+             *     will be used if no source application exists. Only viewable with the RECORD_METADATA license.
+             * @example https://api.deere.com/platform/connectedApplications/63bb4efd-0ec5-47d3-9092-7693909134f5
+             */
+            readonly createdBySourceSystemUri?: string;
+            /**
+             * @description Derived off of a client key (application that did last modification) via Application Registry lookup. The
+             *     Application Registry ID for the Ops Center Unknown Application (43796410-2f2c-4321-a259-8dd8af04e973)
+             *     will be used if no source application exists. Only viewable with the RECORD_METADATA license.
+             * @example https://api.deere.com/platform/connectedApplications/63bb4efd-0ec5-47d3-9092-7693909134f5
+             */
+            readonly lastModifiedBySourceSystemUri?: string;
+        };
+        /** Resource */
+        resourcewithoutLinks: {
+            /**
+             * @description Unique id
+             * @example 363997 | fcdc83cb-8840-4215-84b5-1769889db932
+             */
+            id?: string;
+            /**
+             * @description Equipment | Machine | Implement | EquipmentType | EquipmentMake | EquipmentModel | Organization | TheftRecord | DecommissionRecord | WarrantyInformation | DeviceParameter | Other
+             * @example Equipment | Machine | Implement | EquipmentType | EquipmentMake | EquipmentModel | Organization | TheftRecord | DecommissionRecord | WarrantyInformation | DeviceParameter | Other
+             */
+            "@type"?: string;
+        };
+        /** Resource */
+        resource: {
+            links?: components["schemas"]["link"][];
+            /**
+             * @description Unique id
+             * @example 363997 | fcdc83cb-8840-4215-84b5-1769889db932
+             */
+            id?: string;
+            /**
+             * @description Equipment | Machine | Implement | MachineCharacteristics | ImplementCharacteristics | EquipmentType | EquipmentMake | EquipmentModel | Organization | TheftRecord | DecommissionRecord | WarrantyInformation | DeviceParameter | Other
+             * @example Equipment | Machine | Implement | MachineCharacteristics | ImplementCharacteristics | EquipmentType | EquipmentMake | EquipmentModel | Organization | TheftRecord | DecommissionRecord | WarrantyInformation | DeviceParameter | Other
+             */
+            "@type"?: string;
+        };
+        /** Resource */
+        "resource-embed": {
+            /**
+             * @description Unique id
+             * @example 363997 | fcdc83cb-8840-4215-84b5-1769889db932
+             */
+            id?: string;
+            /**
+             * @description Equipment | Machine | Implement | EquipmentType | EquipmentMake | EquipmentModel | Organization | TheftRecord | DecommissionRecord | WarrantyInformation | DeviceParameter | Other
+             * @example Equipment | Machine | Implement | EquipmentType | EquipmentMake | EquipmentModel | Organization | TheftRecord | DecommissionRecord | WarrantyInformation | DeviceParameter | Other
+             */
+            "@type"?: string;
+        };
+        /** Resource */
+        "organization-embed": {
+            /**
+             * @description Unique id
+             * @example 363997 | fcdc83cb-8840-4215-84b5-1769889db932
+             */
+            id?: string;
+            /**
+             * @description Resource
+             * @example Resource
+             */
+            "@type"?: string;
+        };
+        /**
+         * EquipmentMake
+         * @description Represents the make of the equipment, including its name, unique identifier, and metadata.
+         */
+        "equipment-make-embed": {
+            /**
+             * @description EquipmentMake
+             * @example EquipmentMake
+             */
+            "@type"?: string;
+            /**
+             * @description Unique identifier for the equipment make.
+             * @example 1
+             */
+            id?: string;
+            /**
+             * @description The name of the equipment make.
+             * @example JOHN DEERE
+             */
+            name?: string;
+            /**
+             * @description Unique identifier for the equipment make.
+             * @example db18bdc4-025a-11eb-97e4-0e8d658c7ba3
+             */
+            ERID?: string;
+            /**
+             * @description Indicates if the equipment make is certified.
+             * @example true
+             */
+            certified?: boolean;
+            /**
+             * @description Indicates if the equipment make is deereOrSubsidiary.
+             * @example true
+             */
+            deereOrSubsidiary?: boolean;
+        };
+        /**
+         * EquipmentMake
+         * @description Represents the make of the equipment, including its name, unique identifier, and metadata.
+         * @example {
+         *       "id": 1,
+         *       "name": "JOHN DEERE",
+         *       "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3",
+         *       "certified": true,
+         *       "deereOrSubsidiary": true,
+         *       "deprecated": false,
+         *       "recordMetaData": {
+         *         "createdBy": "user123",
+         *         "createdAt": "2023-10-01T12:00:00Z",
+         *         "updatedBy": "user456",
+         *         "updatedAt": "2023-10-02T12:00:00Z"
+         *       }
+         *     }
+         */
+        "equipment-make": {
+            "@type": "equipment-make";
+        } & (Omit<components["schemas"]["resource"], "@type"> & {
+            /**
+             * @description The name of the equipment make.
+             * @example JOHN DEERE
+             */
+            name?: string;
+            /**
+             * @description Unique identifier for the equipment make.
+             * @example db18bdc4-025a-11eb-97e4-0e8d658c7ba3
+             */
+            ERID?: string;
+            /**
+             * @description Indicates if the equipment make is certified.
+             * @example true
+             */
+            certified?: boolean;
+            /**
+             * @description Indicates if the equipment make is deereOrSubsidiary.
+             * @example true
+             */
+            deereOrSubsidiary?: boolean;
+            /**
+             * @description Indicates if the equipment make is deprecated.
+             * @example false
+             */
+            deprecated?: boolean;
+        });
+        /**
+         * EquipmentType
+         * @deprecated
+         * @description Represents the type of equipment, including its name, unique identifier, category, certification status, market segment, icon, deprecation status, and metadata.
+         * @example {
+         *       "id": 217,
+         *       "name": "Two-wheel Drive Tractors - 140 Hp And Above",
+         *       "ERID": "82115264-9385-460c-bfbe-177a59445fd9",
+         *       "category": "Machine",
+         *       "certified": true,
+         *       "marketSegment": "Agriculture",
+         *       "icon": {
+         *         "url": "https://example.com/icon.png",
+         *         "description": "Icon representing the equipment type"
+         *       },
+         *       "deprecated": false,
+         *       "allowsCustomModel": true,
+         *       "recordMetaData": {
+         *         "createdBy": "user123",
+         *         "createdAt": "2023-10-01T12:00:00Z",
+         *         "updatedBy": "user456",
+         *         "updatedAt": "2023-10-02T12:00:00Z"
+         *       }
+         *     }
+         */
+        "equipment-type": {
+            "@type": "equipment-type";
+        } & (Omit<components["schemas"]["resource"], "@type"> & {
+            /**
+             * @description The name of the equipment type.
+             * @example Two-wheel Drive Tractors - 140 Hp And Above
+             */
+            name?: string;
+            /**
+             * @description Unique identifier for the equipment type.
+             * @example 82115264-9385-460c-bfbe-177a59445fd9
+             */
+            ERID?: string;
+            /**
+             * @description The category of the equipment type.
+             * @example Machine
+             * @enum {string}
+             */
+            category?: "Machine" | "Implement" | "Unknown";
+            /**
+             * @description Indicates if the equipment type is certified.
+             * @example true
+             */
+            certified?: boolean;
+            /**
+             * @description Indicates if the equipment type allows custom models.
+             * @example true
+             */
+            allowsCustomModel?: boolean;
+            /**
+             * @description The market segment of the equipment type.
+             * @example Agriculture
+             * @enum {string}
+             */
+            marketSegment?: "Unknown" | "Agriculture" | "Commercial Worksite Products" | "Construction" | "Engines & Components" | "Forestry" | "Mining" | "Turf";
+            icon?: components["schemas"]["equipment-icon"];
+            /**
+             * @description Indicates if the equipment type is deprecated.
+             * @example false
+             */
+            deprecated?: boolean;
+        });
+        /**
+         * EquipmentType
+         * @description Represents the type of equipment, including its name, unique identifier, category, certification status, market segment, icon, deprecation status, and metadata.
+         */
+        "equipment-type-embed": {
+            /**
+             * @description EquipmentType
+             * @example EquipmentType
+             */
+            "@type"?: string;
+            /**
+             * @description Unique identifier for the equipment type.
+             * @example 222
+             */
+            id?: string;
+            /**
+             * @description The name of the equipment type.
+             * @example Combine
+             */
+            name?: string;
+            /**
+             * @description Unique identifier for the equipment type.
+             * @example 80619ff7-11fa-11ee-bb58-0e5cd6a962d7
+             */
+            ERID?: string;
+        };
+        /**
+         * IconStyle
+         * @description icon style
+         */
+        "icon-style": {
+            /** @description primary color of the icon style */
+            primaryColor?: string;
+            /** @description secondary color of the icon style */
+            secondaryColor?: string;
+        };
+        /** EquipmentIcon */
+        "equipment-icon": {
+            "@type": "equipment-icon";
+        } & (Omit<components["schemas"]["resource"], "@type"> & {
+            /**
+             * @description The name of the equipment icon.
+             * @example JOHN DEERE
+             */
+            name?: string;
+            iconStyle?: components["schemas"]["icon-style"];
+        });
+        /** EquipmentModel */
+        "equipment-model-details": {
+            /** @example 8360R */
+            name?: string;
+            /** @example 158df9ff-334a-4e0d-86cc-3adca17a9686 */
+            ERID?: string;
+            /** @enum {string} */
+            category?: "Machine" | "Implement" | "Unknown";
+            make?: components["schemas"]["equipment-make-embed"];
+            type?: components["schemas"]["equipment-type-embed"];
+            icon?: components["schemas"]["equipment-icon"];
+        };
+        /**
+         * EquipmentISGType
+         * @description Represents the ISG type of equipment, including its name, unique identifier, category, deprecation status, and metadata.
+         */
+        "equipment-isg-type-embed": {
+            /**
+             * @description EquipmentISGType
+             * @example EquipmentISGType
+             */
+            "@type"?: string;
+            /**
+             * @description Unique identifier for the ISG equipment type.
+             * @example 2
+             */
+            id?: string;
+            /**
+             * @description The name of the ISG equipment type.
+             * @example Combine
+             */
+            name?: string;
+            /**
+             * @description Unique identifier for the ISG equipment type.
+             * @example d8dce5b0-cc8d-4c34-afac-27d93793bd86
+             */
+            ERID?: string;
+        };
+        /**
+         * EquipmentModel
+         * @description Represents the model of the equipment, including its name, unique identifier, category, certification status, make, type, ISG type, icon, deprecation status, and metadata.
+         * @example {
+         *       "name": "8360R",
+         *       "ERID": "158df9ff-334a-4e0d-86cc-3adca17a9686",
+         *       "category": "Machine",
+         *       "deprecated": false,
+         *       "certified": false,
+         *       "make": {
+         *         "name": "JOHN DEERE",
+         *         "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3",
+         *         "deprecated": false,
+         *         "recordMetaData": {
+         *           "createdBy": "user123",
+         *           "createdAt": "2023-10-01T12:00:00Z",
+         *           "updatedBy": "user456",
+         *           "updatedAt": "2023-10-02T12:00:00Z"
+         *         }
+         *       },
+         *       "type": {
+         *         "name": "Two-wheel Drive Tractors - 140 Hp And Above",
+         *         "ERID": "82115264-9385-460c-bfbe-177a59445fd9",
+         *         "category": "Machine",
+         *         "certified": true,
+         *         "marketSegment": "Agriculture",
+         *         "icon": {
+         *           "url": "https://example.com/icon.png",
+         *           "description": "Icon representing the equipment type"
+         *         },
+         *         "deprecated": false,
+         *         "recordMetaData": {
+         *           "createdBy": "user123",
+         *           "createdAt": "2023-10-01T12:00:00Z",
+         *           "updatedBy": "user456",
+         *           "updatedAt": "2023-10-02T12:00:00Z"
+         *         }
+         *       },
+         *       "isgType": {
+         *         "name": "Tractor",
+         *         "ERID": "82115264-9385-460c-bfbe-177a59445fd9",
+         *         "category": "Machine",
+         *         "deprecated": false,
+         *         "recordMetaData": {
+         *           "createdBy": "user123",
+         *           "createdAt": "2023-10-01T12:00:00Z",
+         *           "updatedBy": "user456",
+         *           "updatedAt": "2023-10-02T12:00:00Z"
+         *         }
+         *       },
+         *       "icon": {
+         *         "url": "https://example.com/icon.png",
+         *         "description": "Icon representing the equipment model"
+         *       },
+         *       "recordMetaData": {
+         *         "createdBy": "user123",
+         *         "createdAt": "2023-10-01T12:00:00Z",
+         *         "updatedBy": "user456",
+         *         "updatedAt": "2023-10-02T12:00:00Z"
+         *       }
+         *     }
+         */
+        "equipment-model": {
+            "@type": "equipment-model";
+        } & (Omit<components["schemas"]["resource"], "@type"> & {
+            /**
+             * @description The name of the equipment model.
+             * @example 8360R
+             */
+            name?: string;
+            /**
+             * @description Unique identifier for the equipment model.
+             * @example 158df9ff-334a-4e0d-86cc-3adca17a9686
+             */
+            ERID?: string;
+            /**
+             * @description The category of the equipment model.
+             * @example Machine
+             * @enum {string}
+             */
+            category?: "Machine" | "Implement" | "Unknown";
+            /**
+             * @description Indicates if the equipment model is deprecated.
+             * @example false
+             */
+            deprecated?: boolean;
+            /**
+             * @description Indicates if the equipment model is certified.
+             * @example false
+             */
+            certified?: boolean;
+            make?: components["schemas"]["equipment-make"];
+            type?: components["schemas"]["equipment-type"];
+            isgType?: components["schemas"]["equipment-isg-type"];
+        });
+        /**
+         * EquipmentModel
+         * @description Represents the model of the equipment, including its name, unique identifier, category, certification status, make, type, ISG type, icon, deprecation status, and metadata.
+         */
+        "equipment-model-embed": {
+            /**
+             * @description EquipmentModel
+             * @example EquipmentModel
+             */
+            "@type"?: string;
+            /**
+             * @description Unique identifier for the equipment model.
+             * @example 65985
+             */
+            id?: string;
+            /**
+             * @description The name of the equipment model.
+             * @example S680
+             */
+            name?: string;
+            /**
+             * @description Unique identifier for the equipment model.
+             * @example f2e7d596-35c6-11e7-af34-123e49453e98
+             */
+            ERID?: string;
+            /**
+             * @description Indicates if the equipment model is certified.
+             * @example true
+             */
+            certified?: boolean;
+        };
+        /**
+         * EquipmentModel
+         * @description Represents the model of the equipment, including its name, unique identifier, category, certification status, make, type, ISG type, icon, deprecation status, and metadata.
+         * @example {
+         *       "name": "8360R",
+         *       "ERID": "158df9ff-334a-4e0d-86cc-3adca17a9686",
+         *       "category": "Machine",
+         *       "certified": false
+         *     }
+         */
+        "equipment-model-no-embed": {
+            "@type": "equipment-model-no-embed";
+        } & (Omit<components["schemas"]["resource"], "@type"> & {
+            /**
+             * @description The name of the equipment model.
+             * @example 8360R
+             */
+            name?: string;
+            /**
+             * @description Unique identifier for the equipment model.
+             * @example 158df9ff-334a-4e0d-86cc-3adca17a9686
+             */
+            ERID?: string;
+            /**
+             * @description The category of the equipment model.
+             * @example Machine
+             * @enum {string}
+             */
+            category?: "Machine" | "Implement" | "Unknown";
+            /**
+             * @description Indicates if the equipment model is certified.
+             * @example false
+             */
+            certified?: boolean;
+        });
+        /**
+         * Identifier of Equipment
+         * @description Identifier of the Equipment like DE-13, DE-17, ERID...
+         */
+        identifier: Record<string, never> & {
+            /**
+             * @description Type of identifier.
+             * @enum {string}
+             */
+            type: "serialNumber" | "ERID";
+            /**
+             * @description Value of identifier.
+             * @example RW8360R055358
+             */
+            value: string;
+        };
+        /**
+         * OrganizationRole
+         * @description Represents the role of an organization, including its type, effective timestamp, and event.
+         * @example {
+         *       "type": "Controlling",
+         *       "effectiveTS": "2023-10-01T12:00:00Z",
+         *       "event": "CREATION"
+         *     }
+         */
+        "organization-role": {
+            /**
+             * @description The type of the organization role.
+             * @example Controlling
+             * @enum {string}
+             */
+            type?: "Controlling" | "NonControlling";
+            /**
+             * Format: date-time
+             * @description The timestamp when the role becomes effective.
+             * @example 2023-10-01T12:00:00Z
+             */
+            effectiveTS?: string;
+            /**
+             * @description The event associated with the organization role.
+             * @example CREATION
+             * @enum {string}
+             */
+            event?: "CREATION" | "TRANSFER" | "SUBSCRIPTION" | "PAIRING" | "ORDER" | "COMMANDED" | "DECOMMISSION";
+            /** @example true */
+            inPossession?: boolean;
+        };
+        /** AbstractMeasurement */
+        abstractMeasurement: {
+            type?: string;
+            unit?: string;
+        };
+        /**
+         * MeasurementAsDouble
+         * @description measurement as double
+         */
+        measurementAsDouble: components["schemas"]["abstractMeasurement"] & {
+            /** @description type of measurement */
+            type?: string;
+            /** @description unit of measurement */
+            unit?: string;
+            /**
+             * Format: double
+             * @description measurement value as double
+             */
+            valueAsDouble?: number;
+        };
+        /** VariableRepresentationValue */
+        variableRepresentationValue: {
+            variable?: components["schemas"]["measurementAsDouble"];
+        };
+        /**
+         * MeasurementAsString
+         * @description measurement as string
+         */
+        measurementAsString: components["schemas"]["abstractMeasurement"] & {
+            /** @description type of measurement */
+            type?: string;
+            /** @description unit of measurement */
+            unit?: string;
+            /** @description measurement value as string */
+            valueAsString?: string;
+        };
+        /** DefinedTypeRepresentationValue */
+        definedTypeRepresentationValue: {
+            value?: components["schemas"]["measurementAsString"];
+        };
+        /**
+         * Offsets
+         * @description Represents the offsets of a device, including its variable and defined type representation values.
+         */
+        offsets: {
+            "@type": "offsets";
+        } & (Omit<components["schemas"]["resource-embed"], "@type"> & {
+            /**
+             * @description Offsets
+             * @example Offsets
+             * @enum {string}
+             */
+            "@type"?: "Offsets";
+            variableRepresentationValues?: components["schemas"]["variableRepresentationValue"][];
+            definedTypeRepresentationValues?: components["schemas"]["definedTypeRepresentationValue"][];
+        });
+        /**
+         * DeviceMake
+         * @description Represents the make of a device, including its name and unique identifier (ERID).
+         * @example {
+         *       "name": "JOHN DEERE",
+         *       "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3"
+         *     }
+         */
+        "device-make": {
+            "@type": "device-make";
+        } & (Omit<components["schemas"]["resource-embed"], "@type"> & {
+            /**
+             * @description DeviceMake
+             * @example DeviceMake
+             * @enum {string}
+             */
+            "@type"?: "DeviceMake";
+            /**
+             * @description The name of the device make.
+             * @example JOHN DEERE
+             */
+            name?: string;
+            /**
+             * @description Unique identifier of the device make.
+             * @example db18bdc4-025a-11eb-97e4-0e8d658c7ba3
+             */
+            ERID?: string;
+        });
+        /**
+         * DeviceType
+         * @description Represents the type of a device, including its name, common name, and unique identifier (ERID).
+         * @example {
+         *       "name": "Modem",
+         *       "commonName": "TelematicsGateway",
+         *       "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3"
+         *     }
+         */
+        "device-type": {
+            "@type": "device-type";
+        } & (Omit<components["schemas"]["resource-embed"], "@type"> & {
+            /**
+             * @description DeviceType
+             * @example DeviceType
+             * @enum {string}
+             */
+            "@type"?: "DeviceType";
+            /**
+             * @description The name of the device type.
+             * @example Modem
+             */
+            name?: string;
+            /**
+             * @description The common name of the device type.
+             * @example TelematicsGateway
+             */
+            commonName?: string;
+            /**
+             * @description Unique identifier of the device type.
+             * @example db18bdc4-025a-11eb-97e4-0e8d658c7ba3
+             */
+            ERID?: string;
+        });
+        /**
+         * DeviceModel
+         * @description Represents the model of a device, including its name, unique identifier (ERID), make, and type.
+         * @example {
+         *       "name": "JDLink Modem-4G",
+         *       "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3",
+         *       "make": {
+         *         "name": "JOHN DEERE",
+         *         "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3"
+         *       },
+         *       "type": {
+         *         "name": "Modem",
+         *         "commonName": "TelematicsGateway",
+         *         "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c7ba3"
+         *       }
+         *     }
+         */
+        "device-model": {
+            "@type": "device-model";
+        } & (Omit<components["schemas"]["resource-embed"], "@type"> & {
+            /**
+             * @description DeviceModel
+             * @example DeviceModel
+             * @enum {string}
+             */
+            "@type"?: "DeviceModel";
+            /**
+             * @description The name of the device model.
+             * @example JDLink Modem-4G
+             */
+            name?: string;
+            /**
+             * @description Unique identifier of the device model.
+             * @example db18bdc4-025a-11eb-97e4-0e8d658c7ba3
+             */
+            ERID?: string;
+            make?: components["schemas"]["device-make"];
+            type?: components["schemas"]["device-type"];
+        });
+        /**
+         * Version
+         * @description Represents the version of a device or software, including its name.
+         * @example {
+         *       "name": "3.16.1171"
+         *     }
+         */
+        version: {
+            "@type": "version";
+        } & (Omit<components["schemas"]["resource-embed"], "@type"> & {
+            /**
+             * @description Version
+             * @example Version
+             * @enum {string}
+             */
+            "@type"?: "Version";
+            /**
+             * @description The name of the version.
+             * @example 3.16.1171
+             */
+            name?: string;
+        });
+        /** InabilityDetail */
+        "inability-detail": {
+            "@type": "inability-detail";
+        } & (Omit<components["schemas"]["resource"], "@type"> & {
+            /** @example RC14.8.1 */
+            code?: string;
+            /** @example REGISTRATION */
+            type?: string;
+            /** @example SIM registration is required */
+            description?: string;
+        });
+        /**
+         * Capability
+         * @description List of capabilities of the equipment.
+         */
+        capability: {
+            "@type": "capability";
+        } & (Omit<components["schemas"]["resource-embed"], "@type"> & {
+            /**
+             * @description Capability
+             * @example Capability
+             * @enum {string}
+             */
+            "@type"?: "Capability";
+            capable?: boolean;
+            /** @enum {string} */
+            type?: "JDLINK_CONNECTIVITY" | "RDA" | "WDT" | "WIFI_CONNECTIVITY" | "CUSTOMER_SIM_CONNECTIVITY" | "LEGACY_CONNECTIVITY" | "PLANNED_WORK" | "DATA_SYNC_SETUP" | "CH_REMOTE_ADJUST" | "BASE_STATION" | "MY_MACHINE" | "RDC" | "REMOTE_START";
+            inabilityDetails?: components["schemas"]["inability-detail"][];
+        });
+        /**
+         * Equipment
+         * @description Represents the equipment, including its name, serial number, model year, make, type, ISG type, model, organization, telematics capability, and various other attributes.
+         */
+        equipmentForList: {
+            "@type": "equipmentForList";
+        } & (Omit<components["schemas"]["resource"], "@type"> & {
+            /**
+             * @description Equipment | Machine | Implement
+             * @example Equipment
+             * @enum {string}
+             */
+            "@type"?: "Equipment" | "Machine" | "Implement";
+            /**
+             * @description Equipment Name.
+             * @example Cates 8360R 055358
+             */
+            name?: string;
+            /**
+             * @description Unique 64-bit ISO NAME used to identify the controller during address claim.
+             * @example b00082000422ed1d
+             */
+            isoName?: string;
+            /**
+             * @description Serial Number of the Equipment and passed on the query parameter
+             * @example 1RW8360RLCD055358
+             */
+            serialNumber?: string;
+            /**
+             * @description VIN or PIN, more than Serial Number, of the Engine.
+             * @example RG6090L839275
+             */
+            engineSerialNumber?: string;
+            /**
+             * @description True if this is an official equipment (we have PI information about it).
+             * @example true
+             */
+            isSerialNumberCertified?: boolean;
+            /**
+             * @description Year of model.
+             * @example 2019
+             */
+            modelYear?: string;
+            make?: components["schemas"]["equipment-make-embed"];
+            type?: components["schemas"]["equipment-type-embed"];
+            isgType?: components["schemas"]["equipment-isg-type-embed"];
+            model?: components["schemas"]["equipment-model-embed"];
+            organization?: components["schemas"]["organization-embed"];
+            /**
+             * @description Indicates if the equipment is capable of telematics.
+             * @example true
+             */
+            telematicsCapable?: boolean;
+            /**
+             * @description Indicates if the equipment is archived.
+             * @example true
+             */
+            archived?: boolean;
+            /**
+             * @description Unique id for principal equipment
+             * @example 12345
+             */
+            principalId?: string;
+            organizationRole?: components["schemas"]["organization-role"];
+            /**
+             * @description Unique identifier of the Equipment.
+             * @example fcdc83cb-8840-4215-84b5-1769889db932
+             */
+            ERID?: string;
+            /** @description List of alternate identifiers of the Equipment like DE-13, DE-17, ERID... */
+            alternateIdentifiers?: components["schemas"]["identifier"][];
+            icon?: components["schemas"]["equipment-icon"];
+            /** @description List of devices paired with the equipment. */
+            devices?: components["schemas"]["device"][];
+            pairingDetails?: components["schemas"]["pairing-details"];
+            /**
+             * Format: date-time
+             * @description Timestamp when the equipment was archived.
+             * @example 2021-03-10T19:19:46.420Z
+             */
+            archivedTimestamp?: string;
+            /** @description List of equipment that was merged. */
+            mergedEquipment?: components["schemas"]["machine"][];
+            /**
+             * @description Indicates if the equipment is CSC equipment or not.
+             * @example true
+             */
+            isCsc?: boolean;
+        });
+        /**
+         * Equipment
+         * @description Represents the equipment, including its name, serial number, model year, make, type, ISG type, model, organization, telematics capability, and various other attributes.
+         */
+        equipment: {
+            "@type": "equipment";
+        } & (Omit<components["schemas"]["resource"], "@type"> & {
+            /**
+             * @description Equipment | Machine | Implement
+             * @example Equipment
+             * @enum {string}
+             */
+            "@type"?: "Equipment" | "Machine" | "Implement";
+            /**
+             * @description Equipment Name.
+             * @example Cates 8360R 055358
+             */
+            name?: string;
+            /**
+             * @description Unique 64-bit ISO NAME used to identify the controller during address claim.
+             * @example b00082000422ed1d
+             */
+            isoName?: string;
+            /**
+             * @description Serial Number of the Equipment and passed on the query parameter
+             * @example 1RW8360RLCD055358
+             */
+            serialNumber?: string;
+            /**
+             * @description VIN or PIN, more than Serial Number, of the Engine.
+             * @example RG6090L839275
+             */
+            engineSerialNumber?: string;
+            /**
+             * @description True if this is an official equipment (we have PI information about it).
+             * @example true
+             */
+            isSerialNumberCertified?: boolean;
+            /**
+             * @description Year of model.
+             * @example 2019
+             */
+            modelYear?: string;
+            make?: components["schemas"]["equipment-make-embed"];
+            type?: components["schemas"]["equipment-type-embed"];
+            isgType?: components["schemas"]["equipment-isg-type-embed"];
+            model?: components["schemas"]["equipment-model-embed"];
+            organization?: components["schemas"]["organization-embed"];
+            /**
+             * @description Indicates if the equipment is capable of telematics.
+             * @example true
+             */
+            telematicsCapable?: boolean;
+            /**
+             * @description Indicates if the equipment is archived.
+             * @example true
+             */
+            archived?: boolean;
+            /**
+             * @description Unique id for principal equipment
+             * @example 12345
+             */
+            principalId?: string;
+            organizationRole?: components["schemas"]["organization-role"];
+            /**
+             * @description Unique identifier of the Equipment.
+             * @example fcdc83cb-8840-4215-84b5-1769889db932
+             */
+            ERID?: string;
+            /** @description List of alternate identifiers of the Equipment like DE-13, DE-17, ERID... */
+            alternateIdentifiers?: components["schemas"]["identifier"][];
+            icon?: components["schemas"]["equipment-icon"];
+            offsets?: components["schemas"]["offsets"];
+            /** @description List of devices paired with the equipment. */
+            devices?: components["schemas"]["device"][];
+            /** @description List of capabilities of the equipment. */
+            capabilities?: components["schemas"]["capability"][];
+            pairingDetails?: components["schemas"]["pairing-details"];
+            /**
+             * Format: date-time
+             * @description Timestamp when the equipment was archived.
+             * @example 2021-03-10T19:19:46.420Z
+             */
+            archivedTimestamp?: string;
+            /** @description List of equipment that was merged. */
+            mergedEquipment?: components["schemas"]["machine"][];
+            /**
+             * @description Indicates if the equipment is CSC equipment or not.
+             * @example true
+             */
+            isCsc?: boolean;
+        });
+        /** Point */
+        point: {
+            /** Format: double */
+            lat?: number;
+            /** Format: double */
+            lon?: number;
+            /** Format: double */
+            slope?: number;
+        };
+        /**
+         * PairingDetails
+         * @description Represents the details of the pairing process, including timestamps and location.
+         * @example {
+         *       "paired": true,
+         *       "associationTimestamp": "2023-10-01T12:00:00Z",
+         *       "disassociationTimestamp": "2023-10-02T12:00:00Z",
+         *       "confirmationTimestamp": "2023-10-01T12:30:00Z",
+         *       "location": {
+         *         "latitude": 40.712776,
+         *         "longitude": -74.005974
+         *       }
+         *     }
+         */
+        "pairing-details": {
+            /**
+             * @description Indicates if the equipment is paired.
+             * @example true
+             */
+            paired?: boolean;
+            /**
+             * Format: date-time
+             * @description The timestamp when the equipment was paired.
+             * @example 2023-10-01T12:00:00Z
+             */
+            associationTimestamp?: string;
+            /**
+             * Format: date-time
+             * @description The timestamp when the equipment was un-paired.
+             * @example 2023-10-02T12:00:00Z
+             */
+            disassociationTimestamp?: string;
+            /**
+             * Format: date-time
+             * @description The timestamp when the pairing was confirmed.
+             * @example 2023-10-01T12:30:00Z
+             */
+            confirmationTimestamp?: string;
+            location?: components["schemas"]["point"];
+        };
+        /**
+         * Device
+         * @description Represents a device, including its serial number, certification status, make, type, model, organization, and other attributes.
+         * @example {
+         *       "@type": "Device",
+         *       "serialNumber": "PCMA4GF511111",
+         *       "make": {
+         *         "name": "JOHN DEERE",
+         *         "id": "1",
+         *         "ERID": "f8b43e74-3088-4a38-9d66-30aae1ed1111"
+         *       },
+         *       "type": {
+         *         "name": "Modem",
+         *         "commonName": "TelematicsGateway",
+         *         "id": "1",
+         *         "ERID": "d469a324-2036-11ee-bb58-0e5cd6a91111"
+         *       },
+         *       "model": {
+         *         "name": "JDLink Modem-4G",
+         *         "id": "3",
+         *         "ERID": "f413bba6-9f39-410c-866f-c800bf701111"
+         *       },
+         *       "firmwareVersion": {
+         *         "name": "40.02.049"
+         *       },
+         *       "organization": {
+         *         "id": "21111"
+         *       },
+         *       "organizationRole": {
+         *         "type": "Controlling",
+         *         "effectiveTS": "2024-04-30T17:53:57Z",
+         *         "event": "PAIRING"
+         *       },
+         *       "archived": false,
+         *       "decommissioned": false,
+         *       "stolen": false,
+         *       "principalId": "911111",
+         *       "equipment": {
+         *         "name": "Cattle 9700 SPFH",
+         *         "serialNumber": "1Z09700YAKU621111",
+         *         "isSerialNumberCertified": true,
+         *         "modelYear": "2019",
+         *         "make": {
+         *           "name": "JOHN DEERE",
+         *           "certified": true,
+         *           "deereOrSubsidiary": true,
+         *           "id": "1",
+         *           "ERID": "db18bdc4-025a-11eb-97e4-0e8d658c1111"
+         *         },
+         *         "type": {
+         *           "name": "Forage Harvester",
+         *           "id": "162",
+         *           "ERID": "34b07db5-11fb-11ee-8580-0ed5f7261111"
+         *         },
+         *         "isgType": {
+         *           "name": "Forage Harvester",
+         *           "id": "6",
+         *           "ERID": "99edf0e0-4abb-42d3-9798-327439a31111"
+         *         },
+         *         "model": {
+         *           "name": 9700,
+         *           "certified": true,
+         *           "id": "581111",
+         *           "ERID": "2c8c951e-070a-4e1c-824d-72cca6e71111"
+         *         },
+         *         "principalId": "661111",
+         *         "archived": false,
+         *         "organization": {
+         *           "id": "22967"
+         *         },
+         *         "organizationRole": {
+         *           "type": "Controlling",
+         *           "effectiveTS": "2024-04-30T17:53:56.695Z",
+         *           "event": "PAIRING"
+         *         },
+         *         "isCsc": false,
+         *         "id": "661111",
+         *         "ERID": "23fe3ea0-1f95-4ae6-8e12-968729cd1111"
+         *       },
+         *       "capabilities": [
+         *         {
+         *           "type": "JDLINK_CONNECTIVITY",
+         *           "capable": true
+         *         },
+         *         {
+         *           "type": "WIFI_CONNECTIVITY",
+         *           "capable": true
+         *         }
+         *       ],
+         *       "pairingDetails": {
+         *         "paired": true,
+         *         "associationTimestamp": "2024-09-28T17:30:24Z",
+         *         "disassociationTimestamp": null,
+         *         "confirmationTimestamp": "2024-10-23T22:17:22Z",
+         *         "location": {
+         *           "lat": 52.780639,
+         *           "lon": -122.453222,
+         *           "slope": null
+         *         }
+         *       },
+         *       "messagesRestricted": false,
+         *       "pairingStatus": "PAIRED",
+         *       "orderNumber": "961111",
+         *       "highFidelityConfigurationVersion": {
+         *         "name": "1Hz_L3X40FT4JDPS0x00_ISG_X8X9SPFH_63978_2024.008.001"
+         *       },
+         *       "genericConfigurationVersion": {
+         *         "name": "1623F1EF-62C2-4B8B-B5EA-A0FFD6EA76F8"
+         *       },
+         *       "communicationModules": [
+         *         {
+         *           "imei": "014642005101111",
+         *           "imsi": "310170835961111",
+         *           "iccid": "89011704278359691111",
+         *           "type": "GSM",
+         *           "serviceProvider": "Jasper",
+         *           "state": "Active",
+         *           "id": "632111"
+         *         }
+         *       ],
+         *       "id": "915111",
+         *       "ERID": "fb537c94-14f1-11ef-871b-1287bcef1111"
+         *     }
+         */
+        device: {
+            "@type": "device";
+        } & (Omit<components["schemas"]["resource-embed"], "@type"> & {
+            /**
+             * @description Device | Display | PositionReceiver | TelematicsGateway
+             * @example Device
+             * @enum {string}
+             */
+            "@type"?: "Device" | "Display" | "PositionReceiver" | "TelematicsGateway";
+            /**
+             * @description Serial number of the device and passed on the query parameter
+             * @example PCS171B372381
+             */
+            serialNumber?: string;
+            /**
+             * @description True if this is an official device (we have PI information about it).
+             * @example true
+             */
+            isSerialNumberCertified?: boolean;
+            make?: components["schemas"]["device-make"];
+            type?: components["schemas"]["device-type"];
+            model?: components["schemas"]["device-model"];
+            organization?: components["schemas"]["organization-embed"];
+            /**
+             * @description Unique identifier of the Device.
+             * @example fcdc83cb-8840-4215-84b5-1769889db932
+             */
+            ERID?: string;
+            firmwareVersion?: components["schemas"]["version"];
+            capabilities?: components["schemas"]["capability"][];
+            equipment?: components["schemas"]["equipment"];
+            /**
+             * @description Indicates if the device is archived.
+             * @example true
+             */
+            archived?: boolean;
+            /**
+             * @description Indicates if the device is decommissioned.
+             * @example false
+             */
+            decommissioned?: boolean;
+            /**
+             * @description Indicates if the device is stolen.
+             * @example false
+             */
+            stolen?: boolean;
+            /**
+             * @description Unique id for principal device
+             * @example 12345
+             */
+            principalId?: string;
+            organizationRole?: components["schemas"]["organization-role"];
+            /**
+             * @description Order number associated with the device.
+             * @example 987654321
+             */
+            orderNumber?: string;
+            pairingDetails?: components["schemas"]["pairing-details"];
+            /**
+             * Format: date-time
+             * @description Timestamp when the device was archived.
+             * @example 2021-03-10T19:19:46.420Z
+             */
+            archivedTimestamp?: string;
+        });
+        /** Display */
+        display: {
+            "@type": "display";
+        } & (Omit<components["schemas"]["device"], "@type"> & {
+            /**
+             * @description Display
+             * @example Display
+             * @enum {string}
+             */
+            "@type"?: "Display";
+            monitors?: components["schemas"]["display-monitors"][];
+        });
+        /** Monitor */
+        "display-monitors": {
+            "@type": "display-monitors";
+        } & (Omit<components["schemas"]["resource-embed"], "@type"> & {
+            /**
+             * @description Monitor
+             * @example Monitor
+             * @enum {string}
+             */
+            "@type"?: "Monitor";
+            /** @example Monitor_0 */
+            type?: string;
+            /** @example PCG410A015392 */
+            serialNumber?: string;
+            /** @example 800 */
+            resolutionWidth?: number;
+            /** @example 600 */
+            resolutionHeight?: number;
+        });
+        /** PositionReceiver */
+        "position-receiver": {
+            "@type": "position-receiver";
+        } & (Omit<components["schemas"]["device"], "@type"> & Record<string, never>);
+        /**
+         * CommunicationModule
+         * @description Represents a communication module, including its serial number, IMEI, IMSI, ICCID, MSISDN, EID, type, service provider, state, and country calling code.
+         * @example {
+         *       "serialNumber": "PCS171B372381",
+         *       "imei": 123456789012345,
+         *       "imsi": 310150123456789,
+         *       "iccid": 89014103211118510000,
+         *       "msisdn": 15555551234,
+         *       "eid": 89014103211118510000,
+         *       "type": "GSM",
+         *       "serviceProvider": "ATT",
+         *       "state": "ACTIVE",
+         *       "countryCallingCode": 1
+         *     }
+         */
+        "communication-module": {
+            "@type": "communication-module";
+        } & (Omit<components["schemas"]["resource-embed"], "@type"> & {
+            /**
+             * @description CommunicationModule
+             * @example CommunicationModule
+             * @enum {string}
+             */
+            "@type"?: "CommunicationModule";
+            /**
+             * @description Serial number of the communication gateway
+             * @example PCS171B372381
+             */
+            serialNumber?: string;
+            /**
+             * @description International Mobile Equipment Identity of the communication module.
+             * @example 123456789012345
+             */
+            imei?: string;
+            /**
+             * @description International Mobile Subscriber Identity of the communication module.
+             * @example 310150123456789
+             */
+            imsi?: string;
+            /**
+             * @description Integrated Circuit Card Identifier of the communication module.
+             * @example 89014103211118510000
+             */
+            iccid?: string;
+            /**
+             * @description Mobile Station International Subscriber Directory Number of the communication module.
+             * @example 15555551234
+             */
+            msisdn?: string;
+            /**
+             * @description Embedded Identity Document of the communication module.
+             * @example 89014103211118510000
+             */
+            eid?: string;
+            /**
+             * @description Type of the communication module.
+             * @example GSM
+             * @enum {string}
+             */
+            type?: "GSM" | "SATELLITE" | "CDMA" | "COS";
+            /**
+             * @example ATT
+             * @enum {string}
+             */
+            serviceProvider?: "IRIDIUM" | "ATT" | "JASPER" | "VERIZON" | "COS" | "COST" | "CUBIC" | "ATTIOT";
+            /**
+             * @description Subscription state of the communication gateway
+             * @example ACTIVE
+             * @enum {string}
+             */
+            state?: "NEW" | "ACTIVE" | "INACTIVE" | "EXPIRED" | "PENDING_ACTIVE" | "PENDING_INACTIVE" | "PENDING_EXPIRED" | "PENDING_VERIFICATION" | "PENDING_WDT" | "TERMINATED";
+            /**
+             * @description Country calling code of the communication module.
+             * @example 1
+             */
+            countryCallingCode?: string;
+        });
+        /** TelematicsGateway */
+        "telematics-gateway": {
+            "@type": "telematics-gateway";
+        } & (Omit<components["schemas"]["device"], "@type"> & {
+            /** @enum {string} */
+            pairingStatus?: "PAIRED" | "PENDING_PAIRING";
+            orderNumber?: string;
+            highFidelityConfigurationVersion?: components["schemas"]["version"];
+            genericConfigurationVersion?: components["schemas"]["version"];
+            messagesRestricted?: boolean;
+            communicationModules?: components["schemas"]["communication-module"][];
+        });
+        /** Implement */
+        implement: {
+            "@type": "implement";
+        } & (Omit<components["schemas"]["equipment"], "@type"> & {
+            machine?: components["schemas"]["machine"];
+        });
+        /** Machine */
+        machine: {
+            "@type": "machine";
+        } & (Omit<components["schemas"]["equipment"], "@type"> & {
+            implements?: components["schemas"]["implement"][];
+        });
+        /** PatchDTO */
+        "equipment-patch": {
+            /** @enum {string} */
+            operation?: "UPDATE";
+            /** @enum {string} */
+            path?: "/organization" | "/archived" | "/organizationRole/type" | "/name";
+            /**
+             * @description - For transfer request : value={organizationId}
+             *     - For archive/unarchive request : value=true/false
+             *     - For role update request : value={Controlling}
+             *     - For name update request : value={name}
+             */
+            value?: string;
+        };
+        /** Equipment Creation */
+        createEquipment: {
+            /**
+             * @description Equipment Name.
+             * @example Cates 8360R 055358
+             */
+            name?: string;
+            /**
+             * @description Serial Number of the Equipment and passed on the query parameter
+             * @example Must be unique string. Max character count is 30.
+             */
+            serialNumber?: string;
+            /**
+             * Model of the equipment.
+             * @description Model of the equipment.
+             */
+            model?: {
+                /**
+                 * @description Unique id
+                 * @example 3 | 158df9ff-334a-4e0d-86cc-3adca17a9686
+                 */
+                id?: string;
+                /**
+                 * @description EquipmentModel
+                 * @example EquipmentModel
+                 */
+                "@type"?: string;
+            };
+        };
+    };
+    responses: {
+        /** @description A collection of Assets */
+        GetEquipment: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": {
+                    values?: unknown;
+                };
+            };
+        };
+        /** @description A collection of Assets */
+        GetEquipmentById: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": {
+                    values?: unknown;
+                };
+            };
+        };
+        /** @description Equipment Model Details by Equipment Make ID, Equipment Type ID and Equipment Model ID */
+        GetEquipmentModelByMakeIdAndTypeIdAndModelId: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": {
+                    values?: unknown;
+                };
+            };
+        };
+        /** @description Equipment Models */
+        GetEquipmentModelName: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": {
+                    values?: unknown;
+                };
+            };
+        };
+        /** @description Update Equipment */
+        UpdateEquipment: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": {
+                    /**
+                     * @description Unique id
+                     * @example 1 | fcdc83cb-8840-4215-84b5-1769889db932
+                     */
+                    id: string;
+                    /**
+                     * @description Equipment Name.
+                     * @example Cates 8360R 055358
+                     */
+                    name?: string;
+                    /**
+                     * @description Serial Number of the Equipment and passed on the query parameter
+                     * @example Must be unique string. Max character count is 30.
+                     */
+                    serialNumber?: string;
+                    /**
+                     * Make of the equipment.
+                     * @description Make of the equipment.
+                     */
+                    make?: {
+                        /**
+                         * @description Unique id
+                         * @example 1 | fcdc83cb-8840-4215-84b5-1769889db932
+                         */
+                        id?: string;
+                        /**
+                         * @description EquipmentMake
+                         * @example EquipmentMake
+                         */
+                        "@type"?: string;
+                    };
+                    /**
+                     * Type of the equipment.
+                     * @description Type of the equipment.
+                     */
+                    type?: {
+                        /**
+                         * @description Unique id
+                         * @example 2 | 82115264-9385-460c-bfbe-177a59445fd9
+                         */
+                        id?: string;
+                        /**
+                         * @description EquipmentType
+                         * @example EquipmentType
+                         */
+                        "@type"?: string;
+                    };
+                    /**
+                     * Model of the equipment.
+                     * @description Model of the equipment.
+                     */
+                    model?: {
+                        /**
+                         * @description Unique id
+                         * @example 3 | 158df9ff-334a-4e0d-86cc-3adca17a9686
+                         */
+                        id?: string;
+                        /**
+                         * @description EquipmentModel
+                         * @example EquipmentModel
+                         */
+                        "@type"?: string;
+                    };
+                    icon?: components["schemas"]["equipment-icon"];
+                };
+            };
+        };
+        /** @description A collection of Assets */
+        GetEquipmentMake: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": {
+                    values?: unknown;
+                };
+            };
+        };
+        /** @description A collection of Assets */
+        GetEquipmentByMakeId: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": Record<string, never>;
+            };
+        };
+        /** @description A collection of Assets */
+        GetEquipmentTypesByMakeId: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": Record<string, never>;
+            };
+        };
+        /** @description A collection of Assets */
+        GetEquipmentTypes: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": Record<string, never>;
+            };
+        };
+        /** @description A collection of Assets */
+        GetEquipmentTypeByEquipmentMakeIdAndEquipmentTypeId: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": {
+                    values?: unknown;
+                };
+            };
+        };
+        /** @description Create */
+        CreateEquip: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": Record<string, never>;
+            };
+        };
+        /** @description Update */
+        UpdatedEquip: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": Record<string, never>;
+            };
+        };
+    };
+    parameters: {
+        /** @description List of embed data for the Equipment ISG Type */
+        embed: "equipmentModels" | "recordMetadata";
+        /**
+         * @description Optional query parameter that controls which records are returned based on the record's deprecated flag:
+         *     parameter set to false:  Return only non-deprecated records
+         *     query parameter not present: both deprecated and non-deprecated records returned.
+         */
+        deprecatedForEquipmentModels: boolean;
+        /** @description Whether to filter isg types by the deprecated flag */
+        deprecated: false | true | "all";
+        /** @description Originating system of the request */
+        originator: string;
+        /** @description List of OrganizationEquipment Ids (these ids are unique across all orgs) */
+        OrganizationEquipmentIds: number[];
+        /** @description List of serial numbers of the equipment */
+        EquipmentSerialNumbers: string[];
+        /** @description List of OrganizationIds */
+        OrganizationIds: number[];
+        /** @description List of PrincipalIds */
+        PrincipalIds: number[];
+        /**
+         * @description Refers to starting record value
+         * @example 200
+         */
+        PageOffset: number;
+        /**
+         * @description Refers to number of items per page(default 100 max 5000)
+         * @example 200
+         */
+        ItemLimit: number;
+        /** @example 1111 */
+        id: number;
+        /** @example 1234, */
+        organizationId: number;
+        /**
+         * @description The organization ids to get Equipment Models for.
+         *     If provided, then only non-certified models will be returned.
+         *     If not provided, then only certified models will be returned.
+         */
+        organizationIds: number[];
+        /** @description embed 'pairingDetails' is only supported along with 'devices' or 'equipment' embeds */
+        EmbedForList: "devices" | "equipment" | "icon" | "pairingDetails";
+        /** @description embed 'pairingDetails' is only supported along with 'devices' or 'equipment' embeds */
+        Embed: "devices" | "equipment" | "pairingDetails" | "icon" | "offsets" | "capabilities";
+        Categories: "Machine" | "Implement";
+        CapableOf: "Connectivity" | "!Connectivity";
+        Role: "Controlling" | "NonControlling";
+        /** @description true or false */
+        Archived: boolean;
+        /** @example VIN1234 */
+        SerialNumber: string;
+        /** @description ID for Equipment Make */
+        EquipmentMakeId: number;
+        /** @description ID for Equipment ISG Type */
+        EquipmentISGTypeId: number;
+        /** @description Deprecated value should be false */
+        Deprecated: boolean;
+        /**
+         * @description Embed additional attributes if required.
+         * @example [
+         *       "make",
+         *       "type"
+         *     ]
+         */
+        EmbedV1: "make" | "type" | "isgType";
+        /**
+         * @description It should be equipment model name
+         * @example [
+         *       "9RX420",
+         *       "9RX*"
+         *     ]
+         */
+        EquipmentModelName: "string or partial string with * wildcard search";
+        /** @description ID for Equipment Type */
+        EquipmentTypeId: number;
+        /** @description ID for Equipment Model */
+        EquipmentModelId: number;
+        /** @description List of type categories for the Equipment Model */
+        category: "machine" | "implement";
+        /** @description Name for Equipment Type */
+        EquipmentTypeName: string;
+        /** @description Name for Equipment Make */
+        EquipmentMakeName: string;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    createEquipment: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @example 1234, */
+                organizationId: components["parameters"]["organizationId"];
+            };
+            cookie?: never;
+        };
+        /** @description Asset to be created. */
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["createEquipment"];
+            };
+        };
+        responses: {
+            /** @description Created */
+            201: components["responses"]["CreateEquip"];
+            /** @description Accepted */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Errors"];
+                };
+            };
+            /** @description User is not authorized for this request. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    putEquipment: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @example 1111 */
+                id: components["parameters"]["id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: components["responses"]["UpdateEquipment"];
+        responses: {
+            /** @description Patch Successful Updated Equipment */
+            200: components["responses"]["UpdatedEquip"];
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Errors"];
+                };
+            };
+            /** @description User is not authorized for this request. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    deleteEquipment: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @example 1111 */
+                id: components["parameters"]["id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Deleted */
+            200: components["responses"]["UpdatedEquip"];
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Errors"];
+                };
+            };
+            /** @description User is not authorized for this request. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    getEquipmentMakes: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Deprecated value should be false */
+                deprecated: components["parameters"]["Deprecated"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: components["responses"]["GetEquipmentMake"];
+            /** @description User is not authorized */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    getEquipmentMakesById: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description ID for Equipment Make */
+                equipmentMakeId: components["parameters"]["EquipmentMakeId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        links?: components["schemas"]["link"][];
+                        values?: components["schemas"]["equipment-make"][];
+                    };
+                };
+            };
+            /** @description User is not authorized */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Resource Not foundapi-makes */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    getEquipmentTypesByMakeId: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description ID for Equipment Make */
+                equipmentMakeId: components["parameters"]["EquipmentMakeId"];
+                /** @description Deprecated value should be false */
+                deprecated: components["parameters"]["Deprecated"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        links?: components["schemas"]["link"][];
+                        values?: components["schemas"]["equipment-type"][];
+                    };
+                };
+            };
+        };
+    };
+    getEquipmentTypes: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Deprecated value should be false */
+                deprecated: components["parameters"]["Deprecated"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        links?: components["schemas"]["link"][];
+                        values?: components["schemas"]["equipment-type"][];
+                    };
+                };
+            };
+        };
+    };
+    getEquipmentModels: {
+        parameters: {
+            query?: {
+                /**
+                 * @description Embed additional attributes if required.
+                 * @example [
+                 *       "make",
+                 *       "type"
+                 *     ]
+                 */
+                embed?: components["parameters"]["EmbedV1"];
+                /**
+                 * @description It should be equipment model name
+                 * @example [
+                 *       "9RX420",
+                 *       "9RX*"
+                 *     ]
+                 */
+                equipmentModelName?: components["parameters"]["EquipmentModelName"];
+            };
+            header?: never;
+            path: {
+                /** @description Deprecated value should be false */
+                deprecated: components["parameters"]["Deprecated"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: components["responses"]["GetEquipmentModelName"];
+        };
+    };
+    getEquipmentISGTypes: {
+        parameters: {
+            query?: {
+                /** @description List of type categories for the Equipment Model */
+                category?: components["parameters"]["category"];
+                /** @description Whether to filter isg types by the deprecated flag */
+                deprecated?: components["parameters"]["deprecated"];
+                /** @description List of embed data for the Equipment ISG Type */
+                embed?: components["parameters"]["embed"];
+            };
+            header?: {
+                /** @description Originating system of the request */
+                "X-Deere-Originator"?: components["parameters"]["originator"];
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        links?: components["schemas"]["link"][];
+                        values?: components["schemas"]["equipment-isg-type"][];
+                    };
+                };
+            };
+        };
+    };
+    getEquipmentISGTypesByMakeId: {
+        parameters: {
+            query?: {
+                /** @description Whether to filter isg types by the deprecated flag */
+                deprecated?: components["parameters"]["deprecated"];
+                /** @description List of embed data for the Equipment ISG Type */
+                embed?: components["parameters"]["embed"];
+            };
+            header?: never;
+            path: {
+                /** @description ID for Equipment Make */
+                equipmentMakeId: components["parameters"]["EquipmentMakeId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        links?: components["schemas"]["link"][];
+                        values?: components["schemas"]["equipment-isg-type"][];
+                    };
+                };
+            };
+        };
+    };
+    getEquipmentISGTypeByMakeIdAndISGTypeId: {
+        parameters: {
+            query?: {
+                /** @description List of embed data for the Equipment ISG Type */
+                embed?: components["parameters"]["embed"];
+            };
+            header?: never;
+            path: {
+                /** @description ID for Equipment Make */
+                equipmentMakeId: components["parameters"]["EquipmentMakeId"];
+                /** @description ID for Equipment ISG Type */
+                equipmentISGTypeId: components["parameters"]["EquipmentISGTypeId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["equipment-isg-type"];
+                };
+            };
+            /** @description Resource Not Found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    getEquipmentModelsByMakeIdAndISGTypeId: {
+        parameters: {
+            query?: {
+                /** @description Whether to filter isg types by the deprecated flag */
+                deprecated?: components["parameters"]["deprecated"];
+                /**
+                 * @description The organization ids to get Equipment Models for.
+                 *     If provided, then only non-certified models will be returned.
+                 *     If not provided, then only certified models will be returned.
+                 */
+                organizationIds?: components["parameters"]["organizationIds"];
+            };
+            header?: never;
+            path: {
+                /** @description ID for Equipment Make */
+                equipmentMakeId: components["parameters"]["EquipmentMakeId"];
+                /** @description ID for Equipment ISG Type */
+                equipmentISGTypeId: components["parameters"]["EquipmentISGTypeId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        links?: components["schemas"]["link"][];
+                        values?: components["schemas"]["equipment-model"][];
+                    };
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Errors"];
+                };
+            };
+            /** @description User/applications does not have the license assigned */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    getEquipmentModelsByMakeIdAndISGTypeIdAndModelId: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description ID for Equipment Make */
+                equipmentMakeId: components["parameters"]["EquipmentMakeId"];
+                /** @description ID for Equipment ISG Type */
+                equipmentISGTypeId: components["parameters"]["EquipmentISGTypeId"];
+                /** @description ID for Equipment Model */
+                equipmentModelId: components["parameters"]["EquipmentModelId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["equipment-model"];
+                };
+            };
+            /** @description User is not two-legged authorized */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+}
+//# sourceMappingURL=equipment.d.ts.map