deere-sdk 2.3.1 → 2.4.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 (123) hide show
  1. package/CHANGELOG.md +56 -0
  2. package/dist/api/assets.d.ts +23 -23
  3. package/dist/api/assets.d.ts.map +1 -1
  4. package/dist/api/assets.js +35 -35
  5. package/dist/api/assets.js.map +1 -1
  6. package/dist/api/boundaries.d.ts +16 -16
  7. package/dist/api/boundaries.d.ts.map +1 -1
  8. package/dist/api/boundaries.js +19 -19
  9. package/dist/api/boundaries.js.map +1 -1
  10. package/dist/api/clients.d.ts +10 -10
  11. package/dist/api/clients.d.ts.map +1 -1
  12. package/dist/api/clients.js +13 -13
  13. package/dist/api/clients.js.map +1 -1
  14. package/dist/api/crop-types.d.ts +4 -4
  15. package/dist/api/crop-types.d.ts.map +1 -1
  16. package/dist/api/crop-types.js +6 -6
  17. package/dist/api/crop-types.js.map +1 -1
  18. package/dist/api/equipment.d.ts +76 -76
  19. package/dist/api/equipment.d.ts.map +1 -1
  20. package/dist/api/equipment.js +96 -96
  21. package/dist/api/equipment.js.map +1 -1
  22. package/dist/api/farms.d.ts +11 -11
  23. package/dist/api/farms.d.ts.map +1 -1
  24. package/dist/api/farms.js +14 -14
  25. package/dist/api/farms.js.map +1 -1
  26. package/dist/api/field-operations-api.d.ts +88 -32
  27. package/dist/api/field-operations-api.d.ts.map +1 -1
  28. package/dist/api/field-operations-api.js +111 -49
  29. package/dist/api/field-operations-api.js.map +1 -1
  30. package/dist/api/fields.d.ts +9 -9
  31. package/dist/api/fields.d.ts.map +1 -1
  32. package/dist/api/fields.js +12 -12
  33. package/dist/api/fields.js.map +1 -1
  34. package/dist/api/files.d.ts +47 -0
  35. package/dist/api/files.d.ts.map +1 -1
  36. package/dist/api/files.js +65 -0
  37. package/dist/api/files.js.map +1 -1
  38. package/dist/api/flags.d.ts +100 -34
  39. package/dist/api/flags.d.ts.map +1 -1
  40. package/dist/api/flags.js +145 -49
  41. package/dist/api/flags.js.map +1 -1
  42. package/dist/api/machine-locations.d.ts +14 -0
  43. package/dist/api/machine-locations.d.ts.map +1 -1
  44. package/dist/api/machine-locations.js +22 -0
  45. package/dist/api/machine-locations.js.map +1 -1
  46. package/dist/api/map-layers.d.ts +83 -13
  47. package/dist/api/map-layers.d.ts.map +1 -1
  48. package/dist/api/map-layers.js +121 -19
  49. package/dist/api/map-layers.js.map +1 -1
  50. package/dist/api/notifications.d.ts +6 -6
  51. package/dist/api/notifications.d.ts.map +1 -1
  52. package/dist/api/notifications.js +9 -9
  53. package/dist/api/notifications.js.map +1 -1
  54. package/dist/api/products.d.ts +296 -10
  55. package/dist/api/products.d.ts.map +1 -1
  56. package/dist/api/products.js +423 -13
  57. package/dist/api/products.js.map +1 -1
  58. package/dist/api/webhook.d.ts +13 -0
  59. package/dist/api/webhook.d.ts.map +1 -1
  60. package/dist/api/webhook.js +19 -0
  61. package/dist/api/webhook.js.map +1 -1
  62. package/dist/api-servers.generated.d.ts +0 -1
  63. package/dist/api-servers.generated.d.ts.map +1 -1
  64. package/dist/api-servers.generated.js +0 -1
  65. package/dist/api-servers.generated.js.map +1 -1
  66. package/dist/hateoas-map.d.ts.map +1 -1
  67. package/dist/hateoas-map.js +65 -0
  68. package/dist/hateoas-map.js.map +1 -1
  69. package/dist/types/generated/assets.d.ts +256 -256
  70. package/dist/types/generated/assets.d.ts.map +1 -1
  71. package/dist/types/generated/boundaries.d.ts +475 -475
  72. package/dist/types/generated/boundaries.d.ts.map +1 -1
  73. package/dist/types/generated/clients.d.ts +163 -163
  74. package/dist/types/generated/clients.d.ts.map +1 -1
  75. package/dist/types/generated/connection-management.d.ts +21 -21
  76. package/dist/types/generated/connection-management.d.ts.map +1 -1
  77. package/dist/types/generated/crop-types.d.ts +30 -30
  78. package/dist/types/generated/crop-types.d.ts.map +1 -1
  79. package/dist/types/generated/equipment-measurement.d.ts +85 -85
  80. package/dist/types/generated/equipment-measurement.d.ts.map +1 -1
  81. package/dist/types/generated/equipment.d.ts +1202 -1202
  82. package/dist/types/generated/equipment.d.ts.map +1 -1
  83. package/dist/types/generated/farms.d.ts +122 -122
  84. package/dist/types/generated/farms.d.ts.map +1 -1
  85. package/dist/types/generated/field-operations-api.d.ts +1103 -846
  86. package/dist/types/generated/field-operations-api.d.ts.map +1 -1
  87. package/dist/types/generated/fields.d.ts +357 -357
  88. package/dist/types/generated/fields.d.ts.map +1 -1
  89. package/dist/types/generated/files.d.ts +435 -113
  90. package/dist/types/generated/files.d.ts.map +1 -1
  91. package/dist/types/generated/flags.d.ts +779 -77
  92. package/dist/types/generated/flags.d.ts.map +1 -1
  93. package/dist/types/generated/guidance-lines.d.ts +41 -41
  94. package/dist/types/generated/guidance-lines.d.ts.map +1 -1
  95. package/dist/types/generated/harvest-id.d.ts +137 -137
  96. package/dist/types/generated/harvest-id.d.ts.map +1 -1
  97. package/dist/types/generated/index.d.ts +1 -1
  98. package/dist/types/generated/index.js +1 -1
  99. package/dist/types/generated/machine-alerts.d.ts +114 -114
  100. package/dist/types/generated/machine-alerts.d.ts.map +1 -1
  101. package/dist/types/generated/machine-device-state-reports.d.ts +12 -12
  102. package/dist/types/generated/machine-device-state-reports.d.ts.map +1 -1
  103. package/dist/types/generated/machine-engine-hours.d.ts +19 -19
  104. package/dist/types/generated/machine-engine-hours.d.ts.map +1 -1
  105. package/dist/types/generated/machine-hours-of-operation.d.ts +20 -20
  106. package/dist/types/generated/machine-hours-of-operation.d.ts.map +1 -1
  107. package/dist/types/generated/machine-locations.d.ts +247 -1
  108. package/dist/types/generated/machine-locations.d.ts.map +1 -1
  109. package/dist/types/generated/map-layers.d.ts +957 -293
  110. package/dist/types/generated/map-layers.d.ts.map +1 -1
  111. package/dist/types/generated/notifications.d.ts +126 -126
  112. package/dist/types/generated/notifications.d.ts.map +1 -1
  113. package/dist/types/generated/operators.d.ts +21 -21
  114. package/dist/types/generated/operators.d.ts.map +1 -1
  115. package/dist/types/generated/organizations.d.ts +33 -33
  116. package/dist/types/generated/organizations.d.ts.map +1 -1
  117. package/dist/types/generated/partnerships.d.ts +61 -61
  118. package/dist/types/generated/partnerships.d.ts.map +1 -1
  119. package/dist/types/generated/products.d.ts +5162 -456
  120. package/dist/types/generated/products.d.ts.map +1 -1
  121. package/dist/types/generated/webhook.d.ts +299 -137
  122. package/dist/types/generated/webhook.d.ts.map +1 -1
  123. package/package.json +2 -1
@@ -3,7 +3,7 @@
3
3
  * Do not make direct changes to the file.
4
4
  */
5
5
  export interface paths {
6
- '/organizations/{orgId}/flags/{flagId}': {
6
+ '/organizations/{orgId}/fields/{fieldId}/flags': {
7
7
  parameters: {
8
8
  query?: never;
9
9
  header?: never;
@@ -11,21 +11,109 @@ export interface paths {
11
11
  cookie?: never;
12
12
  };
13
13
  /**
14
- * List a flag by org id and Flag id
15
- * @description This endpoint will return a flag for a given org and Flag id.
14
+ * List flags for the field
15
+ * @description This resource will return a list of flag objects associated with the field.
16
16
  */
17
- get: operations['getFlagForOrganizationByFlagId'];
17
+ get: operations['getOrgFieldFlags'];
18
+ put?: never;
19
+ post?: never;
20
+ delete?: never;
21
+ options?: never;
22
+ head?: never;
23
+ patch?: never;
24
+ trace?: never;
25
+ };
26
+ '/organizations/{orgId}/flagCategories': {
27
+ parameters: {
28
+ query?: never;
29
+ header?: never;
30
+ path?: never;
31
+ cookie?: never;
32
+ };
18
33
  /**
19
- * Update flag by id
20
- * @description This resource will update flag by Organization and Flag Id.
34
+ * List Flags Category Collection
35
+ * @description This resource will return a Flags Category Collection for Organization.
21
36
  */
22
- put: operations['updateFlagByIdOrgId'];
37
+ get: operations['getFlagCategoriesForOrganization'];
38
+ put?: never;
39
+ /**
40
+ * Create a custom category
41
+ * @description This resource will create a custom category in the given organization.
42
+ */
43
+ post: operations['createFlagCategory'];
44
+ delete?: never;
45
+ options?: never;
46
+ head?: never;
47
+ patch?: never;
48
+ trace?: never;
49
+ };
50
+ '/organizations/{orgId}/flagCategories/{categoryId}': {
51
+ parameters: {
52
+ query?: never;
53
+ header?: never;
54
+ path?: never;
55
+ cookie?: never;
56
+ };
57
+ /**
58
+ * Get flag category by id
59
+ * @description This resource will return a flag category with the name translated into the specified language. The category can be a reference flagCategory, a master flagCategory created from a referenced flagCategory or a user-defined category.
60
+ */
61
+ get: operations['getFlagCategoryByIdOrgId'];
62
+ /**
63
+ * Update flag category by organization and flag category Id
64
+ * @description This resource will update flag category by Id.
65
+ */
66
+ put: operations['updateFlagCategoryByIdOrgId'];
23
67
  post?: never;
24
68
  /**
25
- * Delete a flag for a given org
26
- * @description This resource will delete a single flag based on its Id and org id
69
+ * Delete a flag category
70
+ * @description This resource will delete a single empty category based on the categoryId and orgId.
27
71
  */
28
- delete: operations['deleteFlagByIdOrgId'];
72
+ delete: operations['deleteFlagCategoryByIdOrgId'];
73
+ options?: never;
74
+ head?: never;
75
+ patch?: never;
76
+ trace?: never;
77
+ };
78
+ '/organizations/{orgId}/flagCategories/{categoryId}/flagCategoryPreferences': {
79
+ parameters: {
80
+ query?: never;
81
+ header?: never;
82
+ path?: never;
83
+ cookie?: never;
84
+ };
85
+ /**
86
+ * List collection of FlagCategoryPreference
87
+ * @description This endpoint will return a collection of FlagCategoryPreference objects associated with the given flag category. The object with the key "default" is created automatically on the 1st access to the flagCategory object by a client. The default preference object shall be initialized with default values: prefKey: "default" hexColor: "#FFFFFF"
88
+ */
89
+ get: operations['getFlagCategoryPreferencesByIdOrgId'];
90
+ put?: never;
91
+ post?: never;
92
+ delete?: never;
93
+ options?: never;
94
+ head?: never;
95
+ patch?: never;
96
+ trace?: never;
97
+ };
98
+ '/organizations/{orgId}/flagCategoryPreferences/{flagCategoryPreferencesId}': {
99
+ parameters: {
100
+ query?: never;
101
+ header?: never;
102
+ path?: never;
103
+ cookie?: never;
104
+ };
105
+ /**
106
+ * View preferences object for a category
107
+ * @description This resource will return the preferences object for the given flag category and org
108
+ */
109
+ get: operations['getFlagCategoryPreferenceByIdOrgId'];
110
+ /**
111
+ * Update flag category preferences
112
+ * @description This resource will update flag category preferences by Id and Org
113
+ */
114
+ put: operations['updateFlagCategoryPreferenceByIdOrgId'];
115
+ post?: never;
116
+ delete?: never;
29
117
  options?: never;
30
118
  head?: never;
31
119
  patch?: never;
@@ -55,7 +143,7 @@ export interface paths {
55
143
  patch?: never;
56
144
  trace?: never;
57
145
  };
58
- '/organizations/{orgId}/fields/{fieldId}/flags': {
146
+ '/organizations/{orgId}/flags/{flagId}': {
59
147
  parameters: {
60
148
  query?: never;
61
149
  header?: never;
@@ -63,13 +151,21 @@ export interface paths {
63
151
  cookie?: never;
64
152
  };
65
153
  /**
66
- * List flags for the field
67
- * @description This resource will return a list of flag objects associated with the field.
154
+ * List a flag by org id and Flag id
155
+ * @description This endpoint will return a flag for a given org and Flag id.
68
156
  */
69
- get: operations['getOrgFieldFlags'];
70
- put?: never;
157
+ get: operations['getFlagForOrganizationByFlagId'];
158
+ /**
159
+ * Update flag by id
160
+ * @description This resource will update flag by Organization and Flag Id.
161
+ */
162
+ put: operations['updateFlagByIdOrgId'];
71
163
  post?: never;
72
- delete?: never;
164
+ /**
165
+ * Delete a flag for a given org
166
+ * @description This resource will delete a single flag based on its Id and org id
167
+ */
168
+ delete: operations['deleteFlagByIdOrgId'];
73
169
  options?: never;
74
170
  head?: never;
75
171
  patch?: never;
@@ -79,6 +175,140 @@ export interface paths {
79
175
  export type webhooks = Record<string, never>;
80
176
  export interface components {
81
177
  schemas: {
178
+ ContentType: unknown;
179
+ FlagCategory: {
180
+ /**
181
+ * @description Name of the category.
182
+ * @example Rocks
183
+ */
184
+ categoryTitle?: string;
185
+ /**
186
+ * @description Whether or not the category is archived
187
+ * @default false
188
+ * @example false
189
+ */
190
+ archived: boolean;
191
+ /**
192
+ * @description Shows/sets whether the category is a preferred one in the current org. This can be applied to both user-defined and reference flag categories in this org.
193
+ * @example true
194
+ */
195
+ preferred?: boolean;
196
+ /**
197
+ * Format: uuid
198
+ * @description GUID of a flag category.
199
+ * @example 7c602ae8-4351-4640-9de8-88792bda83d7
200
+ */
201
+ readonly id?: string;
202
+ /**
203
+ * Format: date-time
204
+ * @example 2018-12-28T09:17:10.694Z
205
+ */
206
+ createdDate?: string;
207
+ /**
208
+ * Format: date-time
209
+ * @example 2018-12-28T09:17:10.694Z
210
+ */
211
+ lastModifiedDate?: string;
212
+ };
213
+ FlagCategory2: {
214
+ /**
215
+ * @description Name of the category.
216
+ * @example Rocks
217
+ */
218
+ categoryTitle?: string;
219
+ /**
220
+ * @description Whether or not the category is archived
221
+ * @default false
222
+ * @example false
223
+ */
224
+ archived: boolean;
225
+ /**
226
+ * @description Shows/sets whether the category is a preferred one in the current org. This can be applied to both user-defined and reference flag categories in this org.
227
+ * @example true
228
+ */
229
+ preferred?: boolean;
230
+ /**
231
+ * Format: uuid
232
+ * @description GUID of a flag category.
233
+ * @example 688c20bb-9609-4590-95c9-649ba65c06df
234
+ */
235
+ readonly id?: string;
236
+ /** @example 2018-12-18T13:29:14.167Z */
237
+ createdDate?: string;
238
+ /** @example 2018-12-18T13:29:30.924Z */
239
+ lastModifiedDate?: string;
240
+ };
241
+ /** @description The object for keeping visual and non-visual preferences for the given FlagCategory. */
242
+ FlagCategoryPreference: {
243
+ /**
244
+ * Format: GUID
245
+ * @description Id of the FlagCategoryPreferences resource.
246
+ * @example ac6a5bb5fae84b1da29459a8101295b0
247
+ */
248
+ id?: string;
249
+ /**
250
+ * @description Key name for the preference object to be identified by clients to support client-specific preferences
251
+ * @default default
252
+ * @example default
253
+ */
254
+ prefKey: string;
255
+ /**
256
+ * @description Color code for the flag category in hexadecimal format.
257
+ * @example #0BA74A
258
+ */
259
+ hexColor?: string;
260
+ /**
261
+ * Format: date-time
262
+ * @example 2018-07-01T21:00:11Z
263
+ */
264
+ createdTime?: string;
265
+ /**
266
+ * Format: date-time
267
+ * @example 2018-07-01T21:10:10Z
268
+ */
269
+ modifiedTime?: string;
270
+ };
271
+ GetPreferences: {
272
+ /**
273
+ * @description Users Link.
274
+ * @example https://sandboxapi.deere.com/platform/users/rostaninoleg
275
+ */
276
+ modifiedBy?: unknown;
277
+ };
278
+ LinkCategoryId: {
279
+ /**
280
+ * @description Organization Link.
281
+ * @example https://sandboxapi.deere.com/platform/organizations/123456
282
+ */
283
+ organization?: unknown;
284
+ /**
285
+ * @description Update Category Link.
286
+ * @example https://sandboxapi.deere.com/platform/flagCategories/7c602ae8-4351-4640-9de8-88792bda83d7
287
+ */
288
+ updateCategory?: unknown;
289
+ /**
290
+ * @description Delete Category Link.
291
+ * @example https://sandboxapi.deere.com/platform/organizations/{orgId}/flagCategories/7c602ae8-4351-4640-9de8-88792bda83d7
292
+ */
293
+ deleteCategory?: unknown;
294
+ };
295
+ LinkCategoryId2: {
296
+ /**
297
+ * @description Organization Link.
298
+ * @example https://sandboxapi.deere.com/platform/organizations/123456
299
+ */
300
+ organization?: unknown;
301
+ /**
302
+ * @description Update Category Link.
303
+ * @example https://sandboxapi.deere.com/platform/flagCategories/835b863c-1997-451d-8850-1123ff4ec0e3
304
+ */
305
+ updateCategory?: unknown;
306
+ /**
307
+ * @description Delete Category Link.
308
+ * @example https://sandboxapi.deere.com/platform/flagCategories/835b863c-1997-451d-8850-1123ff4ec0e3
309
+ */
310
+ deleteCategory?: unknown;
311
+ };
82
312
  LinkFlagId: {
83
313
  /**
84
314
  * @description Flag Category Preferences Link.
@@ -130,7 +360,31 @@ export interface components {
130
360
  */
131
361
  field?: unknown;
132
362
  };
133
- ContentType: unknown;
363
+ PutPreferences: {
364
+ /**
365
+ * @description Users Link.
366
+ * @example https://sandboxapi.deere.com/platform/users/USERNAME
367
+ */
368
+ modifiedBy?: unknown;
369
+ };
370
+ PutResponse: {
371
+ /**
372
+ * @description Name of the category.
373
+ * @example Rocks
374
+ */
375
+ categoryTitle?: string;
376
+ /**
377
+ * @description Whether or not the category is archived
378
+ * @default false
379
+ * @example false
380
+ */
381
+ archived: boolean;
382
+ /**
383
+ * @description Shows/sets whether the category is a preferred one in the current org. This can be applied to both user-defined and reference flag categories in this org.
384
+ * @example true
385
+ */
386
+ preferred?: boolean;
387
+ };
134
388
  ValuesFlagId: {
135
389
  /**
136
390
  * @description Currently only three geometries types (Point, LineString and Polygon) are supported.
@@ -244,38 +498,66 @@ export interface components {
244
498
  };
245
499
  };
246
500
  parameters: {
501
+ /** @description If embedding flag category, language that category name shall be returned within a flag, e.g., "de-DE" */
502
+ 'Accept-Language': string;
503
+ /** @description Language category names are being returned by the endpoint. */
504
+ 'Accept-Language_FlagCategories': string;
505
+ /** @description CategoryId to query for Category. */
506
+ CategoryId: string;
507
+ /** @description CategoryId to query for Category. */
508
+ CategoryId2: string;
509
+ /** @description CategoryId to query for preferences. */
510
+ CategoryId_FlagCategoriesPreferences: string;
511
+ /** @description Specify a comma-separated list of category GUIDs to retrieve */
512
+ CategoryIds: string;
513
+ /** @description Specify a comma-separated list of category names to retrieve. Instead/together with names, aliases for well known categories can be used */
514
+ CategoryNames: string;
515
+ /** @description Embed additional attributes if required to reduce the number of requests */
516
+ Embed: string;
517
+ /** @description Embed additional attributes if required. */
518
+ Embed_FlagCategories: string;
519
+ /** @description Flags created before end time (in UTC) will be returned */
520
+ EndTime: string;
247
521
  /** @description Fields guid of the field. */
248
522
  FieldId: string;
523
+ /** @description flagCategoryPreferencesId to query for preferences. */
524
+ FlagCategoryPreferencesId: string;
525
+ /** @description flagCategoryPreferencesId to query for preferences. */
526
+ FlagCategoryPreferencesId2: string;
527
+ /** @description flagId to query for flag */
528
+ FlagId: string;
529
+ /** @description Specify whether to request global flags, field-related flags or both */
530
+ FlagScopes: string;
531
+ /** @description Does not populate geometry, overrides simple if both are true */
532
+ MetadataOnly: boolean;
249
533
  /** @description Org Id to query for Flag */
250
534
  OrgId: string;
251
535
  /** @description Organization Id */
252
536
  OrgId2: string;
537
+ /** @description Organization Id. */
538
+ OrgId2_FlagCategories: string;
253
539
  /** @description Organization Id where the Flag belongs to */
254
540
  OrgId3: string;
255
- /** @description flagId to query for flag */
256
- FlagId: string;
257
- /** @description If embedding flag category, language that category name shall be returned within a flag, e.g., "de-DE" */
258
- 'Accept-Language': string;
259
- /** @description Embed additional attributes if required to reduce the number of requests */
260
- Embed: string;
261
- /** @description Flags created after start time (in UTC) will be returned */
262
- StartTime: string;
263
- /** @description Flags created before end time (in UTC) will be returned */
264
- EndTime: string;
265
- /** @description Specify a comma-separated list of category GUIDs to retrieve */
266
- CategoryIds: string;
267
- /** @description Specify a comma-separated list of category names to retrieve. Instead/together with names, aliases for well known categories can be used */
268
- CategoryNames: string;
541
+ /** @description OrgId to query for Category */
542
+ OrgId3_FlagCategories: string;
543
+ /** @description Organization Id where the Flag category belongs to */
544
+ OrgId4: string;
545
+ /** @description OrgId to query for Org. */
546
+ OrgId_FlagCategories: string;
547
+ /** @description orgId to query for preferences. */
548
+ OrgId_FlagCategoriesPreferences: string;
549
+ /** @description orgId to query for preferences. */
550
+ OrganizationId: string;
551
+ /** @description CategoryId to query for preferences */
552
+ PrefKey: string;
269
553
  /** @description Request flags by archived status */
270
554
  RecordFilter: string;
271
- /** @description Specify whether to request global flags, field-related flags or both */
272
- FlagScopes: string;
273
555
  /** @description Clients which cannot handle specific geometry types can select only supported ones. Request flags with geometry only of type */
274
556
  ShapeTypes: string;
275
557
  /** @description Populates simplified geometry */
276
558
  Simple: boolean;
277
- /** @description Does not populate geometry, overrides simple if both are true */
278
- MetadataOnly: boolean;
559
+ /** @description Flags created after start time (in UTC) will be returned */
560
+ StartTime: string;
279
561
  };
280
562
  requestBodies: never;
281
563
  headers: never;
@@ -283,7 +565,7 @@ export interface components {
283
565
  }
284
566
  export type $defs = Record<string, never>;
285
567
  export interface operations {
286
- getFlagForOrganizationByFlagId: {
568
+ getOrgFieldFlags: {
287
569
  parameters: {
288
570
  query?: {
289
571
  /** @description Embed additional attributes if required to reduce the number of requests */
@@ -298,8 +580,6 @@ export interface operations {
298
580
  categoryNames?: components['parameters']['CategoryNames'];
299
581
  /** @description Request flags by archived status */
300
582
  recordFilter?: components['parameters']['RecordFilter'];
301
- /** @description Specify whether to request global flags, field-related flags or both */
302
- flagScopes?: components['parameters']['FlagScopes'];
303
583
  /** @description Clients which cannot handle specific geometry types can select only supported ones. Request flags with geometry only of type */
304
584
  shapeTypes?: components['parameters']['ShapeTypes'];
305
585
  /** @description Populates simplified geometry */
@@ -312,24 +592,24 @@ export interface operations {
312
592
  'Accept-Language'?: components['parameters']['Accept-Language'];
313
593
  };
314
594
  path: {
315
- /** @description Org Id to query for Flag */
316
- orgId: components['parameters']['OrgId'];
317
- /** @description flagId to query for flag */
318
- flagId: components['parameters']['FlagId'];
595
+ /** @description Organization Id where the Flag belongs to */
596
+ orgId: components['parameters']['OrgId3'];
597
+ /** @description Fields guid of the field. */
598
+ fieldId: components['parameters']['FieldId'];
319
599
  };
320
600
  cookie?: never;
321
601
  };
322
602
  requestBody?: never;
323
603
  responses: {
324
- 200: components['responses']['FlagIdGet'];
325
- /** @description Access forbidden. The user does not have permission to access the given organization. */
604
+ 200: components['responses']['GetOrgId'];
605
+ /** @description Forbidden. The user has no access to the given flag */
326
606
  403: {
327
607
  headers: {
328
608
  [name: string]: unknown;
329
609
  };
330
610
  content?: never;
331
611
  };
332
- /** @description Entity Not found. No organization present for given orgId or no flag id present in the given org id */
612
+ /** @description Entity Not found. No organization and/or field with these ids. */
333
613
  404: {
334
614
  headers: {
335
615
  [name: string]: unknown;
@@ -338,34 +618,202 @@ export interface operations {
338
618
  };
339
619
  };
340
620
  };
341
- updateFlagByIdOrgId: {
621
+ getFlagCategoriesForOrganization: {
342
622
  parameters: {
343
- query?: never;
344
- header?: never;
623
+ query?: {
624
+ /** @description Embed additional attributes if required. */
625
+ embed?: components['parameters']['Embed_FlagCategories'];
626
+ };
627
+ header?: {
628
+ /** @description Language category names are being returned by the endpoint. */
629
+ 'Accept-Language'?: components['parameters']['Accept-Language_FlagCategories'];
630
+ };
345
631
  path: {
346
- /** @description Organization Id */
347
- orgId: components['parameters']['OrgId2'];
348
- /** @description flagId to query for flag */
349
- flagId: components['parameters']['FlagId'];
632
+ /** @description Organization Id where the Flag category belongs to */
633
+ orgId: components['parameters']['OrgId4'];
350
634
  };
351
635
  cookie?: never;
352
636
  };
353
- requestBody?: {
354
- content: {
355
- 'application/vnd.deere.axiom.v3+json': components['schemas']['ValuesFlagIdPut'];
356
- };
357
- };
637
+ requestBody?: never;
358
638
  responses: {
359
- /** @description Update response by Flag Id */
639
+ /** @description Returns collection of flag categories which includes reference and user-defined categories. */
360
640
  200: {
361
641
  headers: {
362
642
  [name: string]: unknown;
363
643
  };
364
644
  content: {
365
- 'application/vnd.deere.axiom.v3+json': unknown;
645
+ 'application/vnd.deere.axiom.v3+json': {
646
+ links?: components['schemas']['LinkCategoryId2'][];
647
+ /**
648
+ * Format: int64
649
+ * @description Number of results in the list
650
+ * @example 70
651
+ */
652
+ total?: number;
653
+ values?: components['schemas']['FlagCategory2'][];
654
+ };
366
655
  };
367
656
  };
368
- /** @description - No contributionDefinition link specified - No category link specified */
657
+ /** @description Forbidden - Given Invalid orgId or the user dosen't have access for the given flagCategory or orgId. */
658
+ 403: {
659
+ headers: {
660
+ [name: string]: unknown;
661
+ };
662
+ content?: never;
663
+ };
664
+ /** @description Entity Not found. No organization present for given orgId. */
665
+ 404: {
666
+ headers: {
667
+ [name: string]: unknown;
668
+ };
669
+ content?: never;
670
+ };
671
+ };
672
+ };
673
+ createFlagCategory: {
674
+ parameters: {
675
+ query?: never;
676
+ header?: never;
677
+ path: {
678
+ /** @description Organization Id where the Flag category belongs to */
679
+ orgId: components['parameters']['OrgId4'];
680
+ };
681
+ cookie?: never;
682
+ };
683
+ /** @description This resource will create a custom category in the given organization. */
684
+ requestBody?: {
685
+ content: {
686
+ 'application/vnd.deere.axiom.v3+json': components['schemas']['PutResponse'];
687
+ };
688
+ };
689
+ responses: {
690
+ /** @description Created */
691
+ 200: {
692
+ headers: {
693
+ [name: string]: unknown;
694
+ };
695
+ content: {
696
+ 'application/vnd.deere.axiom.v3+json': {
697
+ /**
698
+ * Format: int32
699
+ * @example 1
700
+ */
701
+ total?: number;
702
+ };
703
+ };
704
+ };
705
+ /** @description Invalid body - Bad Request */
706
+ 400: {
707
+ headers: {
708
+ [name: string]: unknown;
709
+ };
710
+ content?: never;
711
+ };
712
+ /** @description Forbidden - Given Invalid orgId or the user doesn't have access for the given flagCategory or orgId. */
713
+ 403: {
714
+ headers: {
715
+ [name: string]: unknown;
716
+ };
717
+ content?: never;
718
+ };
719
+ /** @description Entity Not found. No organization present for given orgId or no contribution definition ID is found. */
720
+ 404: {
721
+ headers: {
722
+ [name: string]: unknown;
723
+ };
724
+ content?: never;
725
+ };
726
+ /** @description Conflict. User creates flag category with such title which is already being used in one of the existing category. */
727
+ 409: {
728
+ headers: {
729
+ [name: string]: unknown;
730
+ };
731
+ content?: never;
732
+ };
733
+ };
734
+ };
735
+ getFlagCategoryByIdOrgId: {
736
+ parameters: {
737
+ query?: {
738
+ /** @description Embed additional attributes if required. */
739
+ embed?: components['parameters']['Embed_FlagCategories'];
740
+ };
741
+ header?: {
742
+ /** @description Language category names are being returned by the endpoint. */
743
+ 'Accept-Language'?: components['parameters']['Accept-Language_FlagCategories'];
744
+ };
745
+ path: {
746
+ /** @description OrgId to query for Org. */
747
+ orgId: components['parameters']['OrgId_FlagCategories'];
748
+ /** @description CategoryId to query for Category. */
749
+ categoryId: components['parameters']['CategoryId'];
750
+ };
751
+ cookie?: never;
752
+ };
753
+ requestBody?: never;
754
+ responses: {
755
+ /** @description Returns flag category. */
756
+ 200: {
757
+ headers: {
758
+ [name: string]: unknown;
759
+ };
760
+ content: {
761
+ 'application/vnd.deere.axiom.v3+json': {
762
+ links?: unknown;
763
+ values?: unknown;
764
+ };
765
+ };
766
+ };
767
+ /** @description Forbidden - Given Invalid orgId or the user dosen't have access for the given flagCategory or orgId. */
768
+ 403: {
769
+ headers: {
770
+ [name: string]: unknown;
771
+ };
772
+ content?: never;
773
+ };
774
+ /** @description Entity Not found. No organization present for given orgId or given flag category does not exist */
775
+ 404: {
776
+ headers: {
777
+ [name: string]: unknown;
778
+ };
779
+ content?: never;
780
+ };
781
+ };
782
+ };
783
+ updateFlagCategoryByIdOrgId: {
784
+ parameters: {
785
+ query?: never;
786
+ header?: never;
787
+ path: {
788
+ /** @description Organization Id. */
789
+ orgId: components['parameters']['OrgId2_FlagCategories'];
790
+ /** @description CategoryId to query for Category. */
791
+ categoryId: components['parameters']['CategoryId2'];
792
+ };
793
+ cookie?: never;
794
+ };
795
+ requestBody?: {
796
+ content: {
797
+ 'application/vnd.deere.axiom.v3+json': components['schemas']['PutResponse'];
798
+ };
799
+ };
800
+ responses: {
801
+ /** @description No Content. Successfully updated. */
802
+ 200: {
803
+ headers: {
804
+ [name: string]: unknown;
805
+ };
806
+ content: {
807
+ 'application/vnd.deere.axiom.v3+json': {
808
+ /**
809
+ * Format: int32
810
+ * @example 1
811
+ */
812
+ total?: number;
813
+ };
814
+ };
815
+ };
816
+ /** @description Invalid body - Bad Request */
369
817
  400: {
370
818
  headers: {
371
819
  [name: string]: unknown;
@@ -379,7 +827,7 @@ export interface operations {
379
827
  };
380
828
  content?: never;
381
829
  };
382
- /** @description Entity Not found. Missing or incorrect flag id, or contributionDefinition is invalid Or incorrect org */
830
+ /** @description Entity Not found. Missing or incorrect categoryId in the org Or incorrect org */
383
831
  404: {
384
832
  headers: {
385
833
  [name: string]: unknown;
@@ -388,21 +836,21 @@ export interface operations {
388
836
  };
389
837
  };
390
838
  };
391
- deleteFlagByIdOrgId: {
839
+ deleteFlagCategoryByIdOrgId: {
392
840
  parameters: {
393
841
  query?: never;
394
842
  header?: never;
395
843
  path: {
396
- /** @description flagId to query for flag */
397
- flagId: components['parameters']['FlagId'];
398
- /** @description Org Id to query for Flag */
399
- orgId: components['parameters']['OrgId'];
844
+ /** @description OrgId to query for Category */
845
+ orgId: components['parameters']['OrgId3_FlagCategories'];
846
+ /** @description CategoryId to query for Category. */
847
+ categoryId: components['parameters']['CategoryId2'];
400
848
  };
401
849
  cookie?: never;
402
850
  };
403
851
  requestBody?: never;
404
852
  responses: {
405
- /** @description No Content. Flag deleted successfully. */
853
+ /** @description No Content. Flag Category deleted successfully. */
406
854
  200: {
407
855
  headers: {
408
856
  [name: string]: unknown;
@@ -417,14 +865,171 @@ export interface operations {
417
865
  };
418
866
  };
419
867
  };
420
- /** @description Forbidden. - The user has no permission to delete the flag. */
868
+ /** @description Forbidden. - Given Invalid orgId or the user dosen't have access for the given flagCategory or orgId. - The user has no permission to delete the flag category. */
421
869
  403: {
422
870
  headers: {
423
871
  [name: string]: unknown;
424
872
  };
425
873
  content?: never;
426
874
  };
427
- /** @description Entity Not found. Given flag id does not exist or given orgId does not present. */
875
+ /** @description Entity Not found. Given category id does not exist or given orgId does not exist. */
876
+ 404: {
877
+ headers: {
878
+ [name: string]: unknown;
879
+ };
880
+ content?: never;
881
+ };
882
+ };
883
+ };
884
+ getFlagCategoryPreferencesByIdOrgId: {
885
+ parameters: {
886
+ query?: {
887
+ /** @description CategoryId to query for preferences */
888
+ prefKey?: components['parameters']['PrefKey'];
889
+ };
890
+ header?: never;
891
+ path: {
892
+ /** @description orgId to query for preferences. */
893
+ organizationId: components['parameters']['OrganizationId'];
894
+ /** @description CategoryId to query for preferences. */
895
+ categoryId: components['parameters']['CategoryId_FlagCategoriesPreferences'];
896
+ };
897
+ cookie?: never;
898
+ };
899
+ requestBody?: never;
900
+ responses: {
901
+ /** @description Returns the preferences object for the given flag category. */
902
+ 200: {
903
+ headers: {
904
+ [name: string]: unknown;
905
+ };
906
+ content: {
907
+ 'application/vnd.deere.axiom.v3+json': {
908
+ links?: components['schemas']['GetPreferences'][];
909
+ /**
910
+ * Format: int64
911
+ * @description Number of results in the list
912
+ * @example 70
913
+ */
914
+ total?: number;
915
+ values?: unknown;
916
+ };
917
+ };
918
+ };
919
+ /** @description Forbidden - Given Invalid orgId or the user dosen't have access for the given flagCategory or orgId. */
920
+ 403: {
921
+ headers: {
922
+ [name: string]: unknown;
923
+ };
924
+ content?: never;
925
+ };
926
+ /** @description Entity Not found. No category with this id. */
927
+ 404: {
928
+ headers: {
929
+ [name: string]: unknown;
930
+ };
931
+ content?: never;
932
+ };
933
+ };
934
+ };
935
+ getFlagCategoryPreferenceByIdOrgId: {
936
+ parameters: {
937
+ query?: never;
938
+ header?: never;
939
+ path: {
940
+ /** @description orgId to query for preferences. */
941
+ orgId: components['parameters']['OrgId_FlagCategoriesPreferences'];
942
+ /** @description flagCategoryPreferencesId to query for preferences. */
943
+ flagCategoryPreferencesId: components['parameters']['FlagCategoryPreferencesId'];
944
+ };
945
+ cookie?: never;
946
+ };
947
+ requestBody?: never;
948
+ responses: {
949
+ /** @description Returns the preferences object identified by its global ID. */
950
+ 200: {
951
+ headers: {
952
+ [name: string]: unknown;
953
+ };
954
+ content: {
955
+ 'application/vnd.deere.axiom.v3+json': {
956
+ links?: components['schemas']['GetPreferences'][];
957
+ /**
958
+ * Format: int64
959
+ * @description Number of results in the list
960
+ * @example 70
961
+ */
962
+ total?: number;
963
+ values?: unknown;
964
+ };
965
+ };
966
+ };
967
+ /** @description Forbidden - Given Invalid orgId or the user dosen't have access for the given flagCategory or orgId. */
968
+ 403: {
969
+ headers: {
970
+ [name: string]: unknown;
971
+ };
972
+ content?: never;
973
+ };
974
+ /** @description Entity Not found. No reference category with this id. */
975
+ 404: {
976
+ headers: {
977
+ [name: string]: unknown;
978
+ };
979
+ content?: never;
980
+ };
981
+ };
982
+ };
983
+ updateFlagCategoryPreferenceByIdOrgId: {
984
+ parameters: {
985
+ query?: never;
986
+ header?: never;
987
+ path: {
988
+ /** @description orgId to query for preferences. */
989
+ organizationId: components['parameters']['OrganizationId'];
990
+ /** @description flagCategoryPreferencesId to query for preferences. */
991
+ flagCategoryPreferencesId: components['parameters']['FlagCategoryPreferencesId2'];
992
+ };
993
+ cookie?: never;
994
+ };
995
+ requestBody?: {
996
+ content: {
997
+ 'application/vnd.deere.axiom.v3+json': components['schemas']['FlagCategoryPreference'];
998
+ };
999
+ };
1000
+ responses: {
1001
+ /** @description No Content. Successfully updated. */
1002
+ 204: {
1003
+ headers: {
1004
+ [name: string]: unknown;
1005
+ };
1006
+ content: {
1007
+ 'application/vnd.deere.axiom.v3+json': {
1008
+ links?: components['schemas']['PutPreferences'][];
1009
+ /**
1010
+ * Format: int64
1011
+ * @description Number of results in the list
1012
+ * @example 70
1013
+ */
1014
+ total?: number;
1015
+ };
1016
+ };
1017
+ };
1018
+ /** @description Invalid body - Bad Request */
1019
+ 400: {
1020
+ headers: {
1021
+ [name: string]: unknown;
1022
+ };
1023
+ content?: never;
1024
+ };
1025
+ /** @description Forbidden - Given Invalid orgId or the user dosen't have access for the given flagCategory or orgId. */
1026
+ 403: {
1027
+ headers: {
1028
+ [name: string]: unknown;
1029
+ };
1030
+ content?: never;
1031
+ };
1032
+ /** @description Entity Not found. Incorrect flagCategoryPreferencesId. */
428
1033
  404: {
429
1034
  headers: {
430
1035
  [name: string]: unknown;
@@ -520,7 +1125,7 @@ export interface operations {
520
1125
  };
521
1126
  };
522
1127
  };
523
- getOrgFieldFlags: {
1128
+ getFlagForOrganizationByFlagId: {
524
1129
  parameters: {
525
1130
  query?: {
526
1131
  /** @description Embed additional attributes if required to reduce the number of requests */
@@ -535,6 +1140,8 @@ export interface operations {
535
1140
  categoryNames?: components['parameters']['CategoryNames'];
536
1141
  /** @description Request flags by archived status */
537
1142
  recordFilter?: components['parameters']['RecordFilter'];
1143
+ /** @description Specify whether to request global flags, field-related flags or both */
1144
+ flagScopes?: components['parameters']['FlagScopes'];
538
1145
  /** @description Clients which cannot handle specific geometry types can select only supported ones. Request flags with geometry only of type */
539
1146
  shapeTypes?: components['parameters']['ShapeTypes'];
540
1147
  /** @description Populates simplified geometry */
@@ -547,24 +1154,119 @@ export interface operations {
547
1154
  'Accept-Language'?: components['parameters']['Accept-Language'];
548
1155
  };
549
1156
  path: {
550
- /** @description Organization Id where the Flag belongs to */
551
- orgId: components['parameters']['OrgId3'];
552
- /** @description Fields guid of the field. */
553
- fieldId: components['parameters']['FieldId'];
1157
+ /** @description Org Id to query for Flag */
1158
+ orgId: components['parameters']['OrgId'];
1159
+ /** @description flagId to query for flag */
1160
+ flagId: components['parameters']['FlagId'];
554
1161
  };
555
1162
  cookie?: never;
556
1163
  };
557
1164
  requestBody?: never;
558
1165
  responses: {
559
- 200: components['responses']['GetOrgId'];
560
- /** @description Forbidden. The user has no access to the given flag */
1166
+ 200: components['responses']['FlagIdGet'];
1167
+ /** @description Access forbidden. The user does not have permission to access the given organization. */
561
1168
  403: {
562
1169
  headers: {
563
1170
  [name: string]: unknown;
564
1171
  };
565
1172
  content?: never;
566
1173
  };
567
- /** @description Entity Not found. No organization and/or field with these ids. */
1174
+ /** @description Entity Not found. No organization present for given orgId or no flag id present in the given org id */
1175
+ 404: {
1176
+ headers: {
1177
+ [name: string]: unknown;
1178
+ };
1179
+ content?: never;
1180
+ };
1181
+ };
1182
+ };
1183
+ updateFlagByIdOrgId: {
1184
+ parameters: {
1185
+ query?: never;
1186
+ header?: never;
1187
+ path: {
1188
+ /** @description Organization Id */
1189
+ orgId: components['parameters']['OrgId2'];
1190
+ /** @description flagId to query for flag */
1191
+ flagId: components['parameters']['FlagId'];
1192
+ };
1193
+ cookie?: never;
1194
+ };
1195
+ requestBody?: {
1196
+ content: {
1197
+ 'application/vnd.deere.axiom.v3+json': components['schemas']['ValuesFlagIdPut'];
1198
+ };
1199
+ };
1200
+ responses: {
1201
+ /** @description Update response by Flag Id */
1202
+ 200: {
1203
+ headers: {
1204
+ [name: string]: unknown;
1205
+ };
1206
+ content: {
1207
+ 'application/vnd.deere.axiom.v3+json': unknown;
1208
+ };
1209
+ };
1210
+ /** @description - No contributionDefinition link specified - No category link specified */
1211
+ 400: {
1212
+ headers: {
1213
+ [name: string]: unknown;
1214
+ };
1215
+ content?: never;
1216
+ };
1217
+ /** @description Forbidden Access */
1218
+ 403: {
1219
+ headers: {
1220
+ [name: string]: unknown;
1221
+ };
1222
+ content?: never;
1223
+ };
1224
+ /** @description Entity Not found. Missing or incorrect flag id, or contributionDefinition is invalid Or incorrect org */
1225
+ 404: {
1226
+ headers: {
1227
+ [name: string]: unknown;
1228
+ };
1229
+ content?: never;
1230
+ };
1231
+ };
1232
+ };
1233
+ deleteFlagByIdOrgId: {
1234
+ parameters: {
1235
+ query?: never;
1236
+ header?: never;
1237
+ path: {
1238
+ /** @description flagId to query for flag */
1239
+ flagId: components['parameters']['FlagId'];
1240
+ /** @description Org Id to query for Flag */
1241
+ orgId: components['parameters']['OrgId'];
1242
+ };
1243
+ cookie?: never;
1244
+ };
1245
+ requestBody?: never;
1246
+ responses: {
1247
+ /** @description No Content. Flag deleted successfully. */
1248
+ 200: {
1249
+ headers: {
1250
+ [name: string]: unknown;
1251
+ };
1252
+ content: {
1253
+ 'application/vnd.deere.axiom.v3+json': {
1254
+ /**
1255
+ * Format: int32
1256
+ * @example 1
1257
+ */
1258
+ total?: number;
1259
+ };
1260
+ };
1261
+ };
1262
+ /** @description Forbidden. - The user has no permission to delete the flag. */
1263
+ 403: {
1264
+ headers: {
1265
+ [name: string]: unknown;
1266
+ };
1267
+ content?: never;
1268
+ };
1269
+ /** @description Entity Not found. Given flag id does not exist or given orgId does not present. */
568
1270
  404: {
569
1271
  headers: {
570
1272
  [name: string]: unknown;