deere-sdk 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +38 -0
- package/LICENSE +21 -0
- package/README.md +253 -0
- package/dist/api/assets.d.ts +78 -0
- package/dist/api/assets.d.ts.map +1 -0
- package/dist/api/assets.js +115 -0
- package/dist/api/assets.js.map +1 -0
- package/dist/api/boundaries.d.ts +69 -0
- package/dist/api/boundaries.d.ts.map +1 -0
- package/dist/api/boundaries.js +102 -0
- package/dist/api/boundaries.js.map +1 -0
- package/dist/api/clients.d.ts +71 -0
- package/dist/api/clients.d.ts.map +1 -0
- package/dist/api/clients.js +104 -0
- package/dist/api/clients.js.map +1 -0
- package/dist/api/connection-management.d.ts +41 -0
- package/dist/api/connection-management.d.ts.map +1 -0
- package/dist/api/connection-management.js +56 -0
- package/dist/api/connection-management.js.map +1 -0
- package/dist/api/crop-types.d.ts +48 -0
- package/dist/api/crop-types.d.ts.map +1 -0
- package/dist/api/crop-types.js +69 -0
- package/dist/api/crop-types.js.map +1 -0
- package/dist/api/equipment.d.ts +138 -0
- package/dist/api/equipment.d.ts.map +1 -0
- package/dist/api/equipment.js +214 -0
- package/dist/api/equipment.js.map +1 -0
- package/dist/api/farms.d.ts +69 -0
- package/dist/api/farms.d.ts.map +1 -0
- package/dist/api/farms.js +100 -0
- package/dist/api/farms.js.map +1 -0
- package/dist/api/field-operations-api.d.ts +56 -0
- package/dist/api/field-operations-api.d.ts.map +1 -0
- package/dist/api/field-operations-api.js +88 -0
- package/dist/api/field-operations-api.js.map +1 -0
- package/dist/api/field-operations.d.ts +83 -0
- package/dist/api/field-operations.d.ts.map +1 -0
- package/dist/api/field-operations.js +134 -0
- package/dist/api/field-operations.js.map +1 -0
- package/dist/api/fields.d.ts +73 -0
- package/dist/api/fields.d.ts.map +1 -0
- package/dist/api/fields.js +113 -0
- package/dist/api/fields.js.map +1 -0
- package/dist/api/files.d.ts +63 -0
- package/dist/api/files.d.ts.map +1 -0
- package/dist/api/files.js +96 -0
- package/dist/api/files.js.map +1 -0
- package/dist/api/flags.d.ts +96 -0
- package/dist/api/flags.d.ts.map +1 -0
- package/dist/api/flags.js +159 -0
- package/dist/api/flags.js.map +1 -0
- package/dist/api/guidance-lines.d.ts +52 -0
- package/dist/api/guidance-lines.d.ts.map +1 -0
- package/dist/api/guidance-lines.js +77 -0
- package/dist/api/guidance-lines.js.map +1 -0
- package/dist/api/index.d.ts +43 -0
- package/dist/api/index.d.ts.map +1 -0
- package/dist/api/index.js +25 -0
- package/dist/api/index.js.map +1 -0
- package/dist/api/map-layers.d.ts +49 -0
- package/dist/api/map-layers.d.ts.map +1 -0
- package/dist/api/map-layers.js +69 -0
- package/dist/api/map-layers.js.map +1 -0
- package/dist/api/operators.d.ts +67 -0
- package/dist/api/operators.d.ts.map +1 -0
- package/dist/api/operators.js +99 -0
- package/dist/api/operators.js.map +1 -0
- package/dist/api/organizations.d.ts +45 -0
- package/dist/api/organizations.d.ts.map +1 -0
- package/dist/api/organizations.js +64 -0
- package/dist/api/organizations.js.map +1 -0
- package/dist/api/products.d.ts +88 -0
- package/dist/api/products.d.ts.map +1 -0
- package/dist/api/products.js +132 -0
- package/dist/api/products.js.map +1 -0
- package/dist/api/users.d.ts +22 -0
- package/dist/api/users.d.ts.map +1 -0
- package/dist/api/users.js +26 -0
- package/dist/api/users.js.map +1 -0
- package/dist/api/webhook.d.ts +42 -0
- package/dist/api/webhook.d.ts.map +1 -0
- package/dist/api/webhook.js +57 -0
- package/dist/api/webhook.js.map +1 -0
- package/dist/client.d.ts +114 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +224 -0
- package/dist/client.js.map +1 -0
- package/dist/deere.d.ts +98 -0
- package/dist/deere.d.ts.map +1 -0
- package/dist/deere.js +120 -0
- package/dist/deere.js.map +1 -0
- package/dist/index.d.ts +36 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +39 -0
- package/dist/index.js.map +1 -0
- package/dist/types/generated/assets.d.ts +839 -0
- package/dist/types/generated/assets.d.ts.map +1 -0
- package/dist/types/generated/assets.js +6 -0
- package/dist/types/generated/assets.js.map +1 -0
- package/dist/types/generated/boundaries.d.ts +734 -0
- package/dist/types/generated/boundaries.d.ts.map +1 -0
- package/dist/types/generated/boundaries.js +6 -0
- package/dist/types/generated/boundaries.js.map +1 -0
- package/dist/types/generated/clients.d.ts +602 -0
- package/dist/types/generated/clients.d.ts.map +1 -0
- package/dist/types/generated/clients.js +6 -0
- package/dist/types/generated/clients.js.map +1 -0
- package/dist/types/generated/connection-management.d.ts +210 -0
- package/dist/types/generated/connection-management.d.ts.map +1 -0
- package/dist/types/generated/connection-management.js +6 -0
- package/dist/types/generated/connection-management.js.map +1 -0
- package/dist/types/generated/crop-types.d.ts +541 -0
- package/dist/types/generated/crop-types.d.ts.map +1 -0
- package/dist/types/generated/crop-types.js +6 -0
- package/dist/types/generated/crop-types.js.map +1 -0
- package/dist/types/generated/equipment.d.ts +2599 -0
- package/dist/types/generated/equipment.d.ts.map +1 -0
- package/dist/types/generated/equipment.js +6 -0
- package/dist/types/generated/equipment.js.map +1 -0
- package/dist/types/generated/farms.d.ts +520 -0
- package/dist/types/generated/farms.d.ts.map +1 -0
- package/dist/types/generated/farms.js +6 -0
- package/dist/types/generated/farms.js.map +1 -0
- package/dist/types/generated/field-operations-api.d.ts +1724 -0
- package/dist/types/generated/field-operations-api.d.ts.map +1 -0
- package/dist/types/generated/field-operations-api.js +6 -0
- package/dist/types/generated/field-operations-api.js.map +1 -0
- package/dist/types/generated/fields.d.ts +904 -0
- package/dist/types/generated/fields.d.ts.map +1 -0
- package/dist/types/generated/fields.js +6 -0
- package/dist/types/generated/fields.js.map +1 -0
- package/dist/types/generated/files.d.ts +598 -0
- package/dist/types/generated/files.d.ts.map +1 -0
- package/dist/types/generated/files.js +6 -0
- package/dist/types/generated/files.js.map +1 -0
- package/dist/types/generated/flags.d.ts +593 -0
- package/dist/types/generated/flags.d.ts.map +1 -0
- package/dist/types/generated/flags.js +6 -0
- package/dist/types/generated/flags.js.map +1 -0
- package/dist/types/generated/guidance-lines.d.ts +405 -0
- package/dist/types/generated/guidance-lines.d.ts.map +1 -0
- package/dist/types/generated/guidance-lines.js +6 -0
- package/dist/types/generated/guidance-lines.js.map +1 -0
- package/dist/types/generated/index.d.ts +44 -0
- package/dist/types/generated/index.d.ts.map +1 -0
- package/dist/types/generated/index.js +26 -0
- package/dist/types/generated/index.js.map +1 -0
- package/dist/types/generated/map-layers.d.ts +696 -0
- package/dist/types/generated/map-layers.d.ts.map +1 -0
- package/dist/types/generated/map-layers.js +6 -0
- package/dist/types/generated/map-layers.js.map +1 -0
- package/dist/types/generated/operators.d.ts +361 -0
- package/dist/types/generated/operators.d.ts.map +1 -0
- package/dist/types/generated/operators.js +6 -0
- package/dist/types/generated/operators.js.map +1 -0
- package/dist/types/generated/organizations.d.ts +308 -0
- package/dist/types/generated/organizations.d.ts.map +1 -0
- package/dist/types/generated/organizations.js +6 -0
- package/dist/types/generated/organizations.js.map +1 -0
- package/dist/types/generated/products.d.ts +1165 -0
- package/dist/types/generated/products.d.ts.map +1 -0
- package/dist/types/generated/products.js +6 -0
- package/dist/types/generated/products.js.map +1 -0
- package/dist/types/generated/users.d.ts +96 -0
- package/dist/types/generated/users.d.ts.map +1 -0
- package/dist/types/generated/users.js +6 -0
- package/dist/types/generated/users.js.map +1 -0
- package/dist/types/generated/webhook.d.ts +475 -0
- package/dist/types/generated/webhook.d.ts.map +1 -0
- package/dist/types/generated/webhook.js +6 -0
- package/dist/types/generated/webhook.js.map +1 -0
- package/dist/types/index.d.ts +25 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/index.js +25 -0
- package/dist/types/index.js.map +1 -0
- package/package.json +70 -0
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* FieldOperationsApi
|
|
3
|
+
*
|
|
4
|
+
* Auto-generated SDK wrapper for John Deere field-operations-api API.
|
|
5
|
+
* @generated from field-operations-api.yaml
|
|
6
|
+
*/
|
|
7
|
+
export class FieldOperationsApi {
|
|
8
|
+
client;
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.client = client;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* List Field Operations
|
|
14
|
+
* @description This resource returns logical data structures representing the agronomic operations performed in a field. Supported field operation types include Seeding, Application, and Harvest. A single field operation may potentially span consecutive days depending on the type of operation. Each field operation may have one or more measurements, listed as links from the field operation itself. Each field operation will include links to: <br/> <ul> <li><b>organization:</b> The organization which owns this data.</li> <li><b>field:</b> The field in which this operation was performed.</li> <li><b>self:</b> The field operation.</li> </ul>
|
|
15
|
+
* @generated from GET /organizations/{orgId}/fields/{fieldId}/fieldOperations
|
|
16
|
+
*/
|
|
17
|
+
async list(orgId, fieldId, params, options) {
|
|
18
|
+
const query = new URLSearchParams();
|
|
19
|
+
if (params?.cropSeason !== undefined)
|
|
20
|
+
query.set('cropSeason', String(params.cropSeason));
|
|
21
|
+
if (params?.fieldOperationType !== undefined)
|
|
22
|
+
query.set('fieldOperationType', String(params.fieldOperationType));
|
|
23
|
+
if (params?.startDate !== undefined)
|
|
24
|
+
query.set('startDate', String(params.startDate));
|
|
25
|
+
if (params?.endDate !== undefined)
|
|
26
|
+
query.set('endDate', String(params.endDate));
|
|
27
|
+
if (params?.embed !== undefined)
|
|
28
|
+
query.set('embed', String(params.embed));
|
|
29
|
+
if (params?.workPlanIds !== undefined)
|
|
30
|
+
query.set('workPlanIds', String(params.workPlanIds));
|
|
31
|
+
const queryString = query.toString();
|
|
32
|
+
const path = `/organizations/${orgId}/fields/${fieldId}/fieldOperations${queryString ? `?${queryString}` : ''}`;
|
|
33
|
+
return this.client.get(path, options);
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Get all items (follows pagination automatically)
|
|
37
|
+
* @generated from GET /organizations/{orgId}/fields/{fieldId}/fieldOperations
|
|
38
|
+
*/
|
|
39
|
+
async listAll(orgId, fieldId, params, options) {
|
|
40
|
+
const query = new URLSearchParams();
|
|
41
|
+
if (params?.cropSeason !== undefined)
|
|
42
|
+
query.set('cropSeason', String(params.cropSeason));
|
|
43
|
+
if (params?.fieldOperationType !== undefined)
|
|
44
|
+
query.set('fieldOperationType', String(params.fieldOperationType));
|
|
45
|
+
if (params?.startDate !== undefined)
|
|
46
|
+
query.set('startDate', String(params.startDate));
|
|
47
|
+
if (params?.endDate !== undefined)
|
|
48
|
+
query.set('endDate', String(params.endDate));
|
|
49
|
+
if (params?.embed !== undefined)
|
|
50
|
+
query.set('embed', String(params.embed));
|
|
51
|
+
if (params?.workPlanIds !== undefined)
|
|
52
|
+
query.set('workPlanIds', String(params.workPlanIds));
|
|
53
|
+
const queryString = query.toString();
|
|
54
|
+
const path = `/organizations/${orgId}/fields/${fieldId}/fieldOperations${queryString ? `?${queryString}` : ''}`;
|
|
55
|
+
return this.client.getAll(path, options);
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* View a Field Operation
|
|
59
|
+
* @description View a single field operation. The response will include links to: <br/> <ul> <li><b>organization:</b> The organization which owns this data.</li> <li><b>field:</b> The field in which this operation was performed.</li> <li><b>self:</b> The field operation.</li> <ul>
|
|
60
|
+
* @generated from GET /fieldOperations/{operationId}
|
|
61
|
+
*/
|
|
62
|
+
async get(operationId, params, options) {
|
|
63
|
+
const query = new URLSearchParams();
|
|
64
|
+
if (params?.embed !== undefined)
|
|
65
|
+
query.set('embed', String(params.embed));
|
|
66
|
+
const queryString = query.toString();
|
|
67
|
+
const path = `/fieldOperations/${operationId}${queryString ? `?${queryString}` : ''}`;
|
|
68
|
+
return this.client.get(path, options);
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Asynchronous Shapefile Download
|
|
72
|
+
* @description An ESRI Shapefile is available for each Field Operation. <b>Please see the <a href=/dev-docs/field-operations#shapefile-overview>shapefiles overview</a> for details</b> on the shapefile format and how to consume it.<p>The expected response codes are:</p> <ul> <li><b>202 Accepted – </b>The request was received and is being processed. Call back later to check for completion. <ul> <li>This API does not currently support webhooks. To check for completion, repeat the same API call until you get an HTTP 307.</li> <li>Processing may take up to 30 minutes, depending on the size of data. Applications should poll the API using a backoff loop. Polling intervals should start at 5 seconds and double with each attempt: <mark>secondsToWait = 5 * 2 ^ (numberOfAttempts - 1)</mark></li> </ul> </li> <li><b>307 Temporary Redirect – </b>The shapefile is ready to download. This response contains a location header. The location is a pre-signed URL that is valid for no less than one hour. To download the file, perform a GET request to the URL in the location header. Do not apply OAuth signing or other authorization to this request - it will cause the call to fail. </li> <li><b>406 Not Acceptable - </b>A shapefile cannot be generated. </li> </ul> Note the initial call for a shapefile may receive either a 202 or a 307 response, depending upon whether an up-to-date file already exists for the specified field operation. <br/><br/>For a sample integration, see our <a href=https://github.com/JohnDeere/MyJohnDeereAPI-OAuth2-Java-Example>Java sample code</a>.
|
|
73
|
+
* @generated from GET /fieldOps/{operationId}
|
|
74
|
+
*/
|
|
75
|
+
async getFieldops(operationId, params, options) {
|
|
76
|
+
const query = new URLSearchParams();
|
|
77
|
+
if (params?.splitShapeFile !== undefined)
|
|
78
|
+
query.set('splitShapeFile', String(params.splitShapeFile));
|
|
79
|
+
if (params?.shapeType !== undefined)
|
|
80
|
+
query.set('shapeType', String(params.shapeType));
|
|
81
|
+
if (params?.resolution !== undefined)
|
|
82
|
+
query.set('resolution', String(params.resolution));
|
|
83
|
+
const queryString = query.toString();
|
|
84
|
+
const path = `/fieldOps/${operationId}${queryString ? `?${queryString}` : ''}`;
|
|
85
|
+
return this.client.get(path, options);
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
//# sourceMappingURL=field-operations-api.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"field-operations-api.js","sourceRoot":"","sources":["../../src/api/field-operations-api.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,MAAM,OAAO,kBAAkB;IACA;IAA7B,YAA6B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAEpD;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,KAAa,EAAE,OAAe,EAAE,MAAsJ,EAAE,OAAwB;QACzN,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,MAAM,EAAE,UAAU,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACzF,IAAI,MAAM,EAAE,kBAAkB,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,oBAAoB,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC;QACjH,IAAI,MAAM,EAAE,SAAS,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QACtF,IAAI,MAAM,EAAE,OAAO,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QAChF,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,IAAI,MAAM,EAAE,WAAW,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QAC5F,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,kBAAkB,KAAK,WAAW,OAAO,mBAAmB,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAChH,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAU,IAAI,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,KAAa,EAAE,OAAe,EAAE,MAAsJ,EAAE,OAAwB;QAC5N,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,MAAM,EAAE,UAAU,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACzF,IAAI,MAAM,EAAE,kBAAkB,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,oBAAoB,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC;QACjH,IAAI,MAAM,EAAE,SAAS,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QACtF,IAAI,MAAM,EAAE,OAAO,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QAChF,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,IAAI,MAAM,EAAE,WAAW,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QAC5F,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,kBAAkB,KAAK,WAAW,OAAO,mBAAmB,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAChH,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAU,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,WAAmB,EAAE,MAAuC,EAAE,OAAwB;QAC9F,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,oBAAoB,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACtF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAU,IAAI,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,WAAmB,EAAE,MAA8H,EAAE,OAAwB;QAC7L,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,MAAM,EAAE,cAAc,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;QACrG,IAAI,MAAM,EAAE,SAAS,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QACtF,IAAI,MAAM,EAAE,UAAU,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACzF,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,aAAa,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC/E,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAU,IAAI,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;CACF"}
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Field Operations API
|
|
3
|
+
*
|
|
4
|
+
* Typed wrapper for John Deere Field Operations endpoints.
|
|
5
|
+
* Includes harvest, planting, and application data.
|
|
6
|
+
*/
|
|
7
|
+
import type { DeereClient, RequestOptions, PaginatedResponse, Link } from '../client.js';
|
|
8
|
+
export type FieldOperationType = 'seeded' | 'harvested' | 'applied' | 'tillage' | 'unknown';
|
|
9
|
+
export interface FieldOperation {
|
|
10
|
+
'@type'?: string;
|
|
11
|
+
id: string;
|
|
12
|
+
operationType: FieldOperationType;
|
|
13
|
+
startDate: string;
|
|
14
|
+
endDate?: string;
|
|
15
|
+
area?: {
|
|
16
|
+
value: number;
|
|
17
|
+
unit: string;
|
|
18
|
+
};
|
|
19
|
+
products?: OperationProduct[];
|
|
20
|
+
machine?: OperationMachine;
|
|
21
|
+
links?: Link[];
|
|
22
|
+
}
|
|
23
|
+
export interface OperationProduct {
|
|
24
|
+
'@type'?: string;
|
|
25
|
+
name?: string;
|
|
26
|
+
rate?: {
|
|
27
|
+
value: number;
|
|
28
|
+
unit: string;
|
|
29
|
+
};
|
|
30
|
+
totalApplied?: {
|
|
31
|
+
value: number;
|
|
32
|
+
unit: string;
|
|
33
|
+
};
|
|
34
|
+
}
|
|
35
|
+
export interface OperationMachine {
|
|
36
|
+
'@type'?: string;
|
|
37
|
+
name?: string;
|
|
38
|
+
id?: string;
|
|
39
|
+
machineType?: string;
|
|
40
|
+
}
|
|
41
|
+
export interface FieldOperationsListParams {
|
|
42
|
+
/** Filter by operation type: seeded, harvested, applied, tillage */
|
|
43
|
+
operationType?: FieldOperationType;
|
|
44
|
+
/** Start date filter (ISO 8601) */
|
|
45
|
+
startDate?: string;
|
|
46
|
+
/** End date filter (ISO 8601) */
|
|
47
|
+
endDate?: string;
|
|
48
|
+
/** Embed additional resources */
|
|
49
|
+
embed?: string;
|
|
50
|
+
}
|
|
51
|
+
export declare class FieldOperationsApi {
|
|
52
|
+
private readonly client;
|
|
53
|
+
constructor(client: DeereClient);
|
|
54
|
+
/**
|
|
55
|
+
* List field operations for an organization
|
|
56
|
+
*/
|
|
57
|
+
list(orgId: string, params?: FieldOperationsListParams, options?: RequestOptions): Promise<PaginatedResponse<FieldOperation>>;
|
|
58
|
+
/**
|
|
59
|
+
* List field operations for a specific field
|
|
60
|
+
*/
|
|
61
|
+
listForField(orgId: string, fieldId: string, params?: FieldOperationsListParams, options?: RequestOptions): Promise<PaginatedResponse<FieldOperation>>;
|
|
62
|
+
/**
|
|
63
|
+
* Get all field operations for an organization (follows pagination)
|
|
64
|
+
*/
|
|
65
|
+
listAll(orgId: string, params?: FieldOperationsListParams, options?: RequestOptions): Promise<FieldOperation[]>;
|
|
66
|
+
/**
|
|
67
|
+
* Get a specific field operation
|
|
68
|
+
*/
|
|
69
|
+
get(orgId: string, operationId: string, options?: RequestOptions): Promise<FieldOperation>;
|
|
70
|
+
/**
|
|
71
|
+
* Get harvest data for a field
|
|
72
|
+
*/
|
|
73
|
+
getHarvestData(orgId: string, fieldId?: string, params?: Omit<FieldOperationsListParams, 'operationType'>, options?: RequestOptions): Promise<FieldOperation[]>;
|
|
74
|
+
/**
|
|
75
|
+
* Get planting data for a field
|
|
76
|
+
*/
|
|
77
|
+
getPlantingData(orgId: string, fieldId?: string, params?: Omit<FieldOperationsListParams, 'operationType'>, options?: RequestOptions): Promise<FieldOperation[]>;
|
|
78
|
+
/**
|
|
79
|
+
* Get application data for a field (fertilizer, herbicide, etc.)
|
|
80
|
+
*/
|
|
81
|
+
getApplicationData(orgId: string, fieldId?: string, params?: Omit<FieldOperationsListParams, 'operationType'>, options?: RequestOptions): Promise<FieldOperation[]>;
|
|
82
|
+
}
|
|
83
|
+
//# sourceMappingURL=field-operations.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"field-operations.d.ts","sourceRoot":"","sources":["../../src/api/field-operations.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEzF,MAAM,MAAM,kBAAkB,GAC1B,QAAQ,GACR,WAAW,GACX,SAAS,GACT,SAAS,GACT,SAAS,CAAC;AAEd,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,kBAAkB,CAAC;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,QAAQ,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC9B,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,YAAY,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAChD;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC,oEAAoE;IACpE,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC,mCAAmC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iCAAiC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,qBAAa,kBAAkB;IACjB,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,WAAW;IAEhD;;OAEG;IACG,IAAI,CACR,KAAK,EAAE,MAAM,EACb,MAAM,CAAC,EAAE,yBAAyB,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAe7C;;OAEG;IACG,YAAY,CAChB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,yBAAyB,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAe7C;;OAEG;IACG,OAAO,CACX,KAAK,EAAE,MAAM,EACb,MAAM,CAAC,EAAE,yBAAyB,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,cAAc,EAAE,CAAC;IAe5B;;OAEG;IACG,GAAG,CACP,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,cAAc,CAAC;IAS1B;;OAEG;IACG,cAAc,CAClB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,IAAI,CAAC,yBAAyB,EAAE,eAAe,CAAC,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,cAAc,EAAE,CAAC;IAgB5B;;OAEG;IACG,eAAe,CACnB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,IAAI,CAAC,yBAAyB,EAAE,eAAe,CAAC,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,cAAc,EAAE,CAAC;IAgB5B;;OAEG;IACG,kBAAkB,CACtB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,IAAI,CAAC,yBAAyB,EAAE,eAAe,CAAC,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,cAAc,EAAE,CAAC;CAe7B"}
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Field Operations API
|
|
3
|
+
*
|
|
4
|
+
* Typed wrapper for John Deere Field Operations endpoints.
|
|
5
|
+
* Includes harvest, planting, and application data.
|
|
6
|
+
*/
|
|
7
|
+
export class FieldOperationsApi {
|
|
8
|
+
client;
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.client = client;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* List field operations for an organization
|
|
14
|
+
*/
|
|
15
|
+
async list(orgId, params, options) {
|
|
16
|
+
const query = new URLSearchParams();
|
|
17
|
+
if (params?.operationType)
|
|
18
|
+
query.set('operationType', params.operationType);
|
|
19
|
+
if (params?.startDate)
|
|
20
|
+
query.set('startDate', params.startDate);
|
|
21
|
+
if (params?.endDate)
|
|
22
|
+
query.set('endDate', params.endDate);
|
|
23
|
+
if (params?.embed)
|
|
24
|
+
query.set('embed', params.embed);
|
|
25
|
+
const queryString = query.toString();
|
|
26
|
+
const path = queryString
|
|
27
|
+
? `/organizations/${orgId}/fieldOperations?${queryString}`
|
|
28
|
+
: `/organizations/${orgId}/fieldOperations`;
|
|
29
|
+
return this.client.get(path, options);
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* List field operations for a specific field
|
|
33
|
+
*/
|
|
34
|
+
async listForField(orgId, fieldId, params, options) {
|
|
35
|
+
const query = new URLSearchParams();
|
|
36
|
+
if (params?.operationType)
|
|
37
|
+
query.set('operationType', params.operationType);
|
|
38
|
+
if (params?.startDate)
|
|
39
|
+
query.set('startDate', params.startDate);
|
|
40
|
+
if (params?.endDate)
|
|
41
|
+
query.set('endDate', params.endDate);
|
|
42
|
+
if (params?.embed)
|
|
43
|
+
query.set('embed', params.embed);
|
|
44
|
+
const queryString = query.toString();
|
|
45
|
+
const path = queryString
|
|
46
|
+
? `/organizations/${orgId}/fields/${fieldId}/fieldOperations?${queryString}`
|
|
47
|
+
: `/organizations/${orgId}/fields/${fieldId}/fieldOperations`;
|
|
48
|
+
return this.client.get(path, options);
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Get all field operations for an organization (follows pagination)
|
|
52
|
+
*/
|
|
53
|
+
async listAll(orgId, params, options) {
|
|
54
|
+
const query = new URLSearchParams();
|
|
55
|
+
if (params?.operationType)
|
|
56
|
+
query.set('operationType', params.operationType);
|
|
57
|
+
if (params?.startDate)
|
|
58
|
+
query.set('startDate', params.startDate);
|
|
59
|
+
if (params?.endDate)
|
|
60
|
+
query.set('endDate', params.endDate);
|
|
61
|
+
if (params?.embed)
|
|
62
|
+
query.set('embed', params.embed);
|
|
63
|
+
const queryString = query.toString();
|
|
64
|
+
const path = queryString
|
|
65
|
+
? `/organizations/${orgId}/fieldOperations?${queryString}`
|
|
66
|
+
: `/organizations/${orgId}/fieldOperations`;
|
|
67
|
+
return this.client.getAll(path, options);
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Get a specific field operation
|
|
71
|
+
*/
|
|
72
|
+
async get(orgId, operationId, options) {
|
|
73
|
+
return this.client.get(`/organizations/${orgId}/fieldOperations/${operationId}`, options);
|
|
74
|
+
}
|
|
75
|
+
// Convenience methods for common operation types
|
|
76
|
+
/**
|
|
77
|
+
* Get harvest data for a field
|
|
78
|
+
*/
|
|
79
|
+
async getHarvestData(orgId, fieldId, params, options) {
|
|
80
|
+
const query = new URLSearchParams();
|
|
81
|
+
query.set('operationType', 'harvested');
|
|
82
|
+
if (params?.startDate)
|
|
83
|
+
query.set('startDate', params.startDate);
|
|
84
|
+
if (params?.endDate)
|
|
85
|
+
query.set('endDate', params.endDate);
|
|
86
|
+
if (params?.embed)
|
|
87
|
+
query.set('embed', params.embed);
|
|
88
|
+
const queryString = query.toString();
|
|
89
|
+
const basePath = fieldId
|
|
90
|
+
? `/organizations/${orgId}/fields/${fieldId}/fieldOperations`
|
|
91
|
+
: `/organizations/${orgId}/fieldOperations`;
|
|
92
|
+
const path = `${basePath}?${queryString}`;
|
|
93
|
+
return this.client.getAll(path, options);
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Get planting data for a field
|
|
97
|
+
*/
|
|
98
|
+
async getPlantingData(orgId, fieldId, params, options) {
|
|
99
|
+
const query = new URLSearchParams();
|
|
100
|
+
query.set('operationType', 'seeded');
|
|
101
|
+
if (params?.startDate)
|
|
102
|
+
query.set('startDate', params.startDate);
|
|
103
|
+
if (params?.endDate)
|
|
104
|
+
query.set('endDate', params.endDate);
|
|
105
|
+
if (params?.embed)
|
|
106
|
+
query.set('embed', params.embed);
|
|
107
|
+
const queryString = query.toString();
|
|
108
|
+
const basePath = fieldId
|
|
109
|
+
? `/organizations/${orgId}/fields/${fieldId}/fieldOperations`
|
|
110
|
+
: `/organizations/${orgId}/fieldOperations`;
|
|
111
|
+
const path = `${basePath}?${queryString}`;
|
|
112
|
+
return this.client.getAll(path, options);
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* Get application data for a field (fertilizer, herbicide, etc.)
|
|
116
|
+
*/
|
|
117
|
+
async getApplicationData(orgId, fieldId, params, options) {
|
|
118
|
+
const query = new URLSearchParams();
|
|
119
|
+
query.set('operationType', 'applied');
|
|
120
|
+
if (params?.startDate)
|
|
121
|
+
query.set('startDate', params.startDate);
|
|
122
|
+
if (params?.endDate)
|
|
123
|
+
query.set('endDate', params.endDate);
|
|
124
|
+
if (params?.embed)
|
|
125
|
+
query.set('embed', params.embed);
|
|
126
|
+
const queryString = query.toString();
|
|
127
|
+
const basePath = fieldId
|
|
128
|
+
? `/organizations/${orgId}/fields/${fieldId}/fieldOperations`
|
|
129
|
+
: `/organizations/${orgId}/fieldOperations`;
|
|
130
|
+
const path = `${basePath}?${queryString}`;
|
|
131
|
+
return this.client.getAll(path, options);
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
//# sourceMappingURL=field-operations.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"field-operations.js","sourceRoot":"","sources":["../../src/api/field-operations.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAgDH,MAAM,OAAO,kBAAkB;IACA;IAA7B,YAA6B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAEpD;;OAEG;IACH,KAAK,CAAC,IAAI,CACR,KAAa,EACb,MAAkC,EAClC,OAAwB;QAExB,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,MAAM,EAAE,aAAa;YAAE,KAAK,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;QAC5E,IAAI,MAAM,EAAE,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAChE,IAAI,MAAM,EAAE,OAAO;YAAE,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,MAAM,EAAE,KAAK;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QAEpD,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,WAAW;YACtB,CAAC,CAAC,kBAAkB,KAAK,oBAAoB,WAAW,EAAE;YAC1D,CAAC,CAAC,kBAAkB,KAAK,kBAAkB,CAAC;QAE9C,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAoC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAChB,KAAa,EACb,OAAe,EACf,MAAkC,EAClC,OAAwB;QAExB,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,MAAM,EAAE,aAAa;YAAE,KAAK,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;QAC5E,IAAI,MAAM,EAAE,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAChE,IAAI,MAAM,EAAE,OAAO;YAAE,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,MAAM,EAAE,KAAK;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QAEpD,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,WAAW;YACtB,CAAC,CAAC,kBAAkB,KAAK,WAAW,OAAO,oBAAoB,WAAW,EAAE;YAC5E,CAAC,CAAC,kBAAkB,KAAK,WAAW,OAAO,kBAAkB,CAAC;QAEhE,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAoC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CACX,KAAa,EACb,MAAkC,EAClC,OAAwB;QAExB,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,MAAM,EAAE,aAAa;YAAE,KAAK,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;QAC5E,IAAI,MAAM,EAAE,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAChE,IAAI,MAAM,EAAE,OAAO;YAAE,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,MAAM,EAAE,KAAK;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QAEpD,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,WAAW;YACtB,CAAC,CAAC,kBAAkB,KAAK,oBAAoB,WAAW,EAAE;YAC1D,CAAC,CAAC,kBAAkB,KAAK,kBAAkB,CAAC;QAE9C,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAiB,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CACP,KAAa,EACb,WAAmB,EACnB,OAAwB;QAExB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CACpB,kBAAkB,KAAK,oBAAoB,WAAW,EAAE,EACxD,OAAO,CACR,CAAC;IACJ,CAAC;IAED,iDAAiD;IAEjD;;OAEG;IACH,KAAK,CAAC,cAAc,CAClB,KAAa,EACb,OAAgB,EAChB,MAAyD,EACzD,OAAwB;QAExB,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,KAAK,CAAC,GAAG,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;QACxC,IAAI,MAAM,EAAE,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAChE,IAAI,MAAM,EAAE,OAAO;YAAE,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,MAAM,EAAE,KAAK;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QAEpD,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,QAAQ,GAAG,OAAO;YACtB,CAAC,CAAC,kBAAkB,KAAK,WAAW,OAAO,kBAAkB;YAC7D,CAAC,CAAC,kBAAkB,KAAK,kBAAkB,CAAC;QAC9C,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,WAAW,EAAE,CAAC;QAE1C,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAiB,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CACnB,KAAa,EACb,OAAgB,EAChB,MAAyD,EACzD,OAAwB;QAExB,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,KAAK,CAAC,GAAG,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;QACrC,IAAI,MAAM,EAAE,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAChE,IAAI,MAAM,EAAE,OAAO;YAAE,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,MAAM,EAAE,KAAK;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QAEpD,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,QAAQ,GAAG,OAAO;YACtB,CAAC,CAAC,kBAAkB,KAAK,WAAW,OAAO,kBAAkB;YAC7D,CAAC,CAAC,kBAAkB,KAAK,kBAAkB,CAAC;QAC9C,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,WAAW,EAAE,CAAC;QAE1C,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAiB,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,kBAAkB,CACtB,KAAa,EACb,OAAgB,EAChB,MAAyD,EACzD,OAAwB;QAExB,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,KAAK,CAAC,GAAG,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;QACtC,IAAI,MAAM,EAAE,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAChE,IAAI,MAAM,EAAE,OAAO;YAAE,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1D,IAAI,MAAM,EAAE,KAAK;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QAEpD,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,QAAQ,GAAG,OAAO;YACtB,CAAC,CAAC,kBAAkB,KAAK,WAAW,OAAO,kBAAkB;YAC7D,CAAC,CAAC,kBAAkB,KAAK,kBAAkB,CAAC;QAC9C,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,WAAW,EAAE,CAAC;QAE1C,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAiB,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF"}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* FieldsApi
|
|
3
|
+
*
|
|
4
|
+
* Auto-generated SDK wrapper for John Deere fields API.
|
|
5
|
+
* @generated from fields.yaml
|
|
6
|
+
*/
|
|
7
|
+
import type { DeereClient, RequestOptions } from '../client.js';
|
|
8
|
+
export declare class FieldsApi {
|
|
9
|
+
private readonly client;
|
|
10
|
+
constructor(client: DeereClient);
|
|
11
|
+
/**
|
|
12
|
+
* Retrieve all of the Fields for an Organization
|
|
13
|
+
* @generated from GET /organizations/{orgId}/fields
|
|
14
|
+
*/
|
|
15
|
+
list(orgId: string, params?: {
|
|
16
|
+
clientName?: string;
|
|
17
|
+
farmName?: string;
|
|
18
|
+
fieldName?: string;
|
|
19
|
+
embed?: string[];
|
|
20
|
+
recordFilter?: 'AVAILABLE' | 'ARCHIVED' | 'ALL';
|
|
21
|
+
}, options?: RequestOptions): Promise<unknown>;
|
|
22
|
+
/**
|
|
23
|
+
* Get all items (follows pagination automatically)
|
|
24
|
+
* @generated from GET /organizations/{orgId}/fields
|
|
25
|
+
*/
|
|
26
|
+
listAll(orgId: string, params?: {
|
|
27
|
+
clientName?: string;
|
|
28
|
+
farmName?: string;
|
|
29
|
+
fieldName?: string;
|
|
30
|
+
embed?: string[];
|
|
31
|
+
recordFilter?: 'AVAILABLE' | 'ARCHIVED' | 'ALL';
|
|
32
|
+
}, options?: RequestOptions): Promise<unknown[]>;
|
|
33
|
+
/**
|
|
34
|
+
* Create field for an Organization
|
|
35
|
+
* @description This API is used to create a new field resource within the target organization. In order to do this, the authenticated user must have Locations Level 3 permission within the target organization. The client and farm names in the request body may be either new or existing names.
|
|
36
|
+
* @generated from POST /organizations/{orgId}/fields
|
|
37
|
+
*/
|
|
38
|
+
create(orgId: string, data: Record<string, unknown>, options?: RequestOptions): Promise<void>;
|
|
39
|
+
/**
|
|
40
|
+
* Get field by organization and fieldId
|
|
41
|
+
* @generated from GET /organizations/{orgId}/fields/{fieldId}
|
|
42
|
+
*/
|
|
43
|
+
get(orgId: string, fieldId: string, params?: {
|
|
44
|
+
embed?: string[];
|
|
45
|
+
}, options?: RequestOptions): Promise<unknown>;
|
|
46
|
+
/**
|
|
47
|
+
* Update field
|
|
48
|
+
* @description Update the field name, the archived status, or the associated client or farm. If the client and/or farm does not exist, it will be created.
|
|
49
|
+
* @generated from PUT /organizations/{orgId}/fields/{fieldId}
|
|
50
|
+
*/
|
|
51
|
+
update(orgId: string, fieldId: string, data: Record<string, unknown>, options?: RequestOptions): Promise<void>;
|
|
52
|
+
/**
|
|
53
|
+
* Delete Field by organization and fieldId
|
|
54
|
+
* @generated from DELETE /organizations/{orgId}/fields/{fieldId}
|
|
55
|
+
*/
|
|
56
|
+
delete(orgId: string, fieldId: string, options?: RequestOptions): Promise<void>;
|
|
57
|
+
/**
|
|
58
|
+
* Get Farm by organization and fieldId
|
|
59
|
+
* @description This api is designed to get farms within an organization and for provided fieldId
|
|
60
|
+
* @generated from GET /organizations/{orgId}/fields/{fieldId}/farms
|
|
61
|
+
*/
|
|
62
|
+
listFarms(orgId: string, fieldId: string, params?: {
|
|
63
|
+
embed?: string[];
|
|
64
|
+
}, options?: RequestOptions): Promise<unknown>;
|
|
65
|
+
/**
|
|
66
|
+
* View Clients that Own a Field
|
|
67
|
+
* @description View details about the client that owns the field. The response will link to the following resources:<br/> <ul><li><b>fields:</b> View the field the client belongs to.</li> <li><b>farms:</b> View the farms belonging to the client.</li> <li><b>owningOrganization:</b> View the org that owns the field.</li></ul>
|
|
68
|
+
* @generated from GET /organizations/{orgID}/fields/{id}/clients
|
|
69
|
+
*/
|
|
70
|
+
listClients(orgID: string, id: string, options?: RequestOptions): Promise<unknown>;
|
|
71
|
+
}
|
|
72
|
+
export type { components as FieldsTypes } from '../types/generated/fields.js';
|
|
73
|
+
//# sourceMappingURL=fields.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../src/api/fields.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAqB,MAAM,cAAc,CAAC;AAGnF,qBAAa,SAAS;IACR,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,WAAW;IAEhD;;;OAGG;IACG,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,YAAY,CAAC,EAAE,WAAW,GAAG,UAAU,GAAG,KAAK,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAWjN;;;OAGG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,YAAY,CAAC,EAAE,WAAW,GAAG,UAAU,GAAG,KAAK,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAYtN;;;;OAIG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKnG;;;OAGG;IACG,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAQpH;;;;OAIG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKpH;;;OAGG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKrF;;;;OAIG;IACG,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAQ1H;;;;OAIG;IACG,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;CAIzF;AAGD,YAAY,EAAE,UAAU,IAAI,WAAW,EAAE,MAAM,8BAA8B,CAAC"}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* FieldsApi
|
|
3
|
+
*
|
|
4
|
+
* Auto-generated SDK wrapper for John Deere fields API.
|
|
5
|
+
* @generated from fields.yaml
|
|
6
|
+
*/
|
|
7
|
+
export class FieldsApi {
|
|
8
|
+
client;
|
|
9
|
+
constructor(client) {
|
|
10
|
+
this.client = client;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Retrieve all of the Fields for an Organization
|
|
14
|
+
* @generated from GET /organizations/{orgId}/fields
|
|
15
|
+
*/
|
|
16
|
+
async list(orgId, params, options) {
|
|
17
|
+
const query = new URLSearchParams();
|
|
18
|
+
if (params?.clientName !== undefined)
|
|
19
|
+
query.set('clientName', String(params.clientName));
|
|
20
|
+
if (params?.farmName !== undefined)
|
|
21
|
+
query.set('farmName', String(params.farmName));
|
|
22
|
+
if (params?.fieldName !== undefined)
|
|
23
|
+
query.set('fieldName', String(params.fieldName));
|
|
24
|
+
if (params?.embed !== undefined)
|
|
25
|
+
query.set('embed', String(params.embed));
|
|
26
|
+
if (params?.recordFilter !== undefined)
|
|
27
|
+
query.set('recordFilter', String(params.recordFilter));
|
|
28
|
+
const queryString = query.toString();
|
|
29
|
+
const path = `/organizations/${orgId}/fields${queryString ? `?${queryString}` : ''}`;
|
|
30
|
+
return this.client.get(path, options);
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Get all items (follows pagination automatically)
|
|
34
|
+
* @generated from GET /organizations/{orgId}/fields
|
|
35
|
+
*/
|
|
36
|
+
async listAll(orgId, params, options) {
|
|
37
|
+
const query = new URLSearchParams();
|
|
38
|
+
if (params?.clientName !== undefined)
|
|
39
|
+
query.set('clientName', String(params.clientName));
|
|
40
|
+
if (params?.farmName !== undefined)
|
|
41
|
+
query.set('farmName', String(params.farmName));
|
|
42
|
+
if (params?.fieldName !== undefined)
|
|
43
|
+
query.set('fieldName', String(params.fieldName));
|
|
44
|
+
if (params?.embed !== undefined)
|
|
45
|
+
query.set('embed', String(params.embed));
|
|
46
|
+
if (params?.recordFilter !== undefined)
|
|
47
|
+
query.set('recordFilter', String(params.recordFilter));
|
|
48
|
+
const queryString = query.toString();
|
|
49
|
+
const path = `/organizations/${orgId}/fields${queryString ? `?${queryString}` : ''}`;
|
|
50
|
+
return this.client.getAll(path, options);
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Create field for an Organization
|
|
54
|
+
* @description This API is used to create a new field resource within the target organization. In order to do this, the authenticated user must have Locations Level 3 permission within the target organization. The client and farm names in the request body may be either new or existing names.
|
|
55
|
+
* @generated from POST /organizations/{orgId}/fields
|
|
56
|
+
*/
|
|
57
|
+
async create(orgId, data, options) {
|
|
58
|
+
const path = `/organizations/${orgId}/fields`;
|
|
59
|
+
await this.client.post(path, data, options);
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Get field by organization and fieldId
|
|
63
|
+
* @generated from GET /organizations/{orgId}/fields/{fieldId}
|
|
64
|
+
*/
|
|
65
|
+
async get(orgId, fieldId, params, options) {
|
|
66
|
+
const query = new URLSearchParams();
|
|
67
|
+
if (params?.embed !== undefined)
|
|
68
|
+
query.set('embed', String(params.embed));
|
|
69
|
+
const queryString = query.toString();
|
|
70
|
+
const path = `/organizations/${orgId}/fields/${fieldId}${queryString ? `?${queryString}` : ''}`;
|
|
71
|
+
return this.client.get(path, options);
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Update field
|
|
75
|
+
* @description Update the field name, the archived status, or the associated client or farm. If the client and/or farm does not exist, it will be created.
|
|
76
|
+
* @generated from PUT /organizations/{orgId}/fields/{fieldId}
|
|
77
|
+
*/
|
|
78
|
+
async update(orgId, fieldId, data, options) {
|
|
79
|
+
const path = `/organizations/${orgId}/fields/${fieldId}`;
|
|
80
|
+
await this.client.put(path, data, options);
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Delete Field by organization and fieldId
|
|
84
|
+
* @generated from DELETE /organizations/{orgId}/fields/{fieldId}
|
|
85
|
+
*/
|
|
86
|
+
async delete(orgId, fieldId, options) {
|
|
87
|
+
const path = `/organizations/${orgId}/fields/${fieldId}`;
|
|
88
|
+
await this.client.delete(path, options);
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Get Farm by organization and fieldId
|
|
92
|
+
* @description This api is designed to get farms within an organization and for provided fieldId
|
|
93
|
+
* @generated from GET /organizations/{orgId}/fields/{fieldId}/farms
|
|
94
|
+
*/
|
|
95
|
+
async listFarms(orgId, fieldId, params, options) {
|
|
96
|
+
const query = new URLSearchParams();
|
|
97
|
+
if (params?.embed !== undefined)
|
|
98
|
+
query.set('embed', String(params.embed));
|
|
99
|
+
const queryString = query.toString();
|
|
100
|
+
const path = `/organizations/${orgId}/fields/${fieldId}/farms${queryString ? `?${queryString}` : ''}`;
|
|
101
|
+
return this.client.get(path, options);
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* View Clients that Own a Field
|
|
105
|
+
* @description View details about the client that owns the field. The response will link to the following resources:<br/> <ul><li><b>fields:</b> View the field the client belongs to.</li> <li><b>farms:</b> View the farms belonging to the client.</li> <li><b>owningOrganization:</b> View the org that owns the field.</li></ul>
|
|
106
|
+
* @generated from GET /organizations/{orgID}/fields/{id}/clients
|
|
107
|
+
*/
|
|
108
|
+
async listClients(orgID, id, options) {
|
|
109
|
+
const path = `/organizations/${orgID}/fields/${id}/clients`;
|
|
110
|
+
return this.client.get(path, options);
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
//# sourceMappingURL=fields.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../src/api/fields.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,MAAM,OAAO,SAAS;IACS;IAA7B,YAA6B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAEpD;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAC,KAAa,EAAE,MAA0I,EAAE,OAAwB;QAC5L,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,MAAM,EAAE,UAAU,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACzF,IAAI,MAAM,EAAE,QAAQ,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnF,IAAI,MAAM,EAAE,SAAS,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QACtF,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,IAAI,MAAM,EAAE,YAAY,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;QAC/F,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,kBAAkB,KAAK,UAAU,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACrF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAU,IAAI,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,KAAa,EAAE,MAA0I,EAAE,OAAwB;QAC/L,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,MAAM,EAAE,UAAU,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACzF,IAAI,MAAM,EAAE,QAAQ,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnF,IAAI,MAAM,EAAE,SAAS,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QACtF,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,IAAI,MAAM,EAAE,YAAY,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;QAC/F,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,kBAAkB,KAAK,UAAU,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACrF,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAU,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,IAA6B,EAAE,OAAwB;QACjF,MAAM,IAAI,GAAG,kBAAkB,KAAK,SAAS,CAAC;QAC9C,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,GAAG,CAAC,KAAa,EAAE,OAAe,EAAE,MAA6B,EAAE,OAAwB;QAC/F,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,kBAAkB,KAAK,WAAW,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAChG,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAU,IAAI,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,OAAe,EAAE,IAA6B,EAAE,OAAwB;QAClG,MAAM,IAAI,GAAG,kBAAkB,KAAK,WAAW,OAAO,EAAE,CAAC;QACzD,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,KAAa,EAAE,OAAe,EAAE,OAAwB;QACnE,MAAM,IAAI,GAAG,kBAAkB,KAAK,WAAW,OAAO,EAAE,CAAC;QACzD,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS,CAAC,KAAa,EAAE,OAAe,EAAE,MAA6B,EAAE,OAAwB;QACrG,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,IAAI,MAAM,EAAE,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1E,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,kBAAkB,KAAK,WAAW,OAAO,SAAS,WAAW,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACtG,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAU,IAAI,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,KAAa,EAAE,EAAU,EAAE,OAAwB;QACnE,MAAM,IAAI,GAAG,kBAAkB,KAAK,WAAW,EAAE,UAAU,CAAC;QAC5D,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAU,IAAI,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;CACF"}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* FilesApi
|
|
3
|
+
*
|
|
4
|
+
* Auto-generated SDK wrapper for John Deere files API.
|
|
5
|
+
* @generated from files.yaml
|
|
6
|
+
*/
|
|
7
|
+
import type { DeereClient, RequestOptions } from '../client.js';
|
|
8
|
+
export declare class FilesApi {
|
|
9
|
+
private readonly client;
|
|
10
|
+
constructor(client: DeereClient);
|
|
11
|
+
/**
|
|
12
|
+
* List Files
|
|
13
|
+
* @description This resource retrieves the list of available files. For each file, the response will link to the following resources: <ul> <li><strong>owningOrganization</strong>: View the org that owns the file.</li> <li><strong>partnerships</strong>: View the partners this file is shared with.</li> </ul>
|
|
14
|
+
* @generated from GET /files
|
|
15
|
+
*/
|
|
16
|
+
list(params?: {
|
|
17
|
+
filter: string;
|
|
18
|
+
fileType1: number;
|
|
19
|
+
transferable: boolean;
|
|
20
|
+
}, options?: RequestOptions): Promise<unknown>;
|
|
21
|
+
/**
|
|
22
|
+
* Get all items (follows pagination automatically)
|
|
23
|
+
* @generated from GET /files
|
|
24
|
+
*/
|
|
25
|
+
listAll(params?: {
|
|
26
|
+
filter: string;
|
|
27
|
+
fileType1: number;
|
|
28
|
+
transferable: boolean;
|
|
29
|
+
}, options?: RequestOptions): Promise<unknown[]>;
|
|
30
|
+
/**
|
|
31
|
+
* View/Download A File
|
|
32
|
+
* @description This resource allows the client to view or download a file. <p><strong>Note</strong>: Only files smaller than 50 MB can be downloaded at once. Larger files will need to be downloaded in chunks. To download in chunks, you can use the <strong>Range</strong> request header, or the <strong>offset</strong> and <strong>size</strong> request parameters. If both are used, the request header will take precedence.</p>
|
|
33
|
+
* @generated from GET /files/{fileId}
|
|
34
|
+
*/
|
|
35
|
+
get(fileId: string, options?: RequestOptions): Promise<unknown>;
|
|
36
|
+
/**
|
|
37
|
+
* Upload/Update A File
|
|
38
|
+
* @description This resource allows the client to upload or update a file. The client must <a href="/dev-docs/files#/organizations/{orgId}/files/post" target="_blank">create a file ID</a> before uploading a file.
|
|
39
|
+
* @generated from PUT /files/{fileId}
|
|
40
|
+
*/
|
|
41
|
+
update(fileId: string, data: Record<string, unknown>, options?: RequestOptions): Promise<void>;
|
|
42
|
+
/**
|
|
43
|
+
* List an Org's Files
|
|
44
|
+
* @description View a list of an org's files. This resource allows for pagination. For each returned file, the response will link to the following resources: <p> <ul> <li><strong>owningOrganization</strong>: View the org that owns the file.</li> <li><strong>partnerships</strong>: View the partnerships through which the file is shared, if applicable.</li> <li><strong>initiateFileTransfer</strong>: Submit a transfer request for the specified file.</li> <li><strong>machinesEligibleToReceiveFile</strong>: List of WDT-capable machines that the specified file can be sent to.</li> <li><strong>sendFileToMachine</strong>: The same as "initiateFileTransfer."</li> <li><strong>wdtCapableMachines</strong>: The same as "machinesEligibleToReceiveFile."</li> </ul> </p>
|
|
45
|
+
* @generated from GET /organizations/{orgId}/files
|
|
46
|
+
*/
|
|
47
|
+
listFiles(orgId: string, params?: {
|
|
48
|
+
filter?: string;
|
|
49
|
+
startDate?: string;
|
|
50
|
+
endDate?: unknown;
|
|
51
|
+
fileType1?: number;
|
|
52
|
+
archived?: boolean;
|
|
53
|
+
status?: string;
|
|
54
|
+
}, options?: RequestOptions): Promise<unknown>;
|
|
55
|
+
/**
|
|
56
|
+
* Create A File ID
|
|
57
|
+
* @description The POST call below shows the creation of file id "55" in organization "73" in Operation Center. The response "location" header will return the new file ID in the link returned. The client software will then use the new file ID, to <a href="/dev-docs/files#/files/{fileId}/put" target="_blank">upload the file.</a>
|
|
58
|
+
* @generated from POST /organizations/{orgId}/files
|
|
59
|
+
*/
|
|
60
|
+
create(orgId: string, data: Record<string, unknown>, options?: RequestOptions): Promise<void>;
|
|
61
|
+
}
|
|
62
|
+
export type { components as FilesTypes } from '../types/generated/files.js';
|
|
63
|
+
//# sourceMappingURL=files.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../src/api/files.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAqB,MAAM,cAAc,CAAC;AAGnF,qBAAa,QAAQ;IACP,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,WAAW;IAEhD;;;;OAIG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,OAAO,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAS7H;;;OAGG;IACG,OAAO,CAAC,MAAM,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,OAAO,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAUlI;;;;OAIG;IACG,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAKrE;;;;OAIG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKpG;;;;OAIG;IACG,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAaxM;;;;OAIG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAIpG;AAGD,YAAY,EAAE,UAAU,IAAI,UAAU,EAAE,MAAM,6BAA6B,CAAC"}
|