@azure-rest/agrifood-farming 1.0.0-beta.2 → 1.0.0-beta.3

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 (219) hide show
  1. package/README.md +16 -18
  2. package/dist/browser/clientDefinitions.d.ts +862 -0
  3. package/dist/browser/clientDefinitions.d.ts.map +1 -0
  4. package/dist/browser/clientDefinitions.js +4 -0
  5. package/dist/browser/clientDefinitions.js.map +1 -0
  6. package/dist/browser/farmBeats.d.ts +16 -0
  7. package/dist/browser/farmBeats.d.ts.map +1 -0
  8. package/dist/browser/farmBeats.js +43 -0
  9. package/dist/browser/farmBeats.js.map +1 -0
  10. package/dist/browser/index.d.ts +13 -0
  11. package/dist/browser/index.d.ts.map +1 -0
  12. package/dist/browser/index.js +15 -0
  13. package/dist/browser/index.js.map +1 -0
  14. package/dist/browser/isUnexpected.d.ts +199 -0
  15. package/dist/browser/isUnexpected.d.ts.map +1 -0
  16. package/{dist-esm/src → dist/browser}/isUnexpected.js +16 -16
  17. package/dist/browser/isUnexpected.js.map +1 -0
  18. package/dist/browser/logger.d.ts +2 -0
  19. package/dist/browser/logger.d.ts.map +1 -0
  20. package/dist/browser/logger.js +5 -0
  21. package/dist/browser/logger.js.map +1 -0
  22. package/dist/browser/models.d.ts +1301 -0
  23. package/dist/browser/models.d.ts.map +1 -0
  24. package/dist/browser/models.js +4 -0
  25. package/{dist-esm/src → dist/browser}/models.js.map +1 -1
  26. package/dist/browser/outputModels.d.ts +2620 -0
  27. package/dist/browser/outputModels.d.ts.map +1 -0
  28. package/dist/browser/outputModels.js +4 -0
  29. package/{dist-esm/src → dist/browser}/outputModels.js.map +1 -1
  30. package/dist/browser/package.json +3 -0
  31. package/dist/browser/paginateHelper.d.ts +68 -0
  32. package/dist/browser/paginateHelper.d.ts.map +1 -0
  33. package/dist/browser/paginateHelper.js +167 -0
  34. package/dist/browser/paginateHelper.js.map +1 -0
  35. package/dist/browser/parameters.d.ts +2749 -0
  36. package/dist/browser/parameters.d.ts.map +1 -0
  37. package/dist/browser/parameters.js +4 -0
  38. package/dist/browser/parameters.js.map +1 -0
  39. package/dist/browser/pollingHelper.d.ts +76 -0
  40. package/dist/browser/pollingHelper.d.ts.map +1 -0
  41. package/dist/browser/pollingHelper.js +104 -0
  42. package/dist/browser/pollingHelper.js.map +1 -0
  43. package/dist/browser/responses.d.ts +2890 -0
  44. package/dist/browser/responses.d.ts.map +1 -0
  45. package/dist/browser/responses.js +4 -0
  46. package/dist/browser/responses.js.map +1 -0
  47. package/dist/browser/serializeHelper.d.ts +2 -0
  48. package/dist/browser/serializeHelper.d.ts.map +1 -0
  49. package/{dist-esm/src → dist/browser}/serializeHelper.js +3 -3
  50. package/dist/browser/serializeHelper.js.map +1 -0
  51. package/dist/commonjs/clientDefinitions.d.ts +862 -0
  52. package/dist/commonjs/clientDefinitions.d.ts.map +1 -0
  53. package/dist/commonjs/clientDefinitions.js +5 -0
  54. package/dist/commonjs/clientDefinitions.js.map +1 -0
  55. package/dist/commonjs/farmBeats.d.ts +16 -0
  56. package/dist/commonjs/farmBeats.d.ts.map +1 -0
  57. package/dist/commonjs/farmBeats.js +46 -0
  58. package/dist/commonjs/farmBeats.js.map +1 -0
  59. package/dist/commonjs/index.d.ts +13 -0
  60. package/dist/commonjs/index.d.ts.map +1 -0
  61. package/dist/commonjs/index.js +18 -0
  62. package/dist/commonjs/index.js.map +1 -0
  63. package/dist/commonjs/isUnexpected.d.ts +199 -0
  64. package/dist/commonjs/isUnexpected.d.ts.map +1 -0
  65. package/dist/{index.js → commonjs/isUnexpected.js} +20 -186
  66. package/dist/commonjs/isUnexpected.js.map +1 -0
  67. package/dist/commonjs/logger.d.ts +2 -0
  68. package/dist/commonjs/logger.d.ts.map +1 -0
  69. package/dist/commonjs/logger.js +8 -0
  70. package/dist/commonjs/logger.js.map +1 -0
  71. package/dist/commonjs/models.d.ts +1301 -0
  72. package/dist/commonjs/models.d.ts.map +1 -0
  73. package/dist/commonjs/models.js +5 -0
  74. package/dist/commonjs/models.js.map +1 -0
  75. package/dist/commonjs/outputModels.d.ts +2620 -0
  76. package/dist/commonjs/outputModels.d.ts.map +1 -0
  77. package/dist/commonjs/outputModels.js +5 -0
  78. package/dist/commonjs/outputModels.js.map +1 -0
  79. package/dist/commonjs/package.json +3 -0
  80. package/dist/commonjs/paginateHelper.d.ts +68 -0
  81. package/dist/commonjs/paginateHelper.d.ts.map +1 -0
  82. package/dist/commonjs/paginateHelper.js +170 -0
  83. package/dist/commonjs/paginateHelper.js.map +1 -0
  84. package/dist/commonjs/parameters.d.ts +2749 -0
  85. package/dist/commonjs/parameters.d.ts.map +1 -0
  86. package/dist/commonjs/parameters.js +5 -0
  87. package/dist/commonjs/parameters.js.map +1 -0
  88. package/dist/commonjs/pollingHelper.d.ts +76 -0
  89. package/dist/commonjs/pollingHelper.d.ts.map +1 -0
  90. package/dist/commonjs/pollingHelper.js +107 -0
  91. package/dist/commonjs/pollingHelper.js.map +1 -0
  92. package/dist/commonjs/responses.d.ts +2890 -0
  93. package/dist/commonjs/responses.d.ts.map +1 -0
  94. package/dist/commonjs/responses.js +5 -0
  95. package/dist/commonjs/responses.js.map +1 -0
  96. package/dist/commonjs/serializeHelper.d.ts +2 -0
  97. package/dist/commonjs/serializeHelper.d.ts.map +1 -0
  98. package/dist/commonjs/serializeHelper.js +16 -0
  99. package/dist/commonjs/serializeHelper.js.map +1 -0
  100. package/dist/commonjs/tsdoc-metadata.json +11 -0
  101. package/dist/esm/clientDefinitions.d.ts +862 -0
  102. package/dist/esm/clientDefinitions.d.ts.map +1 -0
  103. package/dist/esm/clientDefinitions.js +4 -0
  104. package/dist/esm/clientDefinitions.js.map +1 -0
  105. package/dist/esm/farmBeats.d.ts +16 -0
  106. package/dist/esm/farmBeats.d.ts.map +1 -0
  107. package/dist/esm/farmBeats.js +43 -0
  108. package/dist/esm/farmBeats.js.map +1 -0
  109. package/dist/esm/index.d.ts +13 -0
  110. package/dist/esm/index.d.ts.map +1 -0
  111. package/dist/esm/index.js +15 -0
  112. package/dist/esm/index.js.map +1 -0
  113. package/dist/esm/isUnexpected.d.ts +199 -0
  114. package/dist/esm/isUnexpected.d.ts.map +1 -0
  115. package/dist/esm/isUnexpected.js +269 -0
  116. package/dist/esm/isUnexpected.js.map +1 -0
  117. package/dist/esm/logger.d.ts +2 -0
  118. package/dist/esm/logger.d.ts.map +1 -0
  119. package/dist/esm/logger.js +5 -0
  120. package/dist/esm/logger.js.map +1 -0
  121. package/dist/esm/models.d.ts +1301 -0
  122. package/dist/esm/models.d.ts.map +1 -0
  123. package/dist/esm/models.js +4 -0
  124. package/dist/esm/models.js.map +1 -0
  125. package/dist/esm/outputModels.d.ts +2620 -0
  126. package/dist/esm/outputModels.d.ts.map +1 -0
  127. package/dist/esm/outputModels.js +4 -0
  128. package/dist/esm/outputModels.js.map +1 -0
  129. package/dist/esm/package.json +3 -0
  130. package/dist/esm/paginateHelper.d.ts +68 -0
  131. package/dist/esm/paginateHelper.d.ts.map +1 -0
  132. package/dist/esm/paginateHelper.js +167 -0
  133. package/dist/esm/paginateHelper.js.map +1 -0
  134. package/dist/esm/parameters.d.ts +2749 -0
  135. package/dist/esm/parameters.d.ts.map +1 -0
  136. package/dist/esm/parameters.js +4 -0
  137. package/dist/esm/parameters.js.map +1 -0
  138. package/dist/esm/pollingHelper.d.ts +76 -0
  139. package/dist/esm/pollingHelper.d.ts.map +1 -0
  140. package/dist/esm/pollingHelper.js +104 -0
  141. package/dist/esm/pollingHelper.js.map +1 -0
  142. package/dist/esm/responses.d.ts +2890 -0
  143. package/dist/esm/responses.d.ts.map +1 -0
  144. package/dist/esm/responses.js +4 -0
  145. package/dist/esm/responses.js.map +1 -0
  146. package/dist/esm/serializeHelper.d.ts +2 -0
  147. package/dist/esm/serializeHelper.d.ts.map +1 -0
  148. package/dist/esm/serializeHelper.js +13 -0
  149. package/dist/esm/serializeHelper.js.map +1 -0
  150. package/dist/react-native/clientDefinitions.d.ts +862 -0
  151. package/dist/react-native/clientDefinitions.d.ts.map +1 -0
  152. package/dist/react-native/clientDefinitions.js +4 -0
  153. package/dist/react-native/clientDefinitions.js.map +1 -0
  154. package/dist/react-native/farmBeats.d.ts +16 -0
  155. package/dist/react-native/farmBeats.d.ts.map +1 -0
  156. package/dist/react-native/farmBeats.js +43 -0
  157. package/dist/react-native/farmBeats.js.map +1 -0
  158. package/dist/react-native/index.d.ts +13 -0
  159. package/dist/react-native/index.d.ts.map +1 -0
  160. package/dist/react-native/index.js +15 -0
  161. package/dist/react-native/index.js.map +1 -0
  162. package/dist/react-native/isUnexpected.d.ts +199 -0
  163. package/dist/react-native/isUnexpected.d.ts.map +1 -0
  164. package/dist/react-native/isUnexpected.js +269 -0
  165. package/dist/react-native/isUnexpected.js.map +1 -0
  166. package/dist/react-native/logger.d.ts +2 -0
  167. package/dist/react-native/logger.d.ts.map +1 -0
  168. package/dist/react-native/logger.js +5 -0
  169. package/dist/react-native/logger.js.map +1 -0
  170. package/dist/react-native/models.d.ts +1301 -0
  171. package/dist/react-native/models.d.ts.map +1 -0
  172. package/dist/react-native/models.js +4 -0
  173. package/dist/react-native/models.js.map +1 -0
  174. package/dist/react-native/outputModels.d.ts +2620 -0
  175. package/dist/react-native/outputModels.d.ts.map +1 -0
  176. package/dist/react-native/outputModels.js +4 -0
  177. package/dist/react-native/outputModels.js.map +1 -0
  178. package/dist/react-native/package.json +3 -0
  179. package/dist/react-native/paginateHelper.d.ts +68 -0
  180. package/dist/react-native/paginateHelper.d.ts.map +1 -0
  181. package/dist/react-native/paginateHelper.js +167 -0
  182. package/dist/react-native/paginateHelper.js.map +1 -0
  183. package/dist/react-native/parameters.d.ts +2749 -0
  184. package/dist/react-native/parameters.d.ts.map +1 -0
  185. package/dist/react-native/parameters.js +4 -0
  186. package/dist/react-native/parameters.js.map +1 -0
  187. package/dist/react-native/pollingHelper.d.ts +76 -0
  188. package/dist/react-native/pollingHelper.d.ts.map +1 -0
  189. package/dist/react-native/pollingHelper.js +104 -0
  190. package/dist/react-native/pollingHelper.js.map +1 -0
  191. package/dist/react-native/responses.d.ts +2890 -0
  192. package/dist/react-native/responses.d.ts.map +1 -0
  193. package/dist/react-native/responses.js +4 -0
  194. package/dist/react-native/responses.js.map +1 -0
  195. package/dist/react-native/serializeHelper.d.ts +2 -0
  196. package/dist/react-native/serializeHelper.d.ts.map +1 -0
  197. package/dist/react-native/serializeHelper.js +13 -0
  198. package/dist/react-native/serializeHelper.js.map +1 -0
  199. package/package.json +79 -66
  200. package/dist/index.js.map +0 -1
  201. package/dist-esm/src/clientDefinitions.js +0 -4
  202. package/dist-esm/src/clientDefinitions.js.map +0 -1
  203. package/dist-esm/src/farmBeats.js +0 -27
  204. package/dist-esm/src/farmBeats.js.map +0 -1
  205. package/dist-esm/src/index.js +0 -15
  206. package/dist-esm/src/index.js.map +0 -1
  207. package/dist-esm/src/isUnexpected.js.map +0 -1
  208. package/dist-esm/src/models.js +0 -4
  209. package/dist-esm/src/outputModels.js +0 -4
  210. package/dist-esm/src/paginateHelper.js +0 -70
  211. package/dist-esm/src/paginateHelper.js.map +0 -1
  212. package/dist-esm/src/parameters.js +0 -4
  213. package/dist-esm/src/parameters.js.map +0 -1
  214. package/dist-esm/src/pollingHelper.js +0 -50
  215. package/dist-esm/src/pollingHelper.js.map +0 -1
  216. package/dist-esm/src/responses.js +0 -4
  217. package/dist-esm/src/responses.js.map +0 -1
  218. package/dist-esm/src/serializeHelper.js.map +0 -1
  219. package/types/agrifood-farming-rest.d.ts +0 -12267
@@ -0,0 +1,2620 @@
1
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
2
+ export interface ApplicationDataListResponseOutput {
3
+ /** List of requested objects. */
4
+ value: Array<ApplicationDataOutput>;
5
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
6
+ skipToken?: string;
7
+ /** Continuation link (absolute URI) to the next page of results in the list. */
8
+ nextLink?: string;
9
+ }
10
+ /** Schema of application data resource. */
11
+ export interface ApplicationDataOutput {
12
+ /** Application product details. */
13
+ applicationProductDetails?: Array<ApplicationProductDetailOutput>;
14
+ /** Schema for storing measurement reading and unit. */
15
+ avgMaterial?: MeasureOutput;
16
+ /** Schema for storing measurement reading and unit. */
17
+ totalMaterial?: MeasureOutput;
18
+ /** Schema for storing measurement reading and unit. */
19
+ area?: MeasureOutput;
20
+ /**
21
+ * Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.
22
+ * Note: this will be specified by the source provider itself.
23
+ */
24
+ operationModifiedDateTime?: string;
25
+ /** Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */
26
+ operationStartDateTime?: string;
27
+ /** End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */
28
+ operationEndDateTime?: string;
29
+ /** Link for attachments. */
30
+ readonly attachmentsLink?: string;
31
+ /** Optional boundary ID of the field for which operation was applied. */
32
+ associatedBoundaryId?: string;
33
+ /** Party ID which belongs to the operation data. */
34
+ readonly partyId?: string;
35
+ /** Unique resource ID. */
36
+ readonly id?: string;
37
+ /** The ETag value to implement optimistic concurrency. */
38
+ readonly eTag?: string;
39
+ /** Status of the resource. */
40
+ status?: string;
41
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
42
+ readonly createdDateTime?: string;
43
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
44
+ readonly modifiedDateTime?: string;
45
+ /** Source of the resource. */
46
+ source?: string;
47
+ /** Name to identify resource. */
48
+ name?: string;
49
+ /** Textual description of the resource. */
50
+ description?: string;
51
+ /** Created by user/tenant id. */
52
+ readonly createdBy?: string;
53
+ /** Modified by user/tenant id. */
54
+ readonly modifiedBy?: string;
55
+ /**
56
+ * A collection of key value pairs that belongs to the resource.
57
+ * Each pair must not have a key greater than 50 characters
58
+ * and must not have a value greater than 150 characters.
59
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
60
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
61
+ */
62
+ properties?: Record<string, any>;
63
+ }
64
+ /** Schema of product used during application. */
65
+ export interface ApplicationProductDetailOutput {
66
+ /** Name of the product applied. */
67
+ productName?: string;
68
+ /** A flag indicating whether product is a carrier for a tank mix. */
69
+ isCarrier?: boolean;
70
+ /** Schema for storing measurement reading and unit. */
71
+ avgMaterial?: MeasureOutput;
72
+ /** Schema for storing measurement reading and unit. */
73
+ totalMaterial?: MeasureOutput;
74
+ }
75
+ /** Schema for storing measurement reading and unit. */
76
+ export interface MeasureOutput {
77
+ /** Data unit. */
78
+ unit?: string;
79
+ /** Data value. */
80
+ value?: number;
81
+ }
82
+ /** An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document. */
83
+ export interface ErrorResponseOutput {
84
+ /** An error from the Azure AgPlatform service. */
85
+ error?: ErrorModelOutput;
86
+ /** Unique trace Id. */
87
+ traceId?: string;
88
+ }
89
+ /** An error from the Azure AgPlatform service. */
90
+ export interface ErrorModelOutput {
91
+ /** Server-defined set of error codes. */
92
+ code: string;
93
+ /** Human-readable representation of the error. */
94
+ message: string;
95
+ /** Target of the error. */
96
+ target?: string;
97
+ /** Array of details about specific errors that led to this reported error. */
98
+ details?: Array<ErrorModelOutput>;
99
+ /** Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document. */
100
+ innererror?: InnerErrorOutput;
101
+ }
102
+ /** Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document. */
103
+ export interface InnerErrorOutput {
104
+ /** Specific error code than was provided by the containing error. */
105
+ code?: string;
106
+ /** Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document. */
107
+ innererror?: InnerErrorOutput;
108
+ }
109
+ /** Schema of cascade delete job. */
110
+ export interface CascadeDeleteJobOutput {
111
+ /** Party Id. */
112
+ partyId: string;
113
+ /** The id of the resource. */
114
+ resourceId: string;
115
+ /** The type of the resource. */
116
+ resourceType: string;
117
+ /** Unique job id. */
118
+ readonly id?: string;
119
+ /**
120
+ * Status of the job.
121
+ * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
122
+ */
123
+ readonly status?: "Waiting" | "Running" | "Succeeded" | "Failed" | "Cancelled";
124
+ /** Duration of the job in seconds. */
125
+ readonly durationInSeconds?: number;
126
+ /** Status message to capture more details of the job. */
127
+ readonly message?: string;
128
+ /** Error Code when job failed. */
129
+ readonly errorCode?: string;
130
+ /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
131
+ readonly createdDateTime?: string;
132
+ /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
133
+ readonly lastActionDateTime?: string;
134
+ /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
135
+ readonly startTime?: string;
136
+ /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
137
+ readonly endTime?: string;
138
+ }
139
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
140
+ export interface AttachmentListResponseOutput {
141
+ /** List of requested objects. */
142
+ value: Array<AttachmentOutput>;
143
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
144
+ skipToken?: string;
145
+ /** Continuation link (absolute URI) to the next page of results in the list. */
146
+ nextLink?: string;
147
+ }
148
+ /** Schema of attachment resource. */
149
+ export interface AttachmentOutput {
150
+ /** Associated Resource id for this attachment. */
151
+ resourceId?: string;
152
+ /** Associated Resource type for this attachment. */
153
+ resourceType?: "Party" | "Farm" | "Field" | "SeasonalField" | "Boundary" | "ApplicationData" | "HarvestData" | "TillageData" | "PlantingData" | "PlantTissueAnalysis";
154
+ /** Original File Name for this attachment. */
155
+ readonly originalFileName?: string;
156
+ /** PartyId id for this attachment. */
157
+ readonly partyId?: string;
158
+ /** Unique id. */
159
+ readonly id?: string;
160
+ /** Status of the resource. */
161
+ status?: string;
162
+ /** Date when resource was created. */
163
+ readonly createdDateTime?: string;
164
+ /** Date when resource was last modified. */
165
+ readonly modifiedDateTime?: string;
166
+ /** Source of the resource. */
167
+ source?: string;
168
+ /** Name to identify resource. */
169
+ name?: string;
170
+ /** Textual description of resource. */
171
+ description?: string;
172
+ /** Created by user/tenant id. */
173
+ readonly createdBy?: string;
174
+ /** Modified by user/tenant id. */
175
+ readonly modifiedBy?: string;
176
+ /** The ETag value to implement optimistic concurrency. */
177
+ readonly eTag?: string;
178
+ }
179
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
180
+ export interface BoundaryMetadataListResponseOutput {
181
+ /** List of requested objects. */
182
+ value: Array<BoundaryMetadataOutput>;
183
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
184
+ skipToken?: string;
185
+ /** Continuation link (absolute URI) to the next page of results in the list. */
186
+ nextLink?: string;
187
+ }
188
+ /** Schema of boundary resource metadata. */
189
+ export interface BoundaryMetadataOutput {
190
+ /** Party Id. */
191
+ readonly partyId?: string;
192
+ /** Id of the parent it belongs to. */
193
+ parentId?: string;
194
+ /** Schema for storing measurement reading and unit. */
195
+ area?: MeasureOutput;
196
+ /** Type of the parent it belongs to. */
197
+ readonly parentType?: "Field" | "SeasonalField" | "Zone" | "Prescription" | "PlantTissueAnalysis" | "ApplicationData" | "PlantingData" | "TillageData" | "HarvestData";
198
+ /** Type it belongs to. */
199
+ type?: string;
200
+ /** Unique resource ID. */
201
+ readonly id?: string;
202
+ /** The ETag value to implement optimistic concurrency. */
203
+ readonly eTag?: string;
204
+ /** Status of the resource. */
205
+ status?: string;
206
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
207
+ readonly createdDateTime?: string;
208
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
209
+ readonly modifiedDateTime?: string;
210
+ /** Source of the resource. */
211
+ source?: string;
212
+ /** Name to identify resource. */
213
+ name?: string;
214
+ /** Textual description of the resource. */
215
+ description?: string;
216
+ /** Created by user/tenant id. */
217
+ readonly createdBy?: string;
218
+ /** Modified by user/tenant id. */
219
+ readonly modifiedBy?: string;
220
+ /**
221
+ * A collection of key value pairs that belongs to the resource.
222
+ * Each pair must not have a key greater than 50 characters
223
+ * and must not have a value greater than 150 characters.
224
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
225
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
226
+ */
227
+ properties?: Record<string, any>;
228
+ }
229
+ /** GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. */
230
+ export interface GeoJsonObjectOutputParent {
231
+ type: "GeoJsonObject" | "MultiPolygon" | "Point" | "Polygon";
232
+ }
233
+ /** Schema of boundary resource. */
234
+ export interface BoundaryOutput {
235
+ /** GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. */
236
+ geometry?: GeoJsonObjectOutput;
237
+ /** Indicates the type of boundary belonging to a parent. */
238
+ type?: string;
239
+ /** Coordinate Reference System. */
240
+ readonly crs?: string;
241
+ /** GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. */
242
+ centroid?: GeoJsonObjectOutput;
243
+ /** GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. */
244
+ bbox?: GeoJsonObjectOutput;
245
+ /** Party Id. */
246
+ readonly partyId?: string;
247
+ /** Id of the parent it belongs to. */
248
+ parentId?: string;
249
+ /** Schema for storing measurement reading and unit. */
250
+ area?: MeasureOutput;
251
+ /**
252
+ * Type of the parent it belongs to.
253
+ * i.e. Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.
254
+ */
255
+ parentType?: "Field" | "SeasonalField" | "Zone" | "Prescription" | "PlantTissueAnalysis" | "ApplicationData" | "PlantingData" | "TillageData" | "HarvestData";
256
+ /** Unique resource ID. */
257
+ readonly id?: string;
258
+ /** The ETag value to implement optimistic concurrency. */
259
+ readonly eTag?: string;
260
+ /** Status of the resource. */
261
+ status?: string;
262
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
263
+ readonly createdDateTime?: string;
264
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
265
+ readonly modifiedDateTime?: string;
266
+ /** Source of the resource. */
267
+ source?: string;
268
+ /** Name to identify resource. */
269
+ name?: string;
270
+ /** Textual description of the resource. */
271
+ description?: string;
272
+ /** Created by user/tenant id. */
273
+ readonly createdBy?: string;
274
+ /** Modified by user/tenant id. */
275
+ readonly modifiedBy?: string;
276
+ /**
277
+ * A collection of key value pairs that belongs to the resource.
278
+ * Each pair must not have a key greater than 50 characters
279
+ * and must not have a value greater than 150 characters.
280
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
281
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
282
+ */
283
+ properties?: Record<string, any>;
284
+ }
285
+ /** Schema of boundary overlap response. */
286
+ export interface BoundaryOverlapResponseOutput {
287
+ /** Acreage of Main boundary. */
288
+ boundaryArea?: number;
289
+ /** Acreage of other boundary. */
290
+ otherBoundaryArea?: number;
291
+ /** Acreage of intersecting boundary. */
292
+ intersectingArea?: number;
293
+ }
294
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
295
+ export interface CropProductListResponseOutput {
296
+ /** List of requested objects. */
297
+ value: Array<CropProductOutput>;
298
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
299
+ skipToken?: string;
300
+ /** Continuation link (absolute URI) to the next page of results in the list. */
301
+ nextLink?: string;
302
+ }
303
+ /** Schema of crop product resource. */
304
+ export interface CropProductOutput {
305
+ /**
306
+ * Ids of the crops it belongs to.
307
+ * Note: A maximum of 25 crops can be associated with a cropProduct.
308
+ */
309
+ cropIds?: Array<string>;
310
+ /** CropProduct Brand. */
311
+ brand?: string;
312
+ /** CropProduct product. */
313
+ product?: string;
314
+ /** CropProduct trait. */
315
+ trait?: string;
316
+ /** Schema for storing measurement reading and unit. */
317
+ relativeMaturity?: MeasureOutput;
318
+ /** CropProduct treatments. */
319
+ treatments?: Array<string>;
320
+ /** Unique resource ID. */
321
+ readonly id?: string;
322
+ /** The ETag value to implement optimistic concurrency. */
323
+ readonly eTag?: string;
324
+ /** Status of the resource. */
325
+ status?: string;
326
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
327
+ readonly createdDateTime?: string;
328
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
329
+ readonly modifiedDateTime?: string;
330
+ /** Source of the resource. */
331
+ source?: string;
332
+ /** Name to identify resource. */
333
+ name?: string;
334
+ /** Textual description of the resource. */
335
+ description?: string;
336
+ /** Created by user/tenant id. */
337
+ readonly createdBy?: string;
338
+ /** Modified by user/tenant id. */
339
+ readonly modifiedBy?: string;
340
+ /**
341
+ * A collection of key value pairs that belongs to the resource.
342
+ * Each pair must not have a key greater than 50 characters
343
+ * and must not have a value greater than 150 characters.
344
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
345
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
346
+ */
347
+ properties?: Record<string, any>;
348
+ }
349
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
350
+ export interface CropListResponseOutput {
351
+ /** List of requested objects. */
352
+ value: Array<CropOutput>;
353
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
354
+ skipToken?: string;
355
+ /** Continuation link (absolute URI) to the next page of results in the list. */
356
+ nextLink?: string;
357
+ }
358
+ /** Schema of crop resource. */
359
+ export interface CropOutput {
360
+ /** Crop phenotype. */
361
+ phenotype?: string;
362
+ /** Breeding Method. */
363
+ breedingMethod?: "VARIETY" | "HYBRID" | "UNKNOWN";
364
+ /** Measurements. */
365
+ measurements?: Record<string, MeasureOutput>;
366
+ /** Unique resource ID. */
367
+ readonly id?: string;
368
+ /** The ETag value to implement optimistic concurrency. */
369
+ readonly eTag?: string;
370
+ /** Status of the resource. */
371
+ status?: string;
372
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
373
+ readonly createdDateTime?: string;
374
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
375
+ readonly modifiedDateTime?: string;
376
+ /** Source of the resource. */
377
+ source?: string;
378
+ /** Name to identify resource. */
379
+ name?: string;
380
+ /** Textual description of the resource. */
381
+ description?: string;
382
+ /** Created by user/tenant id. */
383
+ readonly createdBy?: string;
384
+ /** Modified by user/tenant id. */
385
+ readonly modifiedBy?: string;
386
+ /**
387
+ * A collection of key value pairs that belongs to the resource.
388
+ * Each pair must not have a key greater than 50 characters
389
+ * and must not have a value greater than 150 characters.
390
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
391
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
392
+ */
393
+ properties?: Record<string, any>;
394
+ }
395
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
396
+ export interface DeviceDataModelListResponseOutput {
397
+ /** List of requested objects. */
398
+ value: Array<DeviceDataModelOutput>;
399
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
400
+ skipToken?: string;
401
+ /** Continuation link (absolute URI) to the next page of results in the list. */
402
+ nextLink?: string;
403
+ }
404
+ /** DeviceDataModel API model. */
405
+ export interface DeviceDataModelOutput {
406
+ /** Type of device. */
407
+ type?: string;
408
+ /** Device manufacturer. */
409
+ manufacturer?: string;
410
+ /** Device productCode. */
411
+ productCode?: string;
412
+ /** List of device ports supported. */
413
+ ports?: Array<PortOutput>;
414
+ /** Id of the associated sensor partner. */
415
+ readonly sensorPartnerId?: string;
416
+ /** Id of the resource. */
417
+ readonly id?: string;
418
+ /** Status of the resource. */
419
+ status?: string;
420
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
421
+ readonly createdDateTime?: string;
422
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
423
+ readonly modifiedDateTime?: string;
424
+ /** The ETag value to implement optimistic concurrency. */
425
+ readonly eTag?: string;
426
+ /** Name to identify resource. */
427
+ name?: string;
428
+ /** Textual description of the resource. */
429
+ description?: string;
430
+ /** Created by user/tenant id. */
431
+ readonly createdBy?: string;
432
+ /** Modified by user/tenant id. */
433
+ readonly modifiedBy?: string;
434
+ /**
435
+ * A collection of key value pairs that belongs to the resource.
436
+ * Each pair must not have a key greater than 50 characters
437
+ * and must not have a value greater than 150 characters.
438
+ * Note: A maximum of 25 key value pairs can be provided for a resource and
439
+ * only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
440
+ */
441
+ properties?: Record<string, any>;
442
+ }
443
+ /** Schema for storing port values. */
444
+ export interface PortOutput {
445
+ /** Name of the port. */
446
+ name?: string;
447
+ /** Type of port digital/analog. */
448
+ type?: string;
449
+ }
450
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
451
+ export interface DeviceListResponseOutput {
452
+ /** List of requested objects. */
453
+ value: Array<DeviceOutput>;
454
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
455
+ skipToken?: string;
456
+ /** Continuation link (absolute URI) to the next page of results in the list. */
457
+ nextLink?: string;
458
+ }
459
+ /** Device API model. */
460
+ export interface DeviceOutput {
461
+ /** Id of the associated device data model. */
462
+ deviceDataModelId?: string;
463
+ /** Integration id for the device. */
464
+ integrationId?: string;
465
+ /** Type of device. */
466
+ type?: string;
467
+ /** Device hardwareId. */
468
+ hardwareId?: string;
469
+ /** Interval at which the device sends data in seconds. */
470
+ reportingIntervalInSeconds?: number;
471
+ /** Parent device Id for this device. */
472
+ parentDeviceId?: string;
473
+ /** Location model class. */
474
+ location?: LocationOutput;
475
+ /** Id of the associated sensor partner. */
476
+ readonly sensorPartnerId?: string;
477
+ /** Id of the resource. */
478
+ readonly id?: string;
479
+ /** Status of the resource. */
480
+ status?: string;
481
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
482
+ readonly createdDateTime?: string;
483
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
484
+ readonly modifiedDateTime?: string;
485
+ /** The ETag value to implement optimistic concurrency. */
486
+ readonly eTag?: string;
487
+ /** Name to identify resource. */
488
+ name?: string;
489
+ /** Textual description of the resource. */
490
+ description?: string;
491
+ /** Created by user/tenant id. */
492
+ readonly createdBy?: string;
493
+ /** Modified by user/tenant id. */
494
+ readonly modifiedBy?: string;
495
+ /**
496
+ * A collection of key value pairs that belongs to the resource.
497
+ * Each pair must not have a key greater than 50 characters
498
+ * and must not have a value greater than 150 characters.
499
+ * Note: A maximum of 25 key value pairs can be provided for a resource and
500
+ * only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
501
+ */
502
+ properties?: Record<string, any>;
503
+ }
504
+ /** Location model class. */
505
+ export interface LocationOutput {
506
+ /** Latitude of the location. */
507
+ latitude: number;
508
+ /** Longitude of the location. */
509
+ longitude: number;
510
+ }
511
+ /** Schema of farm operation data ingestion job. */
512
+ export interface FarmOperationDataIngestionJobOutput {
513
+ /** Party Id. */
514
+ partyId: string;
515
+ /** Authentication provider Id. */
516
+ authProviderId: string;
517
+ /** List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage. */
518
+ operations?: Array<string>;
519
+ /** Start Year (Minimum = 2000, Maximum = CurrentYear). */
520
+ startYear: number;
521
+ /** Use this to pull only the incremental changes from the last run. */
522
+ isIncremental?: boolean;
523
+ /** Unique job id. */
524
+ readonly id?: string;
525
+ /**
526
+ * Status of the job.
527
+ * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
528
+ */
529
+ readonly status?: string;
530
+ /** Duration of the job in seconds. */
531
+ readonly durationInSeconds?: number;
532
+ /** Status message to capture more details of the job. */
533
+ readonly message?: string;
534
+ /** Error Code when job failed. */
535
+ readonly errorCode?: string;
536
+ /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
537
+ readonly createdDateTime?: string;
538
+ /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
539
+ readonly lastActionDateTime?: string;
540
+ /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
541
+ readonly startTime?: string;
542
+ /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
543
+ readonly endTime?: string;
544
+ /** Name to identify resource. */
545
+ name?: string;
546
+ /** Textual description of the resource. */
547
+ description?: string;
548
+ /** Created by user/tenant id. */
549
+ readonly createdBy?: string;
550
+ /** Modified by user/tenant id. */
551
+ readonly modifiedBy?: string;
552
+ /**
553
+ * A collection of key value pairs that belongs to the resource.
554
+ * Each pair must not have a key greater than 50 characters
555
+ * and must not have a value greater than 150 characters.
556
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
557
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
558
+ */
559
+ properties?: Record<string, any>;
560
+ }
561
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
562
+ export interface FarmListResponseOutput {
563
+ /** List of requested objects. */
564
+ value: Array<FarmOutput>;
565
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
566
+ skipToken?: string;
567
+ /** Continuation link (absolute URI) to the next page of results in the list. */
568
+ nextLink?: string;
569
+ }
570
+ /** Schema of farm resource. */
571
+ export interface FarmOutput {
572
+ /** Party Id. */
573
+ readonly partyId?: string;
574
+ /** Unique resource ID. */
575
+ readonly id?: string;
576
+ /** The ETag value to implement optimistic concurrency. */
577
+ readonly eTag?: string;
578
+ /** Status of the resource. */
579
+ status?: string;
580
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
581
+ readonly createdDateTime?: string;
582
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
583
+ readonly modifiedDateTime?: string;
584
+ /** Source of the resource. */
585
+ source?: string;
586
+ /** Name to identify resource. */
587
+ name?: string;
588
+ /** Textual description of the resource. */
589
+ description?: string;
590
+ /** Created by user/tenant id. */
591
+ readonly createdBy?: string;
592
+ /** Modified by user/tenant id. */
593
+ readonly modifiedBy?: string;
594
+ /**
595
+ * A collection of key value pairs that belongs to the resource.
596
+ * Each pair must not have a key greater than 50 characters
597
+ * and must not have a value greater than 150 characters.
598
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
599
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
600
+ */
601
+ properties?: Record<string, any>;
602
+ }
603
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
604
+ export interface FieldListResponseOutput {
605
+ /** List of requested objects. */
606
+ value: Array<FieldOutput>;
607
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
608
+ skipToken?: string;
609
+ /** Continuation link (absolute URI) to the next page of results in the list. */
610
+ nextLink?: string;
611
+ }
612
+ /** Schema of field resource. */
613
+ export interface FieldOutput {
614
+ /** Id of the associated Farm. */
615
+ farmId?: string;
616
+ /** Party Id. */
617
+ readonly partyId?: string;
618
+ /** Unique resource ID. */
619
+ readonly id?: string;
620
+ /** The ETag value to implement optimistic concurrency. */
621
+ readonly eTag?: string;
622
+ /** Status of the resource. */
623
+ status?: string;
624
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
625
+ readonly createdDateTime?: string;
626
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
627
+ readonly modifiedDateTime?: string;
628
+ /** Source of the resource. */
629
+ source?: string;
630
+ /** Name to identify resource. */
631
+ name?: string;
632
+ /** Textual description of the resource. */
633
+ description?: string;
634
+ /** Created by user/tenant id. */
635
+ readonly createdBy?: string;
636
+ /** Modified by user/tenant id. */
637
+ readonly modifiedBy?: string;
638
+ /**
639
+ * A collection of key value pairs that belongs to the resource.
640
+ * Each pair must not have a key greater than 50 characters
641
+ * and must not have a value greater than 150 characters.
642
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
643
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
644
+ */
645
+ properties?: Record<string, any>;
646
+ }
647
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
648
+ export interface HarvestDataListResponseOutput {
649
+ /** List of requested objects. */
650
+ value: Array<HarvestDataOutput>;
651
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
652
+ skipToken?: string;
653
+ /** Continuation link (absolute URI) to the next page of results in the list. */
654
+ nextLink?: string;
655
+ }
656
+ /** Schema of harvest data resource. */
657
+ export interface HarvestDataOutput {
658
+ /** Schema for storing measurement reading and unit. */
659
+ totalYield?: MeasureOutput;
660
+ /** Schema for storing measurement reading and unit. */
661
+ avgYield?: MeasureOutput;
662
+ /** Schema for storing measurement reading and unit. */
663
+ totalWetMass?: MeasureOutput;
664
+ /** Schema for storing measurement reading and unit. */
665
+ avgWetMass?: MeasureOutput;
666
+ /** Schema for storing measurement reading and unit. */
667
+ avgMoisture?: MeasureOutput;
668
+ /** Schema for storing measurement reading and unit. */
669
+ avgSpeed?: MeasureOutput;
670
+ /** Harvest product details. */
671
+ harvestProductDetails?: Array<HarvestProductDetailOutput>;
672
+ /** Schema for storing measurement reading and unit. */
673
+ area?: MeasureOutput;
674
+ /**
675
+ * Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.
676
+ * Note: this will be specified by the source provider itself.
677
+ */
678
+ operationModifiedDateTime?: string;
679
+ /** Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */
680
+ operationStartDateTime?: string;
681
+ /** End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */
682
+ operationEndDateTime?: string;
683
+ /** Link for attachments. */
684
+ readonly attachmentsLink?: string;
685
+ /** Optional boundary ID of the field for which operation was applied. */
686
+ associatedBoundaryId?: string;
687
+ /** Party ID which belongs to the operation data. */
688
+ readonly partyId?: string;
689
+ /** Unique resource ID. */
690
+ readonly id?: string;
691
+ /** The ETag value to implement optimistic concurrency. */
692
+ readonly eTag?: string;
693
+ /** Status of the resource. */
694
+ status?: string;
695
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
696
+ readonly createdDateTime?: string;
697
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
698
+ readonly modifiedDateTime?: string;
699
+ /** Source of the resource. */
700
+ source?: string;
701
+ /** Name to identify resource. */
702
+ name?: string;
703
+ /** Textual description of the resource. */
704
+ description?: string;
705
+ /** Created by user/tenant id. */
706
+ readonly createdBy?: string;
707
+ /** Modified by user/tenant id. */
708
+ readonly modifiedBy?: string;
709
+ /**
710
+ * A collection of key value pairs that belongs to the resource.
711
+ * Each pair must not have a key greater than 50 characters
712
+ * and must not have a value greater than 150 characters.
713
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
714
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
715
+ */
716
+ properties?: Record<string, any>;
717
+ }
718
+ /** Schema of product used during harvesting. */
719
+ export interface HarvestProductDetailOutput {
720
+ /** Name of the product. */
721
+ productName?: string;
722
+ /** Schema for storing measurement reading and unit. */
723
+ area?: MeasureOutput;
724
+ /** Schema for storing measurement reading and unit. */
725
+ totalYield?: MeasureOutput;
726
+ /** Schema for storing measurement reading and unit. */
727
+ avgYield?: MeasureOutput;
728
+ /** Schema for storing measurement reading and unit. */
729
+ avgMoisture?: MeasureOutput;
730
+ /** Schema for storing measurement reading and unit. */
731
+ totalWetMass?: MeasureOutput;
732
+ /** Schema for storing measurement reading and unit. */
733
+ avgWetMass?: MeasureOutput;
734
+ }
735
+ /** Image Processing Rasterize Job to convert shapefile into tiff file. */
736
+ export interface ImageProcessingRasterizeJobOutput {
737
+ /** Party Id. */
738
+ partyId: string;
739
+ /** Shapefile attachment Id. */
740
+ shapefileAttachmentId: string;
741
+ /** List of shapefile column names to create raster attachments. */
742
+ shapefileColumnNames: Array<string>;
743
+ /** Unique job id. */
744
+ readonly id?: string;
745
+ /**
746
+ * Status of the job.
747
+ * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
748
+ */
749
+ readonly status?: string;
750
+ /** Duration of the job in seconds. */
751
+ readonly durationInSeconds?: number;
752
+ /** Status message to capture more details of the job. */
753
+ readonly message?: string;
754
+ /** Error Code when job failed. */
755
+ readonly errorCode?: string;
756
+ /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
757
+ readonly createdDateTime?: string;
758
+ /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
759
+ readonly lastActionDateTime?: string;
760
+ /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
761
+ readonly startTime?: string;
762
+ /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
763
+ readonly endTime?: string;
764
+ /** Name to identify resource. */
765
+ name?: string;
766
+ /** Textual description of the resource. */
767
+ description?: string;
768
+ /** Created by user/tenant id. */
769
+ readonly createdBy?: string;
770
+ /** Modified by user/tenant id. */
771
+ readonly modifiedBy?: string;
772
+ /**
773
+ * A collection of key value pairs that belongs to the resource.
774
+ * Each pair must not have a key greater than 50 characters
775
+ * and must not have a value greater than 150 characters.
776
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
777
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
778
+ */
779
+ properties?: Record<string, any>;
780
+ }
781
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
782
+ export interface InsightAttachmentListResponseOutput {
783
+ /** List of requested objects. */
784
+ value: Array<InsightAttachmentOutput>;
785
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
786
+ skipToken?: string;
787
+ /** Continuation link (absolute URI) to the next page of results in the list. */
788
+ nextLink?: string;
789
+ }
790
+ /** Schema of insight attachment resource. */
791
+ export interface InsightAttachmentOutput {
792
+ /** InsightID for this InsightAttachment. */
793
+ insightId: string;
794
+ /** ModelID for this InsightAttachment. */
795
+ readonly modelId?: string;
796
+ /** Associated Resource type for this attachment. */
797
+ readonly resourceType?: "Party" | "Farm" | "Field" | "SeasonalField" | "Boundary";
798
+ /** Associated Resource id for this attachment. */
799
+ readonly resourceId?: string;
800
+ /** Original File Name for this attachment. */
801
+ readonly originalFileName?: string;
802
+ /** PartyId id for this attachment. */
803
+ readonly partyId?: string;
804
+ /** Unique id. */
805
+ readonly id?: string;
806
+ /** Status of the resource. */
807
+ status?: string;
808
+ /** Date when resource was created. */
809
+ readonly createdDateTime?: string;
810
+ /** Date when resource was last modified. */
811
+ readonly modifiedDateTime?: string;
812
+ /** Source of the resource. */
813
+ source?: string;
814
+ /** Name to identify resource. */
815
+ name?: string;
816
+ /** Textual description of resource. */
817
+ description?: string;
818
+ /** Created by user/tenant id. */
819
+ readonly createdBy?: string;
820
+ /** Modified by user/tenant id. */
821
+ readonly modifiedBy?: string;
822
+ /** The ETag value to implement optimistic concurrency. */
823
+ readonly eTag?: string;
824
+ }
825
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
826
+ export interface InsightListResponseOutput {
827
+ /** List of requested objects. */
828
+ value: Array<InsightOutput>;
829
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
830
+ skipToken?: string;
831
+ /** Continuation link (absolute URI) to the next page of results in the list. */
832
+ nextLink?: string;
833
+ }
834
+ /** Schema of insight resource. */
835
+ export interface InsightOutput {
836
+ /** Id of the associated party. */
837
+ readonly partyId?: string;
838
+ /** Id of the associated model. */
839
+ readonly modelId?: string;
840
+ /** Resource type associated with the record. */
841
+ readonly resourceType?: "Party" | "Farm" | "Field" | "SeasonalField" | "Boundary";
842
+ /** Id of the associated resource. */
843
+ readonly resourceId?: string;
844
+ /** Version of the associated model. */
845
+ modelVersion?: string;
846
+ /** Gets link for attachments. */
847
+ readonly attachmentsLink?: string;
848
+ /** Start date to which the insight is related. */
849
+ insightStartDateTime?: string;
850
+ /** End date to which the insight is related. */
851
+ insightEndDateTime?: string;
852
+ /** Measures to capture insights results. */
853
+ measurements?: Record<string, MeasureOutput>;
854
+ /** Id of the resource. */
855
+ readonly id?: string;
856
+ /** Status of the resource. */
857
+ status?: string;
858
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
859
+ readonly createdDateTime?: string;
860
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
861
+ readonly modifiedDateTime?: string;
862
+ /** The ETag value to implement optimistic concurrency. */
863
+ readonly eTag?: string;
864
+ /** Name to identify resource. */
865
+ name?: string;
866
+ /** Textual description of the resource. */
867
+ description?: string;
868
+ /** Created by user/tenant id. */
869
+ readonly createdBy?: string;
870
+ /** Modified by user/tenant id. */
871
+ readonly modifiedBy?: string;
872
+ /**
873
+ * A collection of key value pairs that belongs to the resource.
874
+ * Each pair must not have a key greater than 50 characters
875
+ * and must not have a value greater than 150 characters.
876
+ * Note: A maximum of 25 key value pairs can be provided for a resource and
877
+ * only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
878
+ */
879
+ properties?: Record<string, any>;
880
+ }
881
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
882
+ export interface ManagementZoneListResponseOutput {
883
+ /** List of requested objects. */
884
+ value: Array<ManagementZoneOutput>;
885
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
886
+ skipToken?: string;
887
+ /** Continuation link (absolute URI) to the next page of results in the list. */
888
+ nextLink?: string;
889
+ }
890
+ /** Api Model for ManagementZone object. */
891
+ export interface ManagementZoneOutput {
892
+ /** Party Id associated with the ManagementZone. */
893
+ readonly partyId?: string;
894
+ /** Type of the ManagementZone. */
895
+ type?: string;
896
+ /** Season Id associated with the ManagementZone. */
897
+ seasonId?: string;
898
+ /** Crop Id associated with the ManagementZone. */
899
+ cropId?: string;
900
+ /** Field Id associated with the ManagementZone. */
901
+ fieldId?: string;
902
+ /** Unique resource ID. */
903
+ readonly id?: string;
904
+ /** The ETag value to implement optimistic concurrency. */
905
+ readonly eTag?: string;
906
+ /** Status of the resource. */
907
+ status?: string;
908
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
909
+ readonly createdDateTime?: string;
910
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
911
+ readonly modifiedDateTime?: string;
912
+ /** Source of the resource. */
913
+ source?: string;
914
+ /** Name to identify resource. */
915
+ name?: string;
916
+ /** Textual description of the resource. */
917
+ description?: string;
918
+ /** Created by user/tenant id. */
919
+ readonly createdBy?: string;
920
+ /** Modified by user/tenant id. */
921
+ readonly modifiedBy?: string;
922
+ /**
923
+ * A collection of key value pairs that belongs to the resource.
924
+ * Each pair must not have a key greater than 50 characters
925
+ * and must not have a value greater than 150 characters.
926
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
927
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
928
+ */
929
+ properties?: Record<string, any>;
930
+ }
931
+ /** Schema of biomass model job. */
932
+ export interface BiomassModelJobOutput {
933
+ /** Party Id. */
934
+ partyId: string;
935
+ /** The id of the boundary object for which biomass is being calculated. */
936
+ boundaryId: string;
937
+ /** The version of the biomass model to be run. Available Value: 1.0 . */
938
+ modelVersion: string;
939
+ /** Crop name for biomass model. Available Value: Corn. */
940
+ cropName: "Corn";
941
+ /** Planting datetime for biomass calculations. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
942
+ plantingStartDateTime: string;
943
+ /** End datetime till which biomass will be calculated. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
944
+ inferenceEndDateTime: string;
945
+ /** ExtensionId of weather data. Available values: DTN.ClearAg, DTN.ContentServices. */
946
+ weatherExtensionId: string;
947
+ /** Provider of satellite data. Available Value: Microsoft. */
948
+ satelliteProvider: "Microsoft";
949
+ /** Source of satellite data. Available Value: Sentinel_2_L2A. */
950
+ satelliteSource: "Sentinel_2_L2A" | "Sentinel_2_L1C";
951
+ /** ImageResolution in meters. Available values: 10, 20, 60. */
952
+ imageResolution: number;
953
+ /** ImageFormat. Available value: TIF. */
954
+ imageFormat: "TIF";
955
+ /** Unique job id. */
956
+ readonly id?: string;
957
+ /**
958
+ * Status of the job.
959
+ * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
960
+ */
961
+ readonly status?: string;
962
+ /** Duration of the job in seconds. */
963
+ readonly durationInSeconds?: number;
964
+ /** Status message to capture more details of the job. */
965
+ readonly message?: string;
966
+ /** Error Code when job failed. */
967
+ readonly errorCode?: string;
968
+ /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
969
+ readonly createdDateTime?: string;
970
+ /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
971
+ readonly lastActionDateTime?: string;
972
+ /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
973
+ readonly startTime?: string;
974
+ /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
975
+ readonly endTime?: string;
976
+ /** Name to identify resource. */
977
+ name?: string;
978
+ /** Textual description of the resource. */
979
+ description?: string;
980
+ /** Created by user/tenant id. */
981
+ readonly createdBy?: string;
982
+ /** Modified by user/tenant id. */
983
+ readonly modifiedBy?: string;
984
+ /**
985
+ * A collection of key value pairs that belongs to the resource.
986
+ * Each pair must not have a key greater than 50 characters
987
+ * and must not have a value greater than 150 characters.
988
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
989
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
990
+ */
991
+ properties?: Record<string, any>;
992
+ }
993
+ /** Schema of sensor placement model job. */
994
+ export interface SensorPlacementModelJobOutput {
995
+ /** Party Id. */
996
+ partyId: string;
997
+ /** The id of the boundary object for which sensor placement is being calculated. */
998
+ boundaryId: string;
999
+ /** The version of the sensor placement model to be run. */
1000
+ modelVersion: string;
1001
+ /** Start datetime for satellite data to be pulled. */
1002
+ inferenceStartDateTime: string;
1003
+ /** End datetime for satellite data to be pulled. */
1004
+ inferenceEndDateTime: string;
1005
+ /** Provider of satellite data. Available Value: Microsoft. */
1006
+ satelliteProvider: "Microsoft";
1007
+ /** Source of satellite data. Available Value: Sentinel_2_L2A. */
1008
+ satelliteSource: "Sentinel_2_L2A" | "Sentinel_2_L1C";
1009
+ /** SensorType. The sensor placement map generated for sensor type (e.g., soil moisture, soil temperature, npk). Available Value: SoilMoisture. */
1010
+ sensorType: string;
1011
+ /** IsRanked, if True the sensor placements will be ranked. */
1012
+ isRanked: boolean;
1013
+ /** Unique job id. */
1014
+ readonly id?: string;
1015
+ /**
1016
+ * Status of the job.
1017
+ * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
1018
+ */
1019
+ readonly status?: string;
1020
+ /** Duration of the job in seconds. */
1021
+ readonly durationInSeconds?: number;
1022
+ /** Status message to capture more details of the job. */
1023
+ readonly message?: string;
1024
+ /** Error Code when job failed. */
1025
+ readonly errorCode?: string;
1026
+ /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1027
+ readonly createdDateTime?: string;
1028
+ /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1029
+ readonly lastActionDateTime?: string;
1030
+ /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1031
+ readonly startTime?: string;
1032
+ /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1033
+ readonly endTime?: string;
1034
+ /** Name to identify resource. */
1035
+ name?: string;
1036
+ /** Textual description of the resource. */
1037
+ description?: string;
1038
+ /** Created by user/tenant id. */
1039
+ readonly createdBy?: string;
1040
+ /** Modified by user/tenant id. */
1041
+ readonly modifiedBy?: string;
1042
+ /**
1043
+ * A collection of key value pairs that belongs to the resource.
1044
+ * Each pair must not have a key greater than 50 characters
1045
+ * and must not have a value greater than 150 characters.
1046
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
1047
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
1048
+ */
1049
+ properties?: Record<string, any>;
1050
+ }
1051
+ /** Schema of soil moisture model job. */
1052
+ export interface SoilMoistureModelJobOutput {
1053
+ /** Party Id. */
1054
+ partyId: string;
1055
+ /** The id of the boundary object for which soil moisture is being calculated. */
1056
+ boundaryId: string;
1057
+ /** Sensor data model Id. */
1058
+ sensorDataModelId: string;
1059
+ /** Sensor partner Id. */
1060
+ sensorPartnerId: string;
1061
+ /** Inference start date time for soil moisture calculations. */
1062
+ inferenceStartDateTime: string;
1063
+ /** Inference end date time for soil moisture calculations. */
1064
+ inferenceEndDateTime: string;
1065
+ /** Provider of satellite data. Available Value: Microsoft. */
1066
+ satelliteProvider: "Microsoft";
1067
+ /** Source of satellite data. Available Value: Sentinel_2_L2A. */
1068
+ satelliteSource: "Sentinel_2_L2A" | "Sentinel_2_L1C";
1069
+ /** ImageResolution in meters. Available values: 10, 20, 60. */
1070
+ imageResolution: number;
1071
+ /** ImageFormat. Available value: TIF. */
1072
+ imageFormat: "TIF";
1073
+ /** The version of the soil moisture model to be run. */
1074
+ modelVersion: string;
1075
+ /** Schema for storing sensor definition keywords. */
1076
+ sensorDefinition: SoilMoistureModelSensorDefinitionOutput;
1077
+ /** Unique job id. */
1078
+ readonly id?: string;
1079
+ /**
1080
+ * Status of the job.
1081
+ * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
1082
+ */
1083
+ readonly status?: string;
1084
+ /** Duration of the job in seconds. */
1085
+ readonly durationInSeconds?: number;
1086
+ /** Status message to capture more details of the job. */
1087
+ readonly message?: string;
1088
+ /** Error Code when job failed. */
1089
+ readonly errorCode?: string;
1090
+ /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1091
+ readonly createdDateTime?: string;
1092
+ /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1093
+ readonly lastActionDateTime?: string;
1094
+ /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1095
+ readonly startTime?: string;
1096
+ /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1097
+ readonly endTime?: string;
1098
+ /** Name to identify resource. */
1099
+ name?: string;
1100
+ /** Textual description of the resource. */
1101
+ description?: string;
1102
+ /** Created by user/tenant id. */
1103
+ readonly createdBy?: string;
1104
+ /** Modified by user/tenant id. */
1105
+ readonly modifiedBy?: string;
1106
+ /**
1107
+ * A collection of key value pairs that belongs to the resource.
1108
+ * Each pair must not have a key greater than 50 characters
1109
+ * and must not have a value greater than 150 characters.
1110
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
1111
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
1112
+ */
1113
+ properties?: Record<string, any>;
1114
+ }
1115
+ /** Schema for storing sensor definition keywords. */
1116
+ export interface SoilMoistureModelSensorDefinitionOutput {
1117
+ /** The measurement name for sensor measure in sensorDataModel. */
1118
+ sensorMeasurement: string;
1119
+ /** The measurement name for minimum measurement value. */
1120
+ minProperty: string;
1121
+ /** The measurement name for maximum measurement value. */
1122
+ maxProperty: string;
1123
+ }
1124
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
1125
+ export interface NutrientAnalysisListResponseOutput {
1126
+ /** List of requested objects. */
1127
+ value: Array<NutrientAnalysisOutput>;
1128
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
1129
+ skipToken?: string;
1130
+ /** Continuation link (absolute URI) to the next page of results in the list. */
1131
+ nextLink?: string;
1132
+ }
1133
+ /** Api Model for nutrient analysis object. */
1134
+ export interface NutrientAnalysisOutput {
1135
+ /** Party id for this nutrient analysis. */
1136
+ readonly partyId?: string;
1137
+ /** Parent id for this nutrient analysis. */
1138
+ parentId?: string;
1139
+ /**
1140
+ * Parent type for this nutrient analysis.
1141
+ * i.e. PlantTissueAnalysis.
1142
+ */
1143
+ parentType?: "PlantTissueAnalysis";
1144
+ /** Unit for this nutrient analysis. */
1145
+ unit?: string;
1146
+ /** Value for this nutrient analysis. */
1147
+ value?: number;
1148
+ /** Reference value low for this nutrient analysis. */
1149
+ referenceValueLow?: number;
1150
+ /** Reference value high for this nutrient analysis. */
1151
+ referenceValueHigh?: number;
1152
+ /** Classification for this nutrient analysis. */
1153
+ classification?: string;
1154
+ /** Recommendation for this nutrient analysis. */
1155
+ recommendation?: string;
1156
+ /** Products for this nutrient analysis. */
1157
+ products?: Array<ProductDetailsOutput>;
1158
+ /** Unique resource ID. */
1159
+ readonly id?: string;
1160
+ /** The ETag value to implement optimistic concurrency. */
1161
+ readonly eTag?: string;
1162
+ /** Status of the resource. */
1163
+ status?: string;
1164
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1165
+ readonly createdDateTime?: string;
1166
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1167
+ readonly modifiedDateTime?: string;
1168
+ /** Source of the resource. */
1169
+ source?: string;
1170
+ /** Name to identify resource. */
1171
+ name?: string;
1172
+ /** Textual description of the resource. */
1173
+ description?: string;
1174
+ /** Created by user/tenant id. */
1175
+ readonly createdBy?: string;
1176
+ /** Modified by user/tenant id. */
1177
+ readonly modifiedBy?: string;
1178
+ /**
1179
+ * A collection of key value pairs that belongs to the resource.
1180
+ * Each pair must not have a key greater than 50 characters
1181
+ * and must not have a value greater than 150 characters.
1182
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
1183
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
1184
+ */
1185
+ properties?: Record<string, any>;
1186
+ }
1187
+ /** Model for representing ProductDetails object. */
1188
+ export interface ProductDetailsOutput {
1189
+ /** Rate of the product. */
1190
+ rate?: string;
1191
+ /** Instruction of the resource. */
1192
+ instruction?: string;
1193
+ /** Product of the resource. */
1194
+ product?: string;
1195
+ }
1196
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
1197
+ export interface OAuthProviderListResponseOutput {
1198
+ /** List of requested objects. */
1199
+ value: Array<OAuthProviderOutput>;
1200
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
1201
+ skipToken?: string;
1202
+ /** Continuation link (absolute URI) to the next page of results in the list. */
1203
+ nextLink?: string;
1204
+ }
1205
+ /** Schema of OAuth provider resource. */
1206
+ export interface OAuthProviderOutput {
1207
+ /** OAuth App Id for given OAuth Provider. */
1208
+ appId?: string;
1209
+ /**
1210
+ * OAuth App secret for given Provider.
1211
+ * Note: Won't be sent in response.
1212
+ */
1213
+ appSecret?: string;
1214
+ /**
1215
+ * OAuth Api key for given Provider.
1216
+ * Note: currently Applicable to Climate provider. Won't be sent in response.
1217
+ */
1218
+ apiKey?: string;
1219
+ /**
1220
+ * An optional flag to determine if the App is ready to be used for Production scenarios in the provider side or not. (Default value: false)
1221
+ * Note: Currently applicable for JohnDeere.
1222
+ */
1223
+ isProductionApp?: boolean;
1224
+ /** Unique OAuth provider ID. */
1225
+ readonly id?: string;
1226
+ /** The ETag value to implement optimistic concurrency. */
1227
+ readonly eTag?: string;
1228
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1229
+ readonly createdDateTime?: string;
1230
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1231
+ readonly modifiedDateTime?: string;
1232
+ /** Name to identify resource. */
1233
+ name?: string;
1234
+ /** Textual description of the resource. */
1235
+ description?: string;
1236
+ /** Created by user/tenant id. */
1237
+ readonly createdBy?: string;
1238
+ /** Modified by user/tenant id. */
1239
+ readonly modifiedBy?: string;
1240
+ /**
1241
+ * A collection of key value pairs that belongs to the resource.
1242
+ * Each pair must not have a key greater than 50 characters
1243
+ * and must not have a value greater than 150 characters.
1244
+ * Note: A maximum of 25 key value pairs can be provided for a resource and
1245
+ * only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
1246
+ */
1247
+ properties?: Record<string, any>;
1248
+ }
1249
+ /** Schema of oauth provider cascade delete job. */
1250
+ export interface OAuthProviderCascadeDeleteJobOutput {
1251
+ /** The id of the oauth provider. */
1252
+ oauthProviderId: string;
1253
+ /** Unique job id. */
1254
+ readonly id?: string;
1255
+ /**
1256
+ * Status of the job.
1257
+ * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
1258
+ */
1259
+ readonly status?: string;
1260
+ /** Duration of the job in seconds. */
1261
+ readonly durationInSeconds?: number;
1262
+ /** Status message to capture more details of the job. */
1263
+ readonly message?: string;
1264
+ /** Error Code when job failed. */
1265
+ readonly errorCode?: string;
1266
+ /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1267
+ readonly createdDateTime?: string;
1268
+ /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1269
+ readonly lastActionDateTime?: string;
1270
+ /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1271
+ readonly startTime?: string;
1272
+ /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1273
+ readonly endTime?: string;
1274
+ /** Name to identify resource. */
1275
+ name?: string;
1276
+ /** Textual description of the resource. */
1277
+ description?: string;
1278
+ /** Created by user/tenant id. */
1279
+ readonly createdBy?: string;
1280
+ /** Modified by user/tenant id. */
1281
+ readonly modifiedBy?: string;
1282
+ /**
1283
+ * A collection of key value pairs that belongs to the resource.
1284
+ * Each pair must not have a key greater than 50 characters
1285
+ * and must not have a value greater than 150 characters.
1286
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
1287
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
1288
+ */
1289
+ properties?: Record<string, any>;
1290
+ }
1291
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
1292
+ export interface OAuthTokenListResponseOutput {
1293
+ /** List of requested objects. */
1294
+ value: Array<OAuthTokenOutput>;
1295
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
1296
+ skipToken?: string;
1297
+ /** Continuation link (absolute URI) to the next page of results in the list. */
1298
+ nextLink?: string;
1299
+ }
1300
+ /** Schema of OAuth token resource. */
1301
+ export interface OAuthTokenOutput {
1302
+ /** Party ID for this OAuth config. */
1303
+ partyId: string;
1304
+ /** ID of the OAuth provider resource containing app information. */
1305
+ authProviderId: string;
1306
+ /** An optional flag indicating whether the token is a valid or expired (Default value: true). */
1307
+ isValid?: boolean;
1308
+ /** The ETag value to implement optimistic concurrency. */
1309
+ readonly eTag?: string;
1310
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1311
+ readonly createdDateTime?: string;
1312
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1313
+ readonly modifiedDateTime?: string;
1314
+ }
1315
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
1316
+ export interface PartyListResponseOutput {
1317
+ /** List of requested objects. */
1318
+ value: Array<PartyOutput>;
1319
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
1320
+ skipToken?: string;
1321
+ /** Continuation link (absolute URI) to the next page of results in the list. */
1322
+ nextLink?: string;
1323
+ }
1324
+ /** Schema of party resource. */
1325
+ export interface PartyOutput {
1326
+ /** Unique resource ID. */
1327
+ readonly id?: string;
1328
+ /** The ETag value to implement optimistic concurrency. */
1329
+ readonly eTag?: string;
1330
+ /** Status of the resource. */
1331
+ status?: string;
1332
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1333
+ readonly createdDateTime?: string;
1334
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1335
+ readonly modifiedDateTime?: string;
1336
+ /** Source of the resource. */
1337
+ source?: string;
1338
+ /** Name to identify resource. */
1339
+ name?: string;
1340
+ /** Textual description of the resource. */
1341
+ description?: string;
1342
+ /** Created by user/tenant id. */
1343
+ readonly createdBy?: string;
1344
+ /** Modified by user/tenant id. */
1345
+ readonly modifiedBy?: string;
1346
+ /**
1347
+ * A collection of key value pairs that belongs to the resource.
1348
+ * Each pair must not have a key greater than 50 characters
1349
+ * and must not have a value greater than 150 characters.
1350
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
1351
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
1352
+ */
1353
+ properties?: Record<string, any>;
1354
+ }
1355
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
1356
+ export interface PlantingDataListResponseOutput {
1357
+ /** List of requested objects. */
1358
+ value: Array<PlantingDataOutput>;
1359
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
1360
+ skipToken?: string;
1361
+ /** Continuation link (absolute URI) to the next page of results in the list. */
1362
+ nextLink?: string;
1363
+ }
1364
+ /** Schema of planting data resource. */
1365
+ export interface PlantingDataOutput {
1366
+ /** Schema for storing measurement reading and unit. */
1367
+ avgPlantingRate?: MeasureOutput;
1368
+ /** Schema for storing measurement reading and unit. */
1369
+ totalMaterial?: MeasureOutput;
1370
+ /** Schema for storing measurement reading and unit. */
1371
+ avgMaterial?: MeasureOutput;
1372
+ /** Planting product details. */
1373
+ plantingProductDetails?: Array<PlantingProductDetailOutput>;
1374
+ /** Schema for storing measurement reading and unit. */
1375
+ area?: MeasureOutput;
1376
+ /**
1377
+ * Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.
1378
+ * Note: this will be specified by the source provider itself.
1379
+ */
1380
+ operationModifiedDateTime?: string;
1381
+ /** Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1382
+ operationStartDateTime?: string;
1383
+ /** End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1384
+ operationEndDateTime?: string;
1385
+ /** Link for attachments. */
1386
+ readonly attachmentsLink?: string;
1387
+ /** Optional boundary ID of the field for which operation was applied. */
1388
+ associatedBoundaryId?: string;
1389
+ /** Party ID which belongs to the operation data. */
1390
+ readonly partyId?: string;
1391
+ /** Unique resource ID. */
1392
+ readonly id?: string;
1393
+ /** The ETag value to implement optimistic concurrency. */
1394
+ readonly eTag?: string;
1395
+ /** Status of the resource. */
1396
+ status?: string;
1397
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1398
+ readonly createdDateTime?: string;
1399
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1400
+ readonly modifiedDateTime?: string;
1401
+ /** Source of the resource. */
1402
+ source?: string;
1403
+ /** Name to identify resource. */
1404
+ name?: string;
1405
+ /** Textual description of the resource. */
1406
+ description?: string;
1407
+ /** Created by user/tenant id. */
1408
+ readonly createdBy?: string;
1409
+ /** Modified by user/tenant id. */
1410
+ readonly modifiedBy?: string;
1411
+ /**
1412
+ * A collection of key value pairs that belongs to the resource.
1413
+ * Each pair must not have a key greater than 50 characters
1414
+ * and must not have a value greater than 150 characters.
1415
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
1416
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
1417
+ */
1418
+ properties?: Record<string, any>;
1419
+ }
1420
+ /** Schema for Planting product detail. */
1421
+ export interface PlantingProductDetailOutput {
1422
+ /** Name of the product. */
1423
+ productName?: string;
1424
+ /** Schema for storing measurement reading and unit. */
1425
+ area?: MeasureOutput;
1426
+ /** Schema for storing measurement reading and unit. */
1427
+ totalMaterial?: MeasureOutput;
1428
+ /** Schema for storing measurement reading and unit. */
1429
+ avgMaterial?: MeasureOutput;
1430
+ }
1431
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
1432
+ export interface PlantTissueAnalysisListResponseOutput {
1433
+ /** List of requested objects. */
1434
+ value: Array<PlantTissueAnalysisOutput>;
1435
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
1436
+ skipToken?: string;
1437
+ /** Continuation link (absolute URI) to the next page of results in the list. */
1438
+ nextLink?: string;
1439
+ }
1440
+ /** Api Model for plant tissue analysis object. */
1441
+ export interface PlantTissueAnalysisOutput {
1442
+ /** Id of the associated Party. */
1443
+ readonly partyId?: string;
1444
+ /** Id of the associated Field. */
1445
+ fieldId?: string;
1446
+ /** Id of the associated Crop. */
1447
+ cropId?: string;
1448
+ /** Id of the associated Crop product. */
1449
+ cropProductId?: string;
1450
+ /** Id of the associated Season. */
1451
+ seasonId?: string;
1452
+ /** Planting datetime for this plant tissue analysis. */
1453
+ plantingDateTime?: string;
1454
+ /** Growth stage for this plant tissue analysis. */
1455
+ growthStage?: string;
1456
+ /** Plant part for this plant tissue analysis. */
1457
+ plantPart?: string;
1458
+ /** Plant position for this plant tissue analysis. */
1459
+ plantPosition?: string;
1460
+ /** Plant appearance for this plant tissue analysis. */
1461
+ plantAppearance?: string;
1462
+ /** Sample collection condition for this plant tissue analysis. */
1463
+ sampleCollectionCondition?: string;
1464
+ /** Sample collection dateTime for this plant tissue analysis. */
1465
+ sampleCollectionDateTime?: string;
1466
+ /** Sample received dateTime. */
1467
+ sampleReceivedDateTime?: string;
1468
+ /** Sample test result dateTime for this plant tissue analysis. */
1469
+ sampleTestResultDateTime?: string;
1470
+ /** Model for representing LabDetails object. */
1471
+ labDetails?: LabDetailsOutput;
1472
+ /** Link for attachments. */
1473
+ readonly attachmentsLink?: string;
1474
+ /** Unique resource ID. */
1475
+ readonly id?: string;
1476
+ /** The ETag value to implement optimistic concurrency. */
1477
+ readonly eTag?: string;
1478
+ /** Status of the resource. */
1479
+ status?: string;
1480
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1481
+ readonly createdDateTime?: string;
1482
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1483
+ readonly modifiedDateTime?: string;
1484
+ /** Source of the resource. */
1485
+ source?: string;
1486
+ /** Name to identify resource. */
1487
+ name?: string;
1488
+ /** Textual description of the resource. */
1489
+ description?: string;
1490
+ /** Created by user/tenant id. */
1491
+ readonly createdBy?: string;
1492
+ /** Modified by user/tenant id. */
1493
+ readonly modifiedBy?: string;
1494
+ /**
1495
+ * A collection of key value pairs that belongs to the resource.
1496
+ * Each pair must not have a key greater than 50 characters
1497
+ * and must not have a value greater than 150 characters.
1498
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
1499
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
1500
+ */
1501
+ properties?: Record<string, any>;
1502
+ }
1503
+ /** Model for representing LabDetails object. */
1504
+ export interface LabDetailsOutput {
1505
+ /** Code of the resource. */
1506
+ code?: string;
1507
+ /** Name of the resource. */
1508
+ name?: string;
1509
+ /** Description of the resource. */
1510
+ description?: string;
1511
+ /** Address of the resource. */
1512
+ address?: string;
1513
+ }
1514
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
1515
+ export interface PrescriptionMapListResponseOutput {
1516
+ /** List of requested objects. */
1517
+ value: Array<PrescriptionMapOutput>;
1518
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
1519
+ skipToken?: string;
1520
+ /** Continuation link (absolute URI) to the next page of results in the list. */
1521
+ nextLink?: string;
1522
+ }
1523
+ /** Api Model for Prescription Map object. */
1524
+ export interface PrescriptionMapOutput {
1525
+ /** Party Id. */
1526
+ readonly partyId?: string;
1527
+ /** Prescription map type. */
1528
+ type?: string;
1529
+ /** Season Id. */
1530
+ seasonId?: string;
1531
+ /** Crop Id. */
1532
+ cropId?: string;
1533
+ /** Field Id. */
1534
+ fieldId?: string;
1535
+ /** Unique resource ID. */
1536
+ readonly id?: string;
1537
+ /** The ETag value to implement optimistic concurrency. */
1538
+ readonly eTag?: string;
1539
+ /** Status of the resource. */
1540
+ status?: string;
1541
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1542
+ readonly createdDateTime?: string;
1543
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1544
+ readonly modifiedDateTime?: string;
1545
+ /** Source of the resource. */
1546
+ source?: string;
1547
+ /** Name to identify resource. */
1548
+ name?: string;
1549
+ /** Textual description of the resource. */
1550
+ description?: string;
1551
+ /** Created by user/tenant id. */
1552
+ readonly createdBy?: string;
1553
+ /** Modified by user/tenant id. */
1554
+ readonly modifiedBy?: string;
1555
+ /**
1556
+ * A collection of key value pairs that belongs to the resource.
1557
+ * Each pair must not have a key greater than 50 characters
1558
+ * and must not have a value greater than 150 characters.
1559
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
1560
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
1561
+ */
1562
+ properties?: Record<string, any>;
1563
+ }
1564
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
1565
+ export interface PrescriptionListResponseOutput {
1566
+ /** List of requested objects. */
1567
+ value: Array<PrescriptionOutput>;
1568
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
1569
+ skipToken?: string;
1570
+ /** Continuation link (absolute URI) to the next page of results in the list. */
1571
+ nextLink?: string;
1572
+ }
1573
+ /** Api Model for Prescription object. */
1574
+ export interface PrescriptionOutput {
1575
+ /** Party Id. */
1576
+ readonly partyId?: string;
1577
+ /** Prescription map Id. */
1578
+ prescriptionMapId?: string;
1579
+ /** Product Code. */
1580
+ productCode?: string;
1581
+ /** Product name. */
1582
+ productName?: string;
1583
+ /** Prescription type. */
1584
+ type?: string;
1585
+ /** Measures. */
1586
+ measurements?: Record<string, MeasureOutput>;
1587
+ /** Unique resource ID. */
1588
+ readonly id?: string;
1589
+ /** The ETag value to implement optimistic concurrency. */
1590
+ readonly eTag?: string;
1591
+ /** Status of the resource. */
1592
+ status?: string;
1593
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1594
+ readonly createdDateTime?: string;
1595
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1596
+ readonly modifiedDateTime?: string;
1597
+ /** Source of the resource. */
1598
+ source?: string;
1599
+ /** Name to identify resource. */
1600
+ name?: string;
1601
+ /** Textual description of the resource. */
1602
+ description?: string;
1603
+ /** Created by user/tenant id. */
1604
+ readonly createdBy?: string;
1605
+ /** Modified by user/tenant id. */
1606
+ readonly modifiedBy?: string;
1607
+ /**
1608
+ * A collection of key value pairs that belongs to the resource.
1609
+ * Each pair must not have a key greater than 50 characters
1610
+ * and must not have a value greater than 150 characters.
1611
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
1612
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
1613
+ */
1614
+ properties?: Record<string, any>;
1615
+ }
1616
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
1617
+ export interface SceneListResponseOutput {
1618
+ /** List of requested objects. */
1619
+ value: Array<SceneOutput>;
1620
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
1621
+ skipToken?: string;
1622
+ /** Continuation link (absolute URI) to the next page of results in the list. */
1623
+ nextLink?: string;
1624
+ }
1625
+ /** Schema of scene resource. */
1626
+ export interface SceneOutput {
1627
+ /** Date-time of the scene, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1628
+ sceneDateTime?: string;
1629
+ /** Data provider of the scene. */
1630
+ provider?: string;
1631
+ /** Data source of the scene. */
1632
+ source?: string;
1633
+ /** Collection of image files. */
1634
+ imageFiles?: Array<ImageFileOutput>;
1635
+ /** ImageFormat. Available value: TIF. */
1636
+ imageFormat?: "TIF";
1637
+ /** Cloud cover percentage of the scene. */
1638
+ cloudCoverPercentage?: number;
1639
+ /** Dark pixel percentage of the scene. */
1640
+ darkPixelPercentage?: number;
1641
+ /** Median of NDVI of the scene. */
1642
+ ndviMedianValue?: number;
1643
+ /** Boundary ID which belongs to the scene. */
1644
+ boundaryId?: string;
1645
+ /** Party ID which belongs to the scene. */
1646
+ partyId?: string;
1647
+ /** Unique scene resource ID. */
1648
+ id?: string;
1649
+ /** The ETag value to implement optimistic concurrency. */
1650
+ readonly eTag?: string;
1651
+ }
1652
+ /** Schema of image file resource. */
1653
+ export interface ImageFileOutput {
1654
+ /** Link of the image file. */
1655
+ fileLink?: string;
1656
+ /** Name of the image file. */
1657
+ name: string;
1658
+ /** ImageFormat. Available value: TIF. */
1659
+ imageFormat?: "TIF";
1660
+ /** Resolution of image file in meters. */
1661
+ resolution?: number;
1662
+ }
1663
+ /** Schema of satellite data ingestion job. */
1664
+ export interface SatelliteDataIngestionJobOutput {
1665
+ /** Party Id. */
1666
+ partyId: string;
1667
+ /** The id of the boundary object for which satellite data is being fetched. */
1668
+ boundaryId: string;
1669
+ /** Start Date. */
1670
+ startDateTime: string;
1671
+ /** End Date. */
1672
+ endDateTime: string;
1673
+ /** Provider of satellite data. Available Value: Microsoft. */
1674
+ provider?: "Microsoft";
1675
+ /** Source of satellite data. Available Value: Sentinel_2_L2A. */
1676
+ source: "Sentinel_2_L2A" | "Sentinel_2_L1C";
1677
+ /** Data Model for SatelliteIngestionJobRequest. */
1678
+ data?: SatelliteDataOutput;
1679
+ /** Unique job id. */
1680
+ readonly id?: string;
1681
+ /**
1682
+ * Status of the job.
1683
+ * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
1684
+ */
1685
+ readonly status?: string;
1686
+ /** Duration of the job in seconds. */
1687
+ readonly durationInSeconds?: number;
1688
+ /** Status message to capture more details of the job. */
1689
+ readonly message?: string;
1690
+ /** Error Code when job failed. */
1691
+ readonly errorCode?: string;
1692
+ /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1693
+ readonly createdDateTime?: string;
1694
+ /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1695
+ readonly lastActionDateTime?: string;
1696
+ /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1697
+ readonly startTime?: string;
1698
+ /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
1699
+ readonly endTime?: string;
1700
+ /** Name to identify resource. */
1701
+ name?: string;
1702
+ /** Textual description of the resource. */
1703
+ description?: string;
1704
+ /** Created by user/tenant id. */
1705
+ readonly createdBy?: string;
1706
+ /** Modified by user/tenant id. */
1707
+ readonly modifiedBy?: string;
1708
+ /**
1709
+ * A collection of key value pairs that belongs to the resource.
1710
+ * Each pair must not have a key greater than 50 characters
1711
+ * and must not have a value greater than 150 characters.
1712
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
1713
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
1714
+ */
1715
+ properties?: Record<string, any>;
1716
+ }
1717
+ /** Data Model for SatelliteIngestionJobRequest. */
1718
+ export interface SatelliteDataOutput {
1719
+ /** List of ImageNames. */
1720
+ imageNames?: Array<string>;
1721
+ /** List of ImageFormats. Available value: TIF. */
1722
+ imageFormats?: Array<string>;
1723
+ /** List of ImageResolutions in meters. Available values: 10, 20, 60. */
1724
+ imageResolutions?: Array<number>;
1725
+ }
1726
+ /** Paged response contains list of features and next property to get the next set of results. */
1727
+ export interface SearchFeaturesResponseOutput {
1728
+ /** List of features. */
1729
+ features: Array<StacFeatureOutput>;
1730
+ /**
1731
+ * URL to do the POST request with same filters,
1732
+ * to get next set of features.
1733
+ */
1734
+ readonly nextLink?: string;
1735
+ }
1736
+ /**
1737
+ * Schema of STAC Feature(Item).
1738
+ * Refer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#item-fields.
1739
+ */
1740
+ export interface StacFeatureOutput {
1741
+ /** The STAC version the Feature implements. */
1742
+ stacVersion: string;
1743
+ /** A list of extensions the Feature implements. */
1744
+ stacExtensions?: Array<string>;
1745
+ /** Provider identifier. Globally unique ID by Data provider. */
1746
+ id: string;
1747
+ /** Type of the GeoJSON Object. It's value is always Feature. */
1748
+ type: string;
1749
+ /**
1750
+ * Defines the full footprint of the asset represented by this item.
1751
+ * Its a GeoJSON geometry.
1752
+ */
1753
+ geometry?: any;
1754
+ /** Bounding box of the feature. */
1755
+ bbox?: Array<number>;
1756
+ /** A dictionary of additional metadata for the item. */
1757
+ properties: any;
1758
+ /** List of link objects to resources and related URLs. */
1759
+ links: Array<StacFeatureLinkOutput>;
1760
+ /** Dictionary of asset objects, each with a unique key. */
1761
+ assets: Record<string, StacFeatureAssetOutput>;
1762
+ /** The id of the STAC Collection this Feature references. */
1763
+ collection?: string;
1764
+ }
1765
+ /**
1766
+ * The Link object describes a relationship of this Feature with another entity.
1767
+ * Refer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#link-object.
1768
+ */
1769
+ export interface StacFeatureLinkOutput {
1770
+ /** The actual link in the format of an URL. */
1771
+ href: string;
1772
+ /** Relationship between the current document and the linked document. */
1773
+ rel: string;
1774
+ /** Media type of the referenced entity. */
1775
+ type?: string;
1776
+ /** A human readable title to be used in rendered displays of the link. */
1777
+ title?: string;
1778
+ }
1779
+ /**
1780
+ * Schema of STAC Feature's Asset.
1781
+ * Refer for spec: https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/item-spec/item-spec.md#asset-object.
1782
+ */
1783
+ export interface StacFeatureAssetOutput {
1784
+ /** Link to the asset object. */
1785
+ href: string;
1786
+ /** The displayed title for clients and users. */
1787
+ title?: string;
1788
+ /** A description of the Asset providing additional details, such as how it was processed or created. */
1789
+ description?: string;
1790
+ /** Media type of the asset. */
1791
+ type?: string;
1792
+ /** The semantic roles of the asset, similar to the use of rel in links. */
1793
+ roles?: Array<string>;
1794
+ }
1795
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
1796
+ export interface SeasonalFieldListResponseOutput {
1797
+ /** List of requested objects. */
1798
+ value: Array<SeasonalFieldOutput>;
1799
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
1800
+ skipToken?: string;
1801
+ /** Continuation link (absolute URI) to the next page of results in the list. */
1802
+ nextLink?: string;
1803
+ }
1804
+ /** Schema of seasonal field resource. */
1805
+ export interface SeasonalFieldOutput {
1806
+ /** Party Id. */
1807
+ readonly partyId?: string;
1808
+ /** Id of the associated Farm. */
1809
+ farmId?: string;
1810
+ /** Id of the associated Field. */
1811
+ fieldId?: string;
1812
+ /** Id of the season it belongs to. */
1813
+ seasonId?: string;
1814
+ /** CropProduct ids. */
1815
+ cropProductIds?: Array<string>;
1816
+ /** Id of the crop it belongs to. */
1817
+ cropId?: string;
1818
+ /** Unique resource ID. */
1819
+ readonly id?: string;
1820
+ /** The ETag value to implement optimistic concurrency. */
1821
+ readonly eTag?: string;
1822
+ /** Status of the resource. */
1823
+ status?: string;
1824
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1825
+ readonly createdDateTime?: string;
1826
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1827
+ readonly modifiedDateTime?: string;
1828
+ /** Source of the resource. */
1829
+ source?: string;
1830
+ /** Name to identify resource. */
1831
+ name?: string;
1832
+ /** Textual description of the resource. */
1833
+ description?: string;
1834
+ /** Created by user/tenant id. */
1835
+ readonly createdBy?: string;
1836
+ /** Modified by user/tenant id. */
1837
+ readonly modifiedBy?: string;
1838
+ /**
1839
+ * A collection of key value pairs that belongs to the resource.
1840
+ * Each pair must not have a key greater than 50 characters
1841
+ * and must not have a value greater than 150 characters.
1842
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
1843
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
1844
+ */
1845
+ properties?: Record<string, any>;
1846
+ }
1847
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
1848
+ export interface SeasonListResponseOutput {
1849
+ /** List of requested objects. */
1850
+ value: Array<SeasonOutput>;
1851
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
1852
+ skipToken?: string;
1853
+ /** Continuation link (absolute URI) to the next page of results in the list. */
1854
+ nextLink?: string;
1855
+ }
1856
+ /** Schema of season resource. */
1857
+ export interface SeasonOutput {
1858
+ /** Season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1859
+ startDateTime?: string;
1860
+ /** Season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1861
+ endDateTime?: string;
1862
+ /** Season year. */
1863
+ year?: number;
1864
+ /** Geographic Identifier. */
1865
+ geographicIdentifier?: string;
1866
+ /** Unique resource ID. */
1867
+ readonly id?: string;
1868
+ /** The ETag value to implement optimistic concurrency. */
1869
+ readonly eTag?: string;
1870
+ /** Status of the resource. */
1871
+ status?: string;
1872
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1873
+ readonly createdDateTime?: string;
1874
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1875
+ readonly modifiedDateTime?: string;
1876
+ /** Source of the resource. */
1877
+ source?: string;
1878
+ /** Name to identify resource. */
1879
+ name?: string;
1880
+ /** Textual description of the resource. */
1881
+ description?: string;
1882
+ /** Created by user/tenant id. */
1883
+ readonly createdBy?: string;
1884
+ /** Modified by user/tenant id. */
1885
+ readonly modifiedBy?: string;
1886
+ /**
1887
+ * A collection of key value pairs that belongs to the resource.
1888
+ * Each pair must not have a key greater than 50 characters
1889
+ * and must not have a value greater than 150 characters.
1890
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
1891
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
1892
+ */
1893
+ properties?: Record<string, any>;
1894
+ }
1895
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
1896
+ export interface SensorDataModelListResponseOutput {
1897
+ /** List of requested objects. */
1898
+ value: Array<SensorDataModelOutput>;
1899
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
1900
+ skipToken?: string;
1901
+ /** Continuation link (absolute URI) to the next page of results in the list. */
1902
+ nextLink?: string;
1903
+ }
1904
+ /** SensorModel API model. */
1905
+ export interface SensorDataModelOutput {
1906
+ /** Type of sensor. */
1907
+ type?: string;
1908
+ /** Sensor manufacturer. */
1909
+ manufacturer?: string;
1910
+ /** Sensor productCode. */
1911
+ productCode?: string;
1912
+ /** Map of sensor type to sensor measures. */
1913
+ measures: Record<string, SensorDataModelMeasureOutput>;
1914
+ /** Id of the associated sensor partner. */
1915
+ readonly sensorPartnerId?: string;
1916
+ /** Id of the resource. */
1917
+ readonly id?: string;
1918
+ /** Status of the resource. */
1919
+ status?: string;
1920
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1921
+ readonly createdDateTime?: string;
1922
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
1923
+ readonly modifiedDateTime?: string;
1924
+ /** The ETag value to implement optimistic concurrency. */
1925
+ readonly eTag?: string;
1926
+ /** Name to identify resource. */
1927
+ name?: string;
1928
+ /** Textual description of the resource. */
1929
+ description?: string;
1930
+ /** Created by user/tenant id. */
1931
+ readonly createdBy?: string;
1932
+ /** Modified by user/tenant id. */
1933
+ readonly modifiedBy?: string;
1934
+ /**
1935
+ * A collection of key value pairs that belongs to the resource.
1936
+ * Each pair must not have a key greater than 50 characters
1937
+ * and must not have a value greater than 150 characters.
1938
+ * Note: A maximum of 25 key value pairs can be provided for a resource and
1939
+ * only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
1940
+ */
1941
+ properties?: Record<string, any>;
1942
+ }
1943
+ /** Sensor model measure details. */
1944
+ export interface SensorDataModelMeasureOutput {
1945
+ /** Description of sensor measure. */
1946
+ description?: string;
1947
+ /** Sensor measure data type. */
1948
+ dataType: "Bool" | "Double" | "DateTime" | "Long" | "String";
1949
+ /** Measurement type of sensor data. */
1950
+ type?: string;
1951
+ /** Unit of sensor measure. */
1952
+ unit?: string;
1953
+ /**
1954
+ * A collection of key value pairs for sensor data model.
1955
+ * Each pair must not have a key greater than 50 characters
1956
+ * and must not have a value greater than 150 characters.
1957
+ * Note: A maximum of 25 key value pairs can be provided for a model and
1958
+ * only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
1959
+ */
1960
+ properties?: Record<string, any>;
1961
+ }
1962
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
1963
+ export interface SensorEventListResponseOutput {
1964
+ /** List of requested objects. */
1965
+ value: Array<SensorEventOutput>;
1966
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
1967
+ skipToken?: string;
1968
+ /** Continuation link (absolute URI) to the next page of results in the list. */
1969
+ nextLink?: string;
1970
+ }
1971
+ /** Sensor event response model. */
1972
+ export interface SensorEventOutput {
1973
+ /** Id of the sensor. */
1974
+ sensorId?: string;
1975
+ /** Id of the sensor partner. */
1976
+ sensorPartnerId?: string;
1977
+ /** Id of the associated party. */
1978
+ partyId?: string;
1979
+ /** Id of the associated boundary. */
1980
+ boundaryId?: string;
1981
+ /** DateTime of sensor event observation. */
1982
+ eventDateTime?: string;
1983
+ /** DateTime of sensor event ingestion to data store. */
1984
+ ingestionDateTime?: string;
1985
+ /** Sensor measures. */
1986
+ measures?: Record<string, any>;
1987
+ }
1988
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
1989
+ export interface SensorMappingListResponseOutput {
1990
+ /** List of requested objects. */
1991
+ value: Array<SensorMappingOutput>;
1992
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
1993
+ skipToken?: string;
1994
+ /** Continuation link (absolute URI) to the next page of results in the list. */
1995
+ nextLink?: string;
1996
+ }
1997
+ /** SensorMapping API model. */
1998
+ export interface SensorMappingOutput {
1999
+ /** Id of the associated sensor. */
2000
+ sensorId?: string;
2001
+ /** Id of the associated sensor partner. */
2002
+ sensorPartnerId?: string;
2003
+ /** Id of the associated party. */
2004
+ partyId?: string;
2005
+ /** Id of the associated boundary. */
2006
+ boundaryId?: string;
2007
+ /** Id of the resource. */
2008
+ readonly id?: string;
2009
+ /** Status of the resource. */
2010
+ status?: string;
2011
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2012
+ readonly createdDateTime?: string;
2013
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2014
+ readonly modifiedDateTime?: string;
2015
+ /** The ETag value to implement optimistic concurrency. */
2016
+ readonly eTag?: string;
2017
+ /** Name to identify resource. */
2018
+ name?: string;
2019
+ /** Textual description of the resource. */
2020
+ description?: string;
2021
+ /** Created by user/tenant id. */
2022
+ readonly createdBy?: string;
2023
+ /** Modified by user/tenant id. */
2024
+ readonly modifiedBy?: string;
2025
+ /**
2026
+ * A collection of key value pairs that belongs to the resource.
2027
+ * Each pair must not have a key greater than 50 characters
2028
+ * and must not have a value greater than 150 characters.
2029
+ * Note: A maximum of 25 key value pairs can be provided for a resource and
2030
+ * only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
2031
+ */
2032
+ properties?: Record<string, any>;
2033
+ }
2034
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
2035
+ export interface SensorPartnerIntegrationModelListResponseOutput {
2036
+ /** List of requested objects. */
2037
+ value: Array<SensorPartnerIntegrationModelOutput>;
2038
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
2039
+ skipToken?: string;
2040
+ /** Continuation link (absolute URI) to the next page of results in the list. */
2041
+ nextLink?: string;
2042
+ }
2043
+ /** Sensor partner integration model. */
2044
+ export interface SensorPartnerIntegrationModelOutput {
2045
+ /** Id of the integration. */
2046
+ readonly integrationId?: string;
2047
+ /** Id of the party. */
2048
+ partyId?: string;
2049
+ /** Id of the associated sensor partner. */
2050
+ readonly sensorPartnerId?: string;
2051
+ /** Id of the resource. */
2052
+ readonly id?: string;
2053
+ /** Status of the resource. */
2054
+ status?: string;
2055
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2056
+ readonly createdDateTime?: string;
2057
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2058
+ readonly modifiedDateTime?: string;
2059
+ /** The ETag value to implement optimistic concurrency. */
2060
+ readonly eTag?: string;
2061
+ /** Name to identify resource. */
2062
+ name?: string;
2063
+ /** Textual description of the resource. */
2064
+ description?: string;
2065
+ /** Created by user/tenant id. */
2066
+ readonly createdBy?: string;
2067
+ /** Modified by user/tenant id. */
2068
+ readonly modifiedBy?: string;
2069
+ /**
2070
+ * A collection of key value pairs that belongs to the resource.
2071
+ * Each pair must not have a key greater than 50 characters
2072
+ * and must not have a value greater than 150 characters.
2073
+ * Note: A maximum of 25 key value pairs can be provided for a resource and
2074
+ * only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
2075
+ */
2076
+ properties?: Record<string, any>;
2077
+ }
2078
+ /** Sensor partner integration check consent response. */
2079
+ export interface SensorPartnerIntegrationCheckConsentResponseOutput {
2080
+ /** Flag to determine the status of partner integration consent. */
2081
+ consented?: boolean;
2082
+ /** Id of the associated sensor partner. */
2083
+ readonly sensorPartnerId?: string;
2084
+ /** Id of the integration. */
2085
+ readonly integrationId?: string;
2086
+ }
2087
+ /** Sensor partner integration generate consent link response. */
2088
+ export interface SensorPartnerIntegrationGenerateConsentLinkResponseOutput {
2089
+ /** Consent link. */
2090
+ readonly consentLink?: string;
2091
+ /** Consent expiry date time, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2092
+ consentExpiryDateTime?: string;
2093
+ }
2094
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
2095
+ export interface SensorListResponseOutput {
2096
+ /** List of requested objects. */
2097
+ value: Array<SensorOutput>;
2098
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
2099
+ skipToken?: string;
2100
+ /** Continuation link (absolute URI) to the next page of results in the list. */
2101
+ nextLink?: string;
2102
+ }
2103
+ /** Sensor API model. */
2104
+ export interface SensorOutput {
2105
+ /** Id of the associated sensor data model. */
2106
+ sensorDataModelId?: string;
2107
+ /** Integration id for the device. */
2108
+ integrationId?: string;
2109
+ /** Id of the associated hardware. */
2110
+ hardwareId?: string;
2111
+ /** Id of the associated device. */
2112
+ deviceId?: string;
2113
+ /** Type of sensor. */
2114
+ type?: string;
2115
+ /** Location model class. */
2116
+ location?: LocationOutput;
2117
+ /** Schema for storing port values. */
2118
+ port?: PortOutput;
2119
+ /**
2120
+ * Depth of each sensor measure in meters.
2121
+ * Like sensor moisture at 2m, 4m, 6m.
2122
+ */
2123
+ depthInMeters?: Array<number>;
2124
+ /** Id of the associated sensor partner. */
2125
+ readonly sensorPartnerId?: string;
2126
+ /** Id of the resource. */
2127
+ readonly id?: string;
2128
+ /** Status of the resource. */
2129
+ status?: string;
2130
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2131
+ readonly createdDateTime?: string;
2132
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2133
+ readonly modifiedDateTime?: string;
2134
+ /** The ETag value to implement optimistic concurrency. */
2135
+ readonly eTag?: string;
2136
+ /** Name to identify resource. */
2137
+ name?: string;
2138
+ /** Textual description of the resource. */
2139
+ description?: string;
2140
+ /** Created by user/tenant id. */
2141
+ readonly createdBy?: string;
2142
+ /** Modified by user/tenant id. */
2143
+ readonly modifiedBy?: string;
2144
+ /**
2145
+ * A collection of key value pairs that belongs to the resource.
2146
+ * Each pair must not have a key greater than 50 characters
2147
+ * and must not have a value greater than 150 characters.
2148
+ * Note: A maximum of 25 key value pairs can be provided for a resource and
2149
+ * only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
2150
+ */
2151
+ properties?: Record<string, any>;
2152
+ }
2153
+ /** Authentication via connection string to IoTHub devices. */
2154
+ export interface IoTHubDeviceAuthenticationOutput {
2155
+ /** Primary connection string of the ioTHub device. */
2156
+ readonly primaryDeviceConnectionString?: string;
2157
+ /** Secondary connection string of the ioTHub device. */
2158
+ readonly secondaryDeviceConnectionString?: string;
2159
+ }
2160
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
2161
+ export interface TillageDataListResponseOutput {
2162
+ /** List of requested objects. */
2163
+ value: Array<TillageDataOutput>;
2164
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
2165
+ skipToken?: string;
2166
+ /** Continuation link (absolute URI) to the next page of results in the list. */
2167
+ nextLink?: string;
2168
+ }
2169
+ /** Schema of tillage data resource. */
2170
+ export interface TillageDataOutput {
2171
+ /** Schema for storing measurement reading and unit. */
2172
+ tillageDepth?: MeasureOutput;
2173
+ /** Schema for storing measurement reading and unit. */
2174
+ tillagePressure?: MeasureOutput;
2175
+ /** Schema for storing measurement reading and unit. */
2176
+ area?: MeasureOutput;
2177
+ /**
2178
+ * Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ.
2179
+ * Note: this will be specified by the source provider itself.
2180
+ */
2181
+ operationModifiedDateTime?: string;
2182
+ /** Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2183
+ operationStartDateTime?: string;
2184
+ /** End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2185
+ operationEndDateTime?: string;
2186
+ /** Link for attachments. */
2187
+ readonly attachmentsLink?: string;
2188
+ /** Optional boundary ID of the field for which operation was applied. */
2189
+ associatedBoundaryId?: string;
2190
+ /** Party ID which belongs to the operation data. */
2191
+ readonly partyId?: string;
2192
+ /** Unique resource ID. */
2193
+ readonly id?: string;
2194
+ /** The ETag value to implement optimistic concurrency. */
2195
+ readonly eTag?: string;
2196
+ /** Status of the resource. */
2197
+ status?: string;
2198
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2199
+ readonly createdDateTime?: string;
2200
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2201
+ readonly modifiedDateTime?: string;
2202
+ /** Source of the resource. */
2203
+ source?: string;
2204
+ /** Name to identify resource. */
2205
+ name?: string;
2206
+ /** Textual description of the resource. */
2207
+ description?: string;
2208
+ /** Created by user/tenant id. */
2209
+ readonly createdBy?: string;
2210
+ /** Modified by user/tenant id. */
2211
+ readonly modifiedBy?: string;
2212
+ /**
2213
+ * A collection of key value pairs that belongs to the resource.
2214
+ * Each pair must not have a key greater than 50 characters
2215
+ * and must not have a value greater than 150 characters.
2216
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
2217
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
2218
+ */
2219
+ properties?: Record<string, any>;
2220
+ }
2221
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
2222
+ export interface WeatherDataListResponseOutput {
2223
+ /** List of requested objects. */
2224
+ value: Array<WeatherDataOutput>;
2225
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
2226
+ skipToken?: string;
2227
+ /** Continuation link (absolute URI) to the next page of results in the list. */
2228
+ nextLink?: string;
2229
+ }
2230
+ /** Schema of weather data. */
2231
+ export interface WeatherDataOutput {
2232
+ /** Party ID. */
2233
+ partyId: string;
2234
+ /** Boundary ID. */
2235
+ boundaryId: string;
2236
+ /** ID of the weather extension. */
2237
+ extensionId: string;
2238
+ /** Location model class. */
2239
+ location: LocationOutput;
2240
+ /** Date-time of the weather data, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2241
+ dateTime: string;
2242
+ /** Unit System like US/SI etc. */
2243
+ unitSystemCode?: string;
2244
+ /** Version of the weather data extension. */
2245
+ extensionVersion: string;
2246
+ /** Type of weather data (forecast/historical). */
2247
+ weatherDataType: string;
2248
+ /** Granularity of weather data (daily/hourly). */
2249
+ granularity: string;
2250
+ /** Schema for storing measurement reading and unit. */
2251
+ cloudCover?: MeasureOutput;
2252
+ /** Schema for storing measurement reading and unit. */
2253
+ dewPoint?: MeasureOutput;
2254
+ /** Schema for storing measurement reading and unit. */
2255
+ growingDegreeDay?: MeasureOutput;
2256
+ /** Schema for storing measurement reading and unit. */
2257
+ precipitation?: MeasureOutput;
2258
+ /** Schema for storing measurement reading and unit. */
2259
+ pressure?: MeasureOutput;
2260
+ /** Schema for storing measurement reading and unit. */
2261
+ relativeHumidity?: MeasureOutput;
2262
+ /** Schema for storing measurement reading and unit. */
2263
+ soilMoisture?: MeasureOutput;
2264
+ /** Schema for storing measurement reading and unit. */
2265
+ soilTemperature?: MeasureOutput;
2266
+ /** Schema for storing measurement reading and unit. */
2267
+ temperature?: MeasureOutput;
2268
+ /** Schema for storing measurement reading and unit. */
2269
+ visibility?: MeasureOutput;
2270
+ /** Schema for storing measurement reading and unit. */
2271
+ wetBulbTemperature?: MeasureOutput;
2272
+ /** Schema for storing measurement reading and unit. */
2273
+ windChill?: MeasureOutput;
2274
+ /** Schema for storing measurement reading and unit. */
2275
+ windDirection?: MeasureOutput;
2276
+ /** Schema for storing measurement reading and unit. */
2277
+ windGust?: MeasureOutput;
2278
+ /** Schema for storing measurement reading and unit. */
2279
+ windSpeed?: MeasureOutput;
2280
+ /** Weather data ID. */
2281
+ id?: string;
2282
+ /** The ETag value to implement optimistic concurrency. */
2283
+ readonly eTag?: string;
2284
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2285
+ readonly createdDateTime?: string;
2286
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2287
+ readonly modifiedDateTime?: string;
2288
+ /**
2289
+ * A collection of key value pairs that belongs to the resource.
2290
+ * Each pair must not have a key greater than 50 characters
2291
+ * and must not have a value greater than 250 characters.
2292
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported.
2293
+ */
2294
+ properties?: Record<string, any>;
2295
+ }
2296
+ /** Schema of weather data delete job. */
2297
+ export interface WeatherDataDeleteJobOutput {
2298
+ /** Id of the extension to be used for the providerInput. eg. DTN.ClearAg. */
2299
+ extensionId: string;
2300
+ /** The id of the party for which weather data is being fetched. */
2301
+ partyId: string;
2302
+ /** The id of the boundary object for which weather data is being fetched. */
2303
+ boundaryId: string;
2304
+ /** Type of weather data. Possible values include: 'forecast' , 'historical'. */
2305
+ weatherDataType?: string;
2306
+ /** Granularity of weather data. Possible values include: 'daily' , 'hourly'. */
2307
+ granularity?: string;
2308
+ /** Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. */
2309
+ startDateTime?: string;
2310
+ /** Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. */
2311
+ endDateTime?: string;
2312
+ /** Unique job id. */
2313
+ readonly id?: string;
2314
+ /**
2315
+ * Status of the job.
2316
+ * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
2317
+ */
2318
+ readonly status?: string;
2319
+ /** Duration of the job in seconds. */
2320
+ readonly durationInSeconds?: number;
2321
+ /** Status message to capture more details of the job. */
2322
+ readonly message?: string;
2323
+ /** Error Code when job failed. */
2324
+ readonly errorCode?: string;
2325
+ /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
2326
+ readonly createdDateTime?: string;
2327
+ /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
2328
+ readonly lastActionDateTime?: string;
2329
+ /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
2330
+ readonly startTime?: string;
2331
+ /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
2332
+ readonly endTime?: string;
2333
+ /** Name to identify resource. */
2334
+ name?: string;
2335
+ /** Textual description of the resource. */
2336
+ description?: string;
2337
+ /** Created by user/tenant id. */
2338
+ readonly createdBy?: string;
2339
+ /** Modified by user/tenant id. */
2340
+ readonly modifiedBy?: string;
2341
+ /**
2342
+ * A collection of key value pairs that belongs to the resource.
2343
+ * Each pair must not have a key greater than 50 characters
2344
+ * and must not have a value greater than 150 characters.
2345
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
2346
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
2347
+ */
2348
+ properties?: Record<string, any>;
2349
+ }
2350
+ /** Schema of weather ingestion job. */
2351
+ export interface WeatherDataIngestionJobOutput {
2352
+ /** The id of the boundary object for which weather data is being fetched. */
2353
+ boundaryId: string;
2354
+ /** The id of the party for which weather data is being fetched. */
2355
+ partyId: string;
2356
+ /** Id of the extension to be used for the providerInput. eg. DTN.ClearAg. */
2357
+ extensionId: string;
2358
+ /** Extension api name to which request is to be made. */
2359
+ extensionApiName: string;
2360
+ /** Extension api input dictionary which would be used to feed request query/body/parameter information. */
2361
+ extensionApiInput: Record<string, any>;
2362
+ /** App id of the weather data provider. */
2363
+ extensionDataProviderAppId?: string;
2364
+ /** Api key of the weather data provider. */
2365
+ extensionDataProviderApiKey?: string;
2366
+ /** Unique job id. */
2367
+ readonly id?: string;
2368
+ /**
2369
+ * Status of the job.
2370
+ * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
2371
+ */
2372
+ readonly status?: string;
2373
+ /** Duration of the job in seconds. */
2374
+ readonly durationInSeconds?: number;
2375
+ /** Status message to capture more details of the job. */
2376
+ readonly message?: string;
2377
+ /** Error Code when job failed. */
2378
+ readonly errorCode?: string;
2379
+ /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
2380
+ readonly createdDateTime?: string;
2381
+ /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
2382
+ readonly lastActionDateTime?: string;
2383
+ /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
2384
+ readonly startTime?: string;
2385
+ /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */
2386
+ readonly endTime?: string;
2387
+ /** Name to identify resource. */
2388
+ name?: string;
2389
+ /** Textual description of the resource. */
2390
+ description?: string;
2391
+ /** Created by user/tenant id. */
2392
+ readonly createdBy?: string;
2393
+ /** Modified by user/tenant id. */
2394
+ readonly modifiedBy?: string;
2395
+ /**
2396
+ * A collection of key value pairs that belongs to the resource.
2397
+ * Each pair must not have a key greater than 50 characters
2398
+ * and must not have a value greater than 150 characters.
2399
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
2400
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
2401
+ */
2402
+ properties?: Record<string, any>;
2403
+ }
2404
+ /** Schema of Location data. */
2405
+ export interface WeatherLocationOutput {
2406
+ /** Location Type eg. LatLong/IataCode/IcaoCode/Placeid/PostalKey. */
2407
+ type: "LatLong" | "IataCode" | "IcaoCode" | "PlaceId" | "PostalKey";
2408
+ /** Location Value eg. "10,-25" for LocationType Type "LatLong". */
2409
+ value: string;
2410
+ }
2411
+ /** Schema of additional parameters for weather data provider request. */
2412
+ export interface AdditionalProviderParametersOutput {
2413
+ /** Icon Resolution (Only applicable for AzureWeatherMaps). */
2414
+ iconResolution?: string;
2415
+ /** Details (Only applicable for AzureWeatherMaps). */
2416
+ details?: boolean;
2417
+ }
2418
+ /** Schema of Weather Data Provider Response. */
2419
+ export interface WeatherDataProviderResponseOutput {
2420
+ /** Schema of Weather Metadata. */
2421
+ weatherMetadata: WeatherMetadataOutput;
2422
+ /** Indicates a Succeeded, Failed, or PartiallySucceeded response. */
2423
+ status?: "Succeeded" | "Failed" | "PartiallySucceeded";
2424
+ /** List of weather data for all the weather locations. */
2425
+ locations?: Array<WeatherLocationDataOutput>;
2426
+ /** Model for errors encountered for all failed locations. */
2427
+ errors?: WeatherDataErrorsOutput;
2428
+ }
2429
+ /** Schema of Weather Metadata. */
2430
+ export interface WeatherMetadataOutput {
2431
+ /** Version of the weather data extension. */
2432
+ extensionVersion: string;
2433
+ /** Type of weather data (forecast/historical). */
2434
+ weatherDataType: string;
2435
+ /** Id of the extension to be used for the providerInput. eg. DTN.ClearAg. */
2436
+ extensionId: string;
2437
+ /** Extension api name to which request is to be made. */
2438
+ extensionApiName: string;
2439
+ /** Language (IETF BCP 47 language tag) in which search results should be returned by the data provider. Examples: 'en-US', 'es', 'es-MX', 'fr-FR'. */
2440
+ language?: string;
2441
+ /** Start of time range. Hour 0 represents the current hour. (Only applicable for DTN.ClearAg extension.) */
2442
+ startTimeHours?: number;
2443
+ /** End of time range. (Only applicable for DTN.ClearAg extension.) */
2444
+ endTimeHours?: number;
2445
+ /** Specifies for how many days the daily forecast responses are returned. Available values are 1, 5, 10, 25 and 45. (Only applicable for Azure Weather Maps extension.) */
2446
+ duration?: number;
2447
+ /** Units for which request to data provider is to be sent. Supported values are 'e' for English units, 'm' for Metric units, 'h' for Hybrid units (UK) and 's' for Metric SI units. */
2448
+ units: string;
2449
+ /** Schema of additional parameters for weather data provider request. */
2450
+ additionalParams?: AdditionalProviderParametersOutput;
2451
+ }
2452
+ /** Schema of WeatherLocationData data. */
2453
+ export interface WeatherLocationDataOutput {
2454
+ /** Schema of Location data. */
2455
+ location?: WeatherLocationOutput;
2456
+ /** Request Completion Time in Utc of the location. */
2457
+ requestCompletionTime?: string;
2458
+ /** Date-time when resource was last requested, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2459
+ lastRefreshedDateTime?: string;
2460
+ /** Schema of weather data. */
2461
+ data?: WeatherDataForPassthroughOutput;
2462
+ }
2463
+ /** Schema of weather data. */
2464
+ export interface WeatherDataForPassthroughOutput {
2465
+ /** Schema for storing measurement readings and unit. */
2466
+ wetBulbTemperature?: MeasuresOutput;
2467
+ /** Schema for storing measurement readings and unit. */
2468
+ cloudCover?: MeasuresOutput;
2469
+ /** Day of week. */
2470
+ dayOfWeek?: Array<string>;
2471
+ /** This data field indicates whether it is daytime or nighttime based on the Local Apparent Time of the location. */
2472
+ dayOrNight?: Array<string>;
2473
+ /** Expiration time in Utc format. */
2474
+ expirationTime?: Array<string>;
2475
+ /** This number is the key to the weather icon lookup. The data field shows the icon number that is matched to represent the observed weather conditions. */
2476
+ iconCode?: Array<string>;
2477
+ /** Code representing full set sensible weather. */
2478
+ iconCodeExtend?: Array<string>;
2479
+ /** Indicates whether there is precipitation or not. */
2480
+ hasPrecipitation?: Array<boolean>;
2481
+ /** Schema for storing measurement readings and unit. */
2482
+ pressureMeanSeaLevel?: MeasuresOutput;
2483
+ /** Schema for storing measurement readings and unit. */
2484
+ relativeHumidity?: MeasuresOutput;
2485
+ /** Schema for storing measurement readings and unit. */
2486
+ temperature?: MeasuresOutput;
2487
+ /** Schema for storing measurement readings and unit. */
2488
+ temperatureDewPoint?: MeasuresOutput;
2489
+ /** Schema for storing measurement readings and unit. */
2490
+ temperatureFeelsLike?: MeasuresOutput;
2491
+ /** Schema for storing measurement readings and unit. */
2492
+ temperatureHeatIndex?: MeasuresOutput;
2493
+ /** Schema for storing measurement readings and unit. */
2494
+ temperatureWindChill?: MeasuresOutput;
2495
+ /** The UV Index Description which complements the UV Index value by providing an associated level of risk of skin damage due to exposure (-2 = Not Available, -1 = No Report, 0 to 2 = Low, 3 to 5 = Moderate, 6 to 7 = High, 8 to 10 = Very High, 11 to 16 = Extreme). */
2496
+ uvDescription?: Array<string>;
2497
+ /** Hourly maximum UV index. */
2498
+ uvIndex?: Array<string>;
2499
+ /** Time forecast is valid in local apparent time. */
2500
+ validTimeLocal?: Array<string>;
2501
+ /** Time forecast is valid in Utc format. */
2502
+ validTime?: Array<string>;
2503
+ /** Schema for storing measurement readings and unit. */
2504
+ visibility?: MeasuresOutput;
2505
+ /** Schema for storing measurement readings and unit. */
2506
+ windDirection?: MeasuresOutput;
2507
+ /** Schema for storing measurement readings and unit. */
2508
+ windGust?: MeasuresOutput;
2509
+ /** Schema for storing measurement readings and unit. */
2510
+ windSpeed?: MeasuresOutput;
2511
+ /** Hourly sensible weather phrase containing longer description. */
2512
+ wxPhraseLong?: Array<string>;
2513
+ /** Hourly sensible weather phrase containing short description. */
2514
+ wxPhraseShort?: Array<string>;
2515
+ /** A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 250 characters. Note: A maximum of 100 key value pairs can be provided for a resource and only string and numeral values are supported. */
2516
+ additionalAttributes?: Record<string, any>;
2517
+ }
2518
+ /** Schema for storing measurement readings and unit. */
2519
+ export interface MeasuresOutput {
2520
+ /** Data unit. */
2521
+ unit?: string;
2522
+ /** Data values. */
2523
+ values?: Array<number>;
2524
+ }
2525
+ /** Model for errors encountered for all failed locations. */
2526
+ export interface WeatherDataErrorsOutput {
2527
+ /** List of errors encountered for all failed locations. */
2528
+ locations?: Array<ErrorForLocationOutput>;
2529
+ }
2530
+ /** Model for error information for a failed location. */
2531
+ export interface ErrorForLocationOutput {
2532
+ /** Schema of Location data. */
2533
+ location?: WeatherLocationOutput;
2534
+ /** Status code returned by data provider. */
2535
+ code?: number;
2536
+ /** Description of the error. */
2537
+ description?: string;
2538
+ /** Flag suggesting if retry attempt with same request body should be made to fetch required data. */
2539
+ retryable?: boolean;
2540
+ }
2541
+ /** Paged response contains list of requested objects and a URL link to get the next set of results. */
2542
+ export interface ZoneListResponseOutput {
2543
+ /** List of requested objects. */
2544
+ value: Array<ZoneOutput>;
2545
+ /** Token used in retrieving the next page. If null, there are no additional pages. */
2546
+ skipToken?: string;
2547
+ /** Continuation link (absolute URI) to the next page of results in the list. */
2548
+ nextLink?: string;
2549
+ }
2550
+ /** Api Model for Zone object. */
2551
+ export interface ZoneOutput {
2552
+ /** Party Id associated with the Zone. */
2553
+ readonly partyId?: string;
2554
+ /** Type of the Zone. */
2555
+ type?: string;
2556
+ /** Management Zone Id associated with the Zone. */
2557
+ managementZoneId?: string;
2558
+ /** Unique resource ID. */
2559
+ readonly id?: string;
2560
+ /** The ETag value to implement optimistic concurrency. */
2561
+ readonly eTag?: string;
2562
+ /** Status of the resource. */
2563
+ status?: string;
2564
+ /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2565
+ readonly createdDateTime?: string;
2566
+ /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */
2567
+ readonly modifiedDateTime?: string;
2568
+ /** Source of the resource. */
2569
+ source?: string;
2570
+ /** Name to identify resource. */
2571
+ name?: string;
2572
+ /** Textual description of the resource. */
2573
+ description?: string;
2574
+ /** Created by user/tenant id. */
2575
+ readonly createdBy?: string;
2576
+ /** Modified by user/tenant id. */
2577
+ readonly modifiedBy?: string;
2578
+ /**
2579
+ * A collection of key value pairs that belongs to the resource.
2580
+ * Each pair must not have a key greater than 50 characters
2581
+ * and must not have a value greater than 150 characters.
2582
+ * Note: A maximum of 25 key value pairs can be provided for a resource and only string,
2583
+ * numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
2584
+ */
2585
+ properties?: Record<string, any>;
2586
+ }
2587
+ /** MultiPolygon geometry. */
2588
+ export interface MultiPolygonOutput extends GeoJsonObjectOutputParent {
2589
+ /**
2590
+ * Gets or sets Coordinates of GeoJSON Object.
2591
+ * It must be an array of polygons, each polygon contains list of linear rings.
2592
+ * For Polygons with more than one of these rings, the first MUST be the exterior ring,
2593
+ * and any others MUST be interior rings.
2594
+ */
2595
+ coordinates: Array<Array<Array<Array<number>>>>;
2596
+ type: "MultiPolygon";
2597
+ }
2598
+ /** Point geometry. */
2599
+ export interface PointOutput extends GeoJsonObjectOutputParent {
2600
+ /**
2601
+ * Gets or sets the coordinate of this point.
2602
+ * It must be an array of 2 or 3 elements for a 2D or 3D system.
2603
+ */
2604
+ coordinates: Array<number>;
2605
+ type: "Point";
2606
+ }
2607
+ /** Polygon geometry. */
2608
+ export interface PolygonOutput extends GeoJsonObjectOutputParent {
2609
+ /**
2610
+ * Gets or sets type of the GeoJSON Object.
2611
+ * It must be an array of linear ring coordinate arrays.
2612
+ * For Polygons with more than one of these rings, the first MUST be the exterior ring,
2613
+ * and any others MUST be interior rings.
2614
+ */
2615
+ coordinates: Array<Array<Array<number>>>;
2616
+ type: "Polygon";
2617
+ }
2618
+ /** GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format. */
2619
+ export type GeoJsonObjectOutput = MultiPolygonOutput | PointOutput | PolygonOutput;
2620
+ //# sourceMappingURL=outputModels.d.ts.map