deere-sdk 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (176) hide show
  1. package/CHANGELOG.md +38 -0
  2. package/LICENSE +21 -0
  3. package/README.md +253 -0
  4. package/dist/api/assets.d.ts +78 -0
  5. package/dist/api/assets.d.ts.map +1 -0
  6. package/dist/api/assets.js +115 -0
  7. package/dist/api/assets.js.map +1 -0
  8. package/dist/api/boundaries.d.ts +69 -0
  9. package/dist/api/boundaries.d.ts.map +1 -0
  10. package/dist/api/boundaries.js +102 -0
  11. package/dist/api/boundaries.js.map +1 -0
  12. package/dist/api/clients.d.ts +71 -0
  13. package/dist/api/clients.d.ts.map +1 -0
  14. package/dist/api/clients.js +104 -0
  15. package/dist/api/clients.js.map +1 -0
  16. package/dist/api/connection-management.d.ts +41 -0
  17. package/dist/api/connection-management.d.ts.map +1 -0
  18. package/dist/api/connection-management.js +56 -0
  19. package/dist/api/connection-management.js.map +1 -0
  20. package/dist/api/crop-types.d.ts +48 -0
  21. package/dist/api/crop-types.d.ts.map +1 -0
  22. package/dist/api/crop-types.js +69 -0
  23. package/dist/api/crop-types.js.map +1 -0
  24. package/dist/api/equipment.d.ts +138 -0
  25. package/dist/api/equipment.d.ts.map +1 -0
  26. package/dist/api/equipment.js +214 -0
  27. package/dist/api/equipment.js.map +1 -0
  28. package/dist/api/farms.d.ts +69 -0
  29. package/dist/api/farms.d.ts.map +1 -0
  30. package/dist/api/farms.js +100 -0
  31. package/dist/api/farms.js.map +1 -0
  32. package/dist/api/field-operations-api.d.ts +56 -0
  33. package/dist/api/field-operations-api.d.ts.map +1 -0
  34. package/dist/api/field-operations-api.js +88 -0
  35. package/dist/api/field-operations-api.js.map +1 -0
  36. package/dist/api/field-operations.d.ts +83 -0
  37. package/dist/api/field-operations.d.ts.map +1 -0
  38. package/dist/api/field-operations.js +134 -0
  39. package/dist/api/field-operations.js.map +1 -0
  40. package/dist/api/fields.d.ts +73 -0
  41. package/dist/api/fields.d.ts.map +1 -0
  42. package/dist/api/fields.js +113 -0
  43. package/dist/api/fields.js.map +1 -0
  44. package/dist/api/files.d.ts +63 -0
  45. package/dist/api/files.d.ts.map +1 -0
  46. package/dist/api/files.js +96 -0
  47. package/dist/api/files.js.map +1 -0
  48. package/dist/api/flags.d.ts +96 -0
  49. package/dist/api/flags.d.ts.map +1 -0
  50. package/dist/api/flags.js +159 -0
  51. package/dist/api/flags.js.map +1 -0
  52. package/dist/api/guidance-lines.d.ts +52 -0
  53. package/dist/api/guidance-lines.d.ts.map +1 -0
  54. package/dist/api/guidance-lines.js +77 -0
  55. package/dist/api/guidance-lines.js.map +1 -0
  56. package/dist/api/index.d.ts +43 -0
  57. package/dist/api/index.d.ts.map +1 -0
  58. package/dist/api/index.js +25 -0
  59. package/dist/api/index.js.map +1 -0
  60. package/dist/api/map-layers.d.ts +49 -0
  61. package/dist/api/map-layers.d.ts.map +1 -0
  62. package/dist/api/map-layers.js +69 -0
  63. package/dist/api/map-layers.js.map +1 -0
  64. package/dist/api/operators.d.ts +67 -0
  65. package/dist/api/operators.d.ts.map +1 -0
  66. package/dist/api/operators.js +99 -0
  67. package/dist/api/operators.js.map +1 -0
  68. package/dist/api/organizations.d.ts +45 -0
  69. package/dist/api/organizations.d.ts.map +1 -0
  70. package/dist/api/organizations.js +64 -0
  71. package/dist/api/organizations.js.map +1 -0
  72. package/dist/api/products.d.ts +88 -0
  73. package/dist/api/products.d.ts.map +1 -0
  74. package/dist/api/products.js +132 -0
  75. package/dist/api/products.js.map +1 -0
  76. package/dist/api/users.d.ts +22 -0
  77. package/dist/api/users.d.ts.map +1 -0
  78. package/dist/api/users.js +26 -0
  79. package/dist/api/users.js.map +1 -0
  80. package/dist/api/webhook.d.ts +42 -0
  81. package/dist/api/webhook.d.ts.map +1 -0
  82. package/dist/api/webhook.js +57 -0
  83. package/dist/api/webhook.js.map +1 -0
  84. package/dist/client.d.ts +114 -0
  85. package/dist/client.d.ts.map +1 -0
  86. package/dist/client.js +224 -0
  87. package/dist/client.js.map +1 -0
  88. package/dist/deere.d.ts +98 -0
  89. package/dist/deere.d.ts.map +1 -0
  90. package/dist/deere.js +120 -0
  91. package/dist/deere.js.map +1 -0
  92. package/dist/index.d.ts +36 -0
  93. package/dist/index.d.ts.map +1 -0
  94. package/dist/index.js +39 -0
  95. package/dist/index.js.map +1 -0
  96. package/dist/types/generated/assets.d.ts +839 -0
  97. package/dist/types/generated/assets.d.ts.map +1 -0
  98. package/dist/types/generated/assets.js +6 -0
  99. package/dist/types/generated/assets.js.map +1 -0
  100. package/dist/types/generated/boundaries.d.ts +734 -0
  101. package/dist/types/generated/boundaries.d.ts.map +1 -0
  102. package/dist/types/generated/boundaries.js +6 -0
  103. package/dist/types/generated/boundaries.js.map +1 -0
  104. package/dist/types/generated/clients.d.ts +602 -0
  105. package/dist/types/generated/clients.d.ts.map +1 -0
  106. package/dist/types/generated/clients.js +6 -0
  107. package/dist/types/generated/clients.js.map +1 -0
  108. package/dist/types/generated/connection-management.d.ts +210 -0
  109. package/dist/types/generated/connection-management.d.ts.map +1 -0
  110. package/dist/types/generated/connection-management.js +6 -0
  111. package/dist/types/generated/connection-management.js.map +1 -0
  112. package/dist/types/generated/crop-types.d.ts +541 -0
  113. package/dist/types/generated/crop-types.d.ts.map +1 -0
  114. package/dist/types/generated/crop-types.js +6 -0
  115. package/dist/types/generated/crop-types.js.map +1 -0
  116. package/dist/types/generated/equipment.d.ts +2599 -0
  117. package/dist/types/generated/equipment.d.ts.map +1 -0
  118. package/dist/types/generated/equipment.js +6 -0
  119. package/dist/types/generated/equipment.js.map +1 -0
  120. package/dist/types/generated/farms.d.ts +520 -0
  121. package/dist/types/generated/farms.d.ts.map +1 -0
  122. package/dist/types/generated/farms.js +6 -0
  123. package/dist/types/generated/farms.js.map +1 -0
  124. package/dist/types/generated/field-operations-api.d.ts +1724 -0
  125. package/dist/types/generated/field-operations-api.d.ts.map +1 -0
  126. package/dist/types/generated/field-operations-api.js +6 -0
  127. package/dist/types/generated/field-operations-api.js.map +1 -0
  128. package/dist/types/generated/fields.d.ts +904 -0
  129. package/dist/types/generated/fields.d.ts.map +1 -0
  130. package/dist/types/generated/fields.js +6 -0
  131. package/dist/types/generated/fields.js.map +1 -0
  132. package/dist/types/generated/files.d.ts +598 -0
  133. package/dist/types/generated/files.d.ts.map +1 -0
  134. package/dist/types/generated/files.js +6 -0
  135. package/dist/types/generated/files.js.map +1 -0
  136. package/dist/types/generated/flags.d.ts +593 -0
  137. package/dist/types/generated/flags.d.ts.map +1 -0
  138. package/dist/types/generated/flags.js +6 -0
  139. package/dist/types/generated/flags.js.map +1 -0
  140. package/dist/types/generated/guidance-lines.d.ts +405 -0
  141. package/dist/types/generated/guidance-lines.d.ts.map +1 -0
  142. package/dist/types/generated/guidance-lines.js +6 -0
  143. package/dist/types/generated/guidance-lines.js.map +1 -0
  144. package/dist/types/generated/index.d.ts +44 -0
  145. package/dist/types/generated/index.d.ts.map +1 -0
  146. package/dist/types/generated/index.js +26 -0
  147. package/dist/types/generated/index.js.map +1 -0
  148. package/dist/types/generated/map-layers.d.ts +696 -0
  149. package/dist/types/generated/map-layers.d.ts.map +1 -0
  150. package/dist/types/generated/map-layers.js +6 -0
  151. package/dist/types/generated/map-layers.js.map +1 -0
  152. package/dist/types/generated/operators.d.ts +361 -0
  153. package/dist/types/generated/operators.d.ts.map +1 -0
  154. package/dist/types/generated/operators.js +6 -0
  155. package/dist/types/generated/operators.js.map +1 -0
  156. package/dist/types/generated/organizations.d.ts +308 -0
  157. package/dist/types/generated/organizations.d.ts.map +1 -0
  158. package/dist/types/generated/organizations.js +6 -0
  159. package/dist/types/generated/organizations.js.map +1 -0
  160. package/dist/types/generated/products.d.ts +1165 -0
  161. package/dist/types/generated/products.d.ts.map +1 -0
  162. package/dist/types/generated/products.js +6 -0
  163. package/dist/types/generated/products.js.map +1 -0
  164. package/dist/types/generated/users.d.ts +96 -0
  165. package/dist/types/generated/users.d.ts.map +1 -0
  166. package/dist/types/generated/users.js +6 -0
  167. package/dist/types/generated/users.js.map +1 -0
  168. package/dist/types/generated/webhook.d.ts +475 -0
  169. package/dist/types/generated/webhook.d.ts.map +1 -0
  170. package/dist/types/generated/webhook.js +6 -0
  171. package/dist/types/generated/webhook.js.map +1 -0
  172. package/dist/types/index.d.ts +25 -0
  173. package/dist/types/index.d.ts.map +1 -0
  174. package/dist/types/index.js +25 -0
  175. package/dist/types/index.js.map +1 -0
  176. package/package.json +70 -0
@@ -0,0 +1,839 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+ export interface paths {
6
+ "/organizations/{orgId}/assets": {
7
+ parameters: {
8
+ query?: never;
9
+ header?: never;
10
+ path?: never;
11
+ cookie?: never;
12
+ };
13
+ /**
14
+ * Get all assets
15
+ * @description This endpoint will retrieve all assets for an organization.
16
+ */
17
+ get: operations["getOrgAssets"];
18
+ put?: never;
19
+ /**
20
+ * Create a new asset
21
+ * @description This endpoint will create a new asset.
22
+ */
23
+ post: operations["postAsset"];
24
+ delete?: never;
25
+ options?: never;
26
+ head?: never;
27
+ patch?: never;
28
+ trace?: never;
29
+ };
30
+ "/assets/{assetId}": {
31
+ parameters: {
32
+ query?: never;
33
+ header?: never;
34
+ path?: never;
35
+ cookie?: never;
36
+ };
37
+ /**
38
+ * Get a specific asset
39
+ * @description This endpoint will retrieve a specific asset by its unique ID.
40
+ */
41
+ get: operations["getAsset"];
42
+ /**
43
+ * Update an asset
44
+ * @description This endpoint will update the asset by its unique id.
45
+ */
46
+ put: {
47
+ parameters: {
48
+ query?: never;
49
+ header?: never;
50
+ path: {
51
+ /** @description The ID of the asset */
52
+ assetId: components["parameters"]["AssetId"];
53
+ };
54
+ cookie?: never;
55
+ };
56
+ /** @description Asset to be updated. */
57
+ requestBody?: {
58
+ content: {
59
+ "application/vnd.deere.axiom.v3+json": components["schemas"]["CreatePostValues"];
60
+ };
61
+ };
62
+ responses: {
63
+ 204: components["responses"]["AssetPut"];
64
+ 400: components["responses"]["400"];
65
+ 401: components["responses"]["401"];
66
+ 403: components["responses"]["403"];
67
+ 404: components["responses"]["404"];
68
+ 406: components["responses"]["406"];
69
+ 415: components["responses"]["415"];
70
+ 429: components["responses"]["429"];
71
+ };
72
+ };
73
+ post?: never;
74
+ /**
75
+ * Delete an Asset
76
+ * @description This endpoint will delete an asset by its unique id.
77
+ */
78
+ delete: {
79
+ parameters: {
80
+ query?: never;
81
+ header?: never;
82
+ path: {
83
+ /** @description The ID of the asset */
84
+ assetId: components["parameters"]["AssetId"];
85
+ };
86
+ cookie?: never;
87
+ };
88
+ requestBody?: never;
89
+ responses: {
90
+ /** @description Success. */
91
+ 204: {
92
+ headers: {
93
+ [name: string]: unknown;
94
+ };
95
+ content: {
96
+ "application/vnd.deere.axiom.v3+json": unknown;
97
+ };
98
+ };
99
+ 401: components["responses"]["401"];
100
+ 403: components["responses"]["403"];
101
+ 404: components["responses"]["404"];
102
+ 429: components["responses"]["429"];
103
+ };
104
+ };
105
+ options?: never;
106
+ head?: never;
107
+ patch?: never;
108
+ trace?: never;
109
+ };
110
+ "/assets/{assetId}/locations": {
111
+ parameters: {
112
+ query?: never;
113
+ header?: never;
114
+ path?: never;
115
+ cookie?: never;
116
+ };
117
+ /**
118
+ * Get all locations for an asset
119
+ * @description This endpoint will retrieve all locations for an asset. If you provide startDate and endDate then it will retrieve all the results of the given time range.
120
+ */
121
+ get: operations["getAssetLocations"];
122
+ put?: never;
123
+ /**
124
+ * Create new asset location
125
+ * @description This endpoint will create a new Asset Location.<br/><br/><b>We provide <a href="#markdown">Markdown support</a> for measurementData name.</b><br/><br/> <b>Please Note:</b> Only <i>links</i> are supported for a measurementData name.<br/><br/>Additionally, Asset Locations do not honor fractional seconds in their <mark>timestamps</mark>. So <mark>2019-01-01T12:34:56.900Z</mark> and <mark>2019-01-01T12:34:56Z</mark> are considered equivalent.
126
+ */
127
+ post: operations["postAssetLocations"];
128
+ delete?: never;
129
+ options?: never;
130
+ head?: never;
131
+ patch?: never;
132
+ trace?: never;
133
+ };
134
+ "/assetCatalog": {
135
+ parameters: {
136
+ query?: never;
137
+ header?: never;
138
+ path?: never;
139
+ cookie?: never;
140
+ };
141
+ /**
142
+ * Get Asset Catalog List
143
+ * @description This endpoint will retrieve the Asset Catalog List.
144
+ */
145
+ get: operations["getAssetCatalog"];
146
+ put?: never;
147
+ post?: never;
148
+ delete?: never;
149
+ options?: never;
150
+ head?: never;
151
+ patch?: never;
152
+ trace?: never;
153
+ };
154
+ }
155
+ export type webhooks = Record<string, never>;
156
+ export interface components {
157
+ schemas: {
158
+ CollectionBase: {
159
+ links?: {
160
+ /**
161
+ * @description Links relavent to exploring the collection.
162
+ * @example self
163
+ */
164
+ rel?: string;
165
+ /**
166
+ * Format: uri
167
+ * @description The URI to the related resource.
168
+ * @example https://sandboxapi.deere.com/platform/resources/61265
169
+ */
170
+ uri?: string;
171
+ }[];
172
+ /** @example 1 */
173
+ total?: number;
174
+ };
175
+ AssetCollection: components["schemas"]["CollectionBase"] & {
176
+ values?: components["schemas"]["Asset"][];
177
+ };
178
+ AssetLocationCollection: components["schemas"]["CollectionBase"] & {
179
+ values?: components["schemas"]["AssetLocation"][];
180
+ };
181
+ AssetLocationBase: {
182
+ /** @example ContributedAssetLocation */
183
+ "@type"?: string;
184
+ /**
185
+ * Format: date-time
186
+ * @description ISO 8601 Date and time in UTC the `measurementData` and/or `geometry` were recorded by the Asset
187
+ * @example 2019-07-12T21:29:50.000Z
188
+ */
189
+ timestamp: string;
190
+ /**
191
+ * @description stringified [GeoJSON Point (RFC 7946)](https://tools.ietf.org/html/rfc7946#section-3.1.2) identifying the Asset geolocation
192
+ * @example { "type": "Feature", "geometry": { "geometries": [ { "coordinates": [ -94.5609911, 42.3428859 ], "type": "Point" } ], "type": "GeometryCollection" } }
193
+ */
194
+ geometry?: string;
195
+ measurementData?: components["schemas"]["MeasurementData"][];
196
+ };
197
+ /** @description A point in time geolocation or measurments broadcast by an Asset, a series of Asset Locations track an Asset's movement and/or measurement changes. Either `geometry` or `measurementData` is required and both are allowed. */
198
+ AssetLocation: components["schemas"]["AssetLocationBase"];
199
+ /** @description The Asset Location with the most recent `timestamp` */
200
+ LastKnownLocation: components["schemas"]["AssetLocationBase"];
201
+ UpdateAsset: {
202
+ /**
203
+ * Format: uuid
204
+ * @description The ID of the Asset. Optional, but if included it must match the URL parameter for Asset Id.
205
+ * @example b9d96332-93c7-44ae-ac86-eed8727f13c7
206
+ */
207
+ id?: string;
208
+ } & components["schemas"]["CreateAsset"];
209
+ /** @description A networked physical device, an IOT device, with the ability to broadcast geolocations and measurements */
210
+ CreateAsset: {
211
+ /** @example ContributedAsset */
212
+ "@type"?: string;
213
+ /**
214
+ * @description The name of the Asset.
215
+ * @example McGill 7000
216
+ */
217
+ title: string;
218
+ assetCategory: components["schemas"]["AssetCategory"];
219
+ assetType: components["schemas"]["AssetType"];
220
+ assetSubType: components["schemas"]["AssetSubType"];
221
+ };
222
+ Asset: components["schemas"]["UpdateAsset"] & {
223
+ /**
224
+ * Format: date-time
225
+ * @description A timestamp of the date and time the last operation was performed on this item.
226
+ */
227
+ readonly lastModifiedDate?: string;
228
+ lastKnownLocation?: components["schemas"]["LastKnownLocation"];
229
+ };
230
+ AssetCollectionGetLink: {
231
+ /**
232
+ * @description This Asset List Link.
233
+ * @example https://sandboxapi.deere.com/platform/organizations/ORG_ID/assets
234
+ */
235
+ self?: unknown;
236
+ /**
237
+ * @description Organizations Link.
238
+ * @example https://sandboxapi.deere.com/platform/organizations/ORG_ID
239
+ */
240
+ organization?: unknown;
241
+ /**
242
+ * @description Link to get location data for the asset.
243
+ * @example https://sandboxapi.deere.com/platform/assets/ASSET_ID/locations
244
+ */
245
+ locations?: unknown;
246
+ };
247
+ AssetCollectionGetLink2: {
248
+ /**
249
+ * @description Organizations Link.
250
+ * @example https://sandboxapi.deere.com/platform/organizations/ORG_ID
251
+ */
252
+ organization?: unknown;
253
+ /**
254
+ * @description Link to get location data for the asset.
255
+ * @example https://sandboxapi.deere.com/platform/assets/ASSET_ID/locations
256
+ */
257
+ locations?: unknown;
258
+ };
259
+ AssetCollectionGetValue: {
260
+ /**
261
+ * @description Links to related resources in the Deere ecosystem.
262
+ * @example See "Available Links" below
263
+ */
264
+ links?: unknown[];
265
+ /**
266
+ * @description Count of Assets in response
267
+ * @example 3
268
+ */
269
+ total?: number;
270
+ /**
271
+ * @description The primary resource listing.
272
+ * @example ---
273
+ */
274
+ values?: unknown[];
275
+ "Asset Details"?: {
276
+ /**
277
+ * Format: uuid
278
+ * @description The ID of the asset.
279
+ * @example ab2c95d0-48ec-47f9-9fce-9ff42107c662
280
+ */
281
+ id?: string;
282
+ /**
283
+ * @description The name of the asset.
284
+ * @example Water sensor
285
+ */
286
+ title?: string;
287
+ /**
288
+ * @description Asset Category
289
+ * @example DEVICE
290
+ */
291
+ assetCategory?: string;
292
+ /**
293
+ * @description Asset Type
294
+ * @example SENSOR
295
+ */
296
+ assetType?: string;
297
+ /**
298
+ * @description Asset Sub Type
299
+ * @example OTHER
300
+ */
301
+ assetSubType?: string;
302
+ /**
303
+ * Format: date-time
304
+ * @description A timestamp of the date and time the last operation was performed on this item. All timestamps follow the ISO 8601 standard format.
305
+ * @example 2015-04-30T10:23:50.000Z
306
+ */
307
+ lastModifiedDate?: string;
308
+ /**
309
+ * @description The Asset Location with the most recent <mark>timestamp</mark>. Included if embed is requested.
310
+ * @example See sample response below
311
+ */
312
+ lastKnownLocation?: Record<string, never>;
313
+ };
314
+ };
315
+ CreatePostLink: {
316
+ /**
317
+ * @description Contribution Definition Link.
318
+ * @example https://sandboxapi.deere.com/platform/contributionDefinitions/DEFINITION_ID
319
+ */
320
+ contributionDefinition?: unknown;
321
+ };
322
+ CreatePostValues: {
323
+ /**
324
+ * @description The name of the asset.
325
+ * @example Water Sensor
326
+ */
327
+ title?: string;
328
+ /**
329
+ * @description Asset Category
330
+ * @example DEVICE
331
+ */
332
+ assetCategory?: string;
333
+ /**
334
+ * @description Asset Type
335
+ * @example SENSOR
336
+ */
337
+ assetType?: string;
338
+ /**
339
+ * @description Asset Sub Type
340
+ * @example OTHER
341
+ */
342
+ assetSubType?: string;
343
+ };
344
+ AssetGetValues: {
345
+ /**
346
+ * Format: uuid
347
+ * @description The ID of the asset.
348
+ * @example ab2c95d0-48ec-47f9-9fce-9ff42107c662
349
+ */
350
+ id?: string;
351
+ /**
352
+ * @description The name of the asset.
353
+ * @example Water sensor
354
+ */
355
+ title?: string;
356
+ /**
357
+ * @description Asset Category
358
+ * @example DEVICE
359
+ */
360
+ assetCategory?: string;
361
+ /**
362
+ * @description Asset Type
363
+ * @example SENSOR
364
+ */
365
+ assetType?: string;
366
+ /**
367
+ * @description Asset Sub Type
368
+ * @example OTHER
369
+ */
370
+ assetSubType?: string;
371
+ /**
372
+ * Format: date-time
373
+ * @description All timestamps follow the ISO 8601 standard format.
374
+ * @example 2015-04-30T10:23:50.000Z
375
+ */
376
+ lastModifiedDate?: string;
377
+ /**
378
+ * @description Location data about the asset. Included if embed is requested.
379
+ * @example See sample response below
380
+ */
381
+ lastKnownLocation?: Record<string, never>;
382
+ };
383
+ AssetIdValue: {
384
+ /**
385
+ * Format: date-time
386
+ * @description All timestamps follow the ISO 8601 standard format.
387
+ * @example 2015-04-30T10:23:50.000Z
388
+ */
389
+ timestamp?: string;
390
+ /**
391
+ * @description GeoJSON representation of the asset location.
392
+ * @example See sample request below.
393
+ */
394
+ geometry?: unknown;
395
+ /**
396
+ * @description List of measurement data to be associated with the asset.
397
+ * @example See sample request below
398
+ */
399
+ measurementData?: unknown[];
400
+ };
401
+ AssetIdValuePost: {
402
+ /**
403
+ * Format: date-time
404
+ * @description All timestamps follow the ISO 8601 standard format.
405
+ * @example 2015-04-30T10:23:50.000Z
406
+ */
407
+ timestamp?: string;
408
+ /**
409
+ * @description GeoJSON representation of the asset location.
410
+ * @example See sample request below.
411
+ */
412
+ geometry?: string;
413
+ /**
414
+ * @description List of measurement data to be associated with the asset.
415
+ * @example See sample request below
416
+ */
417
+ measurementData?: unknown[];
418
+ };
419
+ ContributionDefinitionLink: {
420
+ /** @example Link */
421
+ "@type"?: string;
422
+ /**
423
+ * @description The relation of the object to the linked resource.
424
+ * @example contributionDefinition
425
+ */
426
+ rel?: string;
427
+ /**
428
+ * Format: uri
429
+ * @description The URI to the related resource.
430
+ * @example https://sandboxapi.deere.com/platform/contributionDefinitions/34973a25-75c0-48a9-a414-7d61587b3e37
431
+ */
432
+ uri?: string;
433
+ };
434
+ AssetCatalogGet: {
435
+ /**
436
+ * @description Asset Category
437
+ * @example DEVICE
438
+ */
439
+ assetCategory?: string;
440
+ /**
441
+ * @description Asset Type
442
+ * @example SENSOR
443
+ */
444
+ assetType?: string;
445
+ /**
446
+ * @description Asset Sub Type
447
+ * @example OTHER
448
+ */
449
+ assetSubType?: string;
450
+ };
451
+ AssetCatalogCollection: components["schemas"]["CollectionBase"] & {
452
+ values?: components["schemas"]["AssetCatalogItem"][];
453
+ };
454
+ /** @description Stub schema for MeasurementData (auto-generated - original was missing) */
455
+ MeasurementData: {
456
+ [key: string]: unknown;
457
+ };
458
+ /** @description Stub schema for AssetCategory (auto-generated - original was missing) */
459
+ AssetCategory: {
460
+ [key: string]: unknown;
461
+ };
462
+ /** @description Stub schema for AssetType (auto-generated - original was missing) */
463
+ AssetType: {
464
+ [key: string]: unknown;
465
+ };
466
+ /** @description Stub schema for AssetSubType (auto-generated - original was missing) */
467
+ AssetSubType: {
468
+ [key: string]: unknown;
469
+ };
470
+ /** @description Stub schema for AssetCatalogItem (auto-generated - original was missing) */
471
+ AssetCatalogItem: {
472
+ [key: string]: unknown;
473
+ };
474
+ /** @description Error response schema for 400Errors (auto-generated) */
475
+ "400Errors": {
476
+ message?: string;
477
+ errors?: Record<string, never>[];
478
+ };
479
+ /** @description Error response schema for GenericErrors (auto-generated) */
480
+ GenericErrors: {
481
+ message?: string;
482
+ errors?: Record<string, never>[];
483
+ };
484
+ };
485
+ responses: {
486
+ /** @description Request */
487
+ 201: {
488
+ headers: {
489
+ [name: string]: unknown;
490
+ };
491
+ content: {
492
+ "application/vnd.deere.axiom.v3+json": unknown;
493
+ };
494
+ };
495
+ /** @description The request body was malformed or the given query parameters were invalid. For example, it was missing a required field or supplied a read-only value. */
496
+ 400: {
497
+ headers: {
498
+ [name: string]: unknown;
499
+ };
500
+ content: {
501
+ "application/vnd.deere.axiom.v3+json": components["schemas"]["400Errors"];
502
+ };
503
+ };
504
+ /** @description The user's OAuth credentials are not recognized by the server. */
505
+ 401: {
506
+ headers: {
507
+ [name: string]: unknown;
508
+ };
509
+ content?: never;
510
+ };
511
+ /** @description The user does not have access to the requested resource. */
512
+ 403: {
513
+ headers: {
514
+ [name: string]: unknown;
515
+ };
516
+ content: {
517
+ "application/vnd.deere.axiom.v3+json": components["schemas"]["GenericErrors"];
518
+ };
519
+ };
520
+ /** @description The specified resource was not found on the server. */
521
+ 404: {
522
+ headers: {
523
+ [name: string]: unknown;
524
+ };
525
+ content: {
526
+ "application/vnd.deere.axiom.v3+json": components["schemas"]["GenericErrors"];
527
+ };
528
+ };
529
+ /** @description The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request. */
530
+ 406: {
531
+ headers: {
532
+ [name: string]: unknown;
533
+ };
534
+ content?: never;
535
+ };
536
+ /** @description The timestamp on the provided location conflicts with a previously provided location. */
537
+ 409: {
538
+ headers: {
539
+ [name: string]: unknown;
540
+ };
541
+ content?: never;
542
+ };
543
+ /** @description The payload is too large. The max payload size is 100KB. */
544
+ 413: {
545
+ headers: {
546
+ [name: string]: unknown;
547
+ };
548
+ content?: never;
549
+ };
550
+ /** @description The server refuses to accept the request because the payload format is in an unsupported format. */
551
+ 415: {
552
+ headers: {
553
+ [name: string]: unknown;
554
+ };
555
+ content?: never;
556
+ };
557
+ /** @description The user has sent too many requests in a given amount of time. */
558
+ 429: {
559
+ headers: {
560
+ [name: string]: unknown;
561
+ };
562
+ content?: never;
563
+ };
564
+ /** @description A collection of Assets */
565
+ GetOrgId: {
566
+ headers: {
567
+ [name: string]: unknown;
568
+ };
569
+ content: {
570
+ "application/vnd.deere.axiom.v3+json": {
571
+ links?: unknown;
572
+ values?: unknown;
573
+ };
574
+ };
575
+ };
576
+ /** @description Create */
577
+ CreatePost: {
578
+ headers: {
579
+ [name: string]: unknown;
580
+ };
581
+ content: {
582
+ "application/vnd.deere.axiom.v3+json": Record<string, never>;
583
+ };
584
+ };
585
+ /** @description The Asset. */
586
+ AssetGet: {
587
+ headers: {
588
+ [name: string]: unknown;
589
+ };
590
+ content: {
591
+ "application/vnd.deere.axiom.v3+json": {
592
+ links?: unknown;
593
+ values?: unknown;
594
+ };
595
+ };
596
+ };
597
+ /** @description Success */
598
+ AssetPut: {
599
+ headers: {
600
+ [name: string]: unknown;
601
+ };
602
+ content: {
603
+ "application/vnd.deere.axiom.v3+json": Record<string, never>;
604
+ };
605
+ };
606
+ /** @description The Asset Locations */
607
+ AssetIdGet: {
608
+ headers: {
609
+ [name: string]: unknown;
610
+ };
611
+ content: {
612
+ "application/vnd.deere.axiom.v3+json": {
613
+ values?: unknown;
614
+ };
615
+ };
616
+ };
617
+ /** @description The Asset Location. */
618
+ AssetLocation: {
619
+ headers: {
620
+ [name: string]: unknown;
621
+ };
622
+ content: {
623
+ "*/*": components["schemas"]["AssetLocation"][];
624
+ };
625
+ };
626
+ /** @description Success. */
627
+ Success: {
628
+ headers: {
629
+ [name: string]: unknown;
630
+ };
631
+ content?: never;
632
+ };
633
+ /** @description Created. */
634
+ Created: {
635
+ headers: {
636
+ /** @description https://sandboxapi.deere.com/platform/asset/1234 */
637
+ Location?: string;
638
+ [name: string]: unknown;
639
+ };
640
+ content?: never;
641
+ };
642
+ };
643
+ parameters: {
644
+ /** @description The ID of the organization */
645
+ OrgId: string;
646
+ /** @description Additional data to embed in the response. For example <mark>embed=lastKnownLocation</mark> will return assets with their <mark>lastKnownLocation</mark> included. */
647
+ Embed: string;
648
+ /** @description See <a href="#eTags">eTags</a> for more information. */
649
+ "X-deere-sign": string;
650
+ /** @description See <a href="#eTags">eTags</a> for more information. */
651
+ "x-deere-sign": string;
652
+ /** @description See <a href="#eTags">eTags</a> for more information. */
653
+ "x-deere-sign2": string;
654
+ /** @description The ID of the asset */
655
+ AssetId: string;
656
+ /** @description The ID associated with the asset. */
657
+ AssetId2: string;
658
+ /** @description Retrieves results that occurred after (inclusive) a specified date. The format is in the ISO 8601 Standard.<br/><b>Note:</b> When including <mark>startDate</mark> without <mark>endDate</mark> or vice versa the missing parameter will default. <mark>startDate</mark> will default to the beginning of time and <mark>endDate</mark> will default to the current time. */
659
+ StartDate: string;
660
+ /** @description Retrieves results that occurred before (inclusive) a specified date. The format is in the ISO 8601 Standard.<br/><b>Note:</b> When including <mark>startDate</mark> without <mark>endDate</mark> or vice versa the missing parameter will default. <mark>startDate</mark> will default to the beginning of time and <mark>endDate</mark> will default to the current time. */
661
+ EndDate: string;
662
+ /** @description A query param returned by the server in the <mark>nextPage</mark> link if there are more results for your query than were returned in the response. */
663
+ PageKey: string;
664
+ /** @description The number of results to include in the response. Must be a positive value greater than or equal to 1. Max 500. Default 500. */
665
+ Count: string;
666
+ };
667
+ requestBodies: never;
668
+ headers: {
669
+ /**
670
+ * @description URI to the created resource
671
+ * @example https://sandboxapi.deere.com/platform/assets/7a300c61-a663-4c2b-9ec5-967a9c5b4776/locations
672
+ */
673
+ Location: string;
674
+ };
675
+ pathItems: never;
676
+ }
677
+ export type $defs = Record<string, never>;
678
+ export interface operations {
679
+ getOrgAssets: {
680
+ parameters: {
681
+ query?: {
682
+ /** @description Additional data to embed in the response. For example <mark>embed=lastKnownLocation</mark> will return assets with their <mark>lastKnownLocation</mark> included. */
683
+ embed?: components["parameters"]["Embed"];
684
+ };
685
+ header?: {
686
+ /** @description See <a href="#eTags">eTags</a> for more information. */
687
+ "x-deere-signature"?: components["parameters"]["X-deere-sign"];
688
+ };
689
+ path: {
690
+ /** @description The ID of the organization */
691
+ orgId: components["parameters"]["OrgId"];
692
+ };
693
+ cookie?: never;
694
+ };
695
+ requestBody?: never;
696
+ responses: {
697
+ 200: components["responses"]["GetOrgId"];
698
+ 401: components["responses"]["401"];
699
+ 403: components["responses"]["403"];
700
+ 406: components["responses"]["406"];
701
+ 429: components["responses"]["429"];
702
+ };
703
+ };
704
+ postAsset: {
705
+ parameters: {
706
+ query?: never;
707
+ header?: never;
708
+ path: {
709
+ /** @description The ID of the organization */
710
+ orgId: components["parameters"]["OrgId"];
711
+ };
712
+ cookie?: never;
713
+ };
714
+ /** @description Asset to be created. */
715
+ requestBody?: {
716
+ content: {
717
+ "application/vnd.deere.axiom.v3+json": components["schemas"]["CreatePostValues"];
718
+ };
719
+ };
720
+ responses: {
721
+ 201: components["responses"]["CreatePost"];
722
+ 400: components["responses"]["400"];
723
+ 401: components["responses"]["401"];
724
+ 403: components["responses"]["403"];
725
+ 404: components["responses"]["404"];
726
+ 406: components["responses"]["406"];
727
+ 415: components["responses"]["415"];
728
+ 429: components["responses"]["429"];
729
+ };
730
+ };
731
+ getAsset: {
732
+ parameters: {
733
+ query?: {
734
+ /** @description Additional data to embed in the response. For example <mark>embed=lastKnownLocation</mark> will return assets with their <mark>lastKnownLocation</mark> included. */
735
+ embed?: components["parameters"]["Embed"];
736
+ };
737
+ header?: never;
738
+ path: {
739
+ /** @description The ID of the asset */
740
+ assetId: components["parameters"]["AssetId"];
741
+ };
742
+ cookie?: never;
743
+ };
744
+ requestBody?: never;
745
+ responses: {
746
+ 200: components["responses"]["AssetGet"];
747
+ 401: components["responses"]["401"];
748
+ 403: components["responses"]["403"];
749
+ 404: components["responses"]["404"];
750
+ 406: components["responses"]["406"];
751
+ 429: components["responses"]["429"];
752
+ };
753
+ };
754
+ getAssetLocations: {
755
+ parameters: {
756
+ query?: {
757
+ /** @description Retrieves results that occurred after (inclusive) a specified date. The format is in the ISO 8601 Standard.<br/><b>Note:</b> When including <mark>startDate</mark> without <mark>endDate</mark> or vice versa the missing parameter will default. <mark>startDate</mark> will default to the beginning of time and <mark>endDate</mark> will default to the current time. */
758
+ startDate?: components["parameters"]["StartDate"];
759
+ /** @description Retrieves results that occurred before (inclusive) a specified date. The format is in the ISO 8601 Standard.<br/><b>Note:</b> When including <mark>startDate</mark> without <mark>endDate</mark> or vice versa the missing parameter will default. <mark>startDate</mark> will default to the beginning of time and <mark>endDate</mark> will default to the current time. */
760
+ endDate?: components["parameters"]["EndDate"];
761
+ /** @description The number of results to include in the response. Must be a positive value greater than or equal to 1. Max 500. Default 500. */
762
+ count?: components["parameters"]["Count"];
763
+ /** @description A query param returned by the server in the <mark>nextPage</mark> link if there are more results for your query than were returned in the response. */
764
+ pageKey?: components["parameters"]["PageKey"];
765
+ };
766
+ header?: never;
767
+ path: {
768
+ /** @description The ID associated with the asset. */
769
+ assetId: components["parameters"]["AssetId2"];
770
+ };
771
+ cookie?: never;
772
+ };
773
+ requestBody?: never;
774
+ responses: {
775
+ 200: components["responses"]["AssetIdGet"];
776
+ 400: components["responses"]["400"];
777
+ 401: components["responses"]["401"];
778
+ 403: components["responses"]["403"];
779
+ 404: components["responses"]["404"];
780
+ 406: components["responses"]["406"];
781
+ 429: components["responses"]["429"];
782
+ };
783
+ };
784
+ postAssetLocations: {
785
+ parameters: {
786
+ query?: never;
787
+ header?: never;
788
+ path: {
789
+ /** @description The ID associated with the asset. */
790
+ assetId: components["parameters"]["AssetId2"];
791
+ };
792
+ cookie?: never;
793
+ };
794
+ /** @description Geolocations and MeasurementData to create. */
795
+ requestBody?: {
796
+ content: {
797
+ "application/vnd.deere.axiom.v3+json": components["schemas"]["AssetIdValuePost"];
798
+ };
799
+ };
800
+ responses: {
801
+ 201: components["responses"]["201"];
802
+ 400: components["responses"]["400"];
803
+ 401: components["responses"]["401"];
804
+ 403: components["responses"]["403"];
805
+ 404: components["responses"]["404"];
806
+ 406: components["responses"]["406"];
807
+ 409: components["responses"]["409"];
808
+ 413: components["responses"]["413"];
809
+ 415: components["responses"]["415"];
810
+ 429: components["responses"]["429"];
811
+ };
812
+ };
813
+ getAssetCatalog: {
814
+ parameters: {
815
+ query?: never;
816
+ header?: {
817
+ /** @description See <a href="#eTags">eTags</a> for more information. */
818
+ "x-deere-signature"?: components["parameters"]["x-deere-sign"];
819
+ };
820
+ path?: never;
821
+ cookie?: never;
822
+ };
823
+ requestBody?: never;
824
+ responses: {
825
+ /** @description The Asset Catalog containaing all valid entries. */
826
+ 200: {
827
+ headers: {
828
+ [name: string]: unknown;
829
+ };
830
+ content: {
831
+ "application/vnd.deere.axiom.v3+json": {
832
+ values?: unknown;
833
+ };
834
+ };
835
+ };
836
+ };
837
+ };
838
+ }
839
+ //# sourceMappingURL=assets.d.ts.map