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

package/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Release History
+
+## 1.0.0-beta.4 (Unreleased)
+
+### Features Added
+
+### Breaking Changes
+
+### Bugs Fixed
+
+### Other Changes
+
+## 1.0.0-beta.3 (2025-02-10)
+
+### Features Added
+- Refresh @azure-rest/agrifood-farming SDK
+
+## 1.0.0-beta.2 (2023-02-24)
+
+### Features Added
+
+- Adding clients for Sensor Integration which includes crud operations on DeviceDataModels, Devices, SensorDataModels, Sensors, SensorMappings, SensorPartnerIntegration and get Sensor events.
+- Adding new APIs for STAC search and get feature
+- Adding breedingMethods and Measurements as part of Crop Entity
+- Adding geographicIdentifier as part of Season Entity
+- Adding trait, relativeMeasurements and treatments as part of CropVariety Entity
+- Adding type, crs, centroid and bbox(bounding box of the geometry) as part of Boundary Entity
+- Adding Source field in Party, Farm, Field, Seasonal Field, Boundary, Crop, Crop variety, Season and Attachment
+- CreatedBy and ModifiedBy in all entities
+- Measure renamed to measurements in Prescription & Crop
+- Acreage renamed to area in Boundary
+- Get Feature and Search Feature APIs for Sentinel 2 L2A and Sentinel 2 L1C STAC collections
+- Adding Weather Data APIs to fetch IBM weather data
+- Re-generate with latest generator version. This contains splitting models into input and output models and typing improvements [#20059](https://github.com/Azure/azure-sdk-for-js/pull/20059)
+- Export pagination helper function. [#15831](https://github.com/Azure/azure-sdk-for-js/pull/15831)
+
+### Breaking Changes
+
+- Removing primaryBoundaryId & boundaryIds from Field and Seasonal Field
+- Removing isPrimary flag from Boundary
+- Removing avgYields from Seasonal Field
+- Renaming Farmer to Party
+- Renaming CropVariety to CropProduct
+
+## 1.0.0-beta.1 (2021-05-26)
+
+- First release of package, see README.md for details.

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Microsoft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -21,7 +21,7 @@ Key links:
 
 ### Currently supported environments
 
-- Node.js version 14.x.x or higher
+- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
 
 ### Prerequisites
 
@@ -53,13 +53,13 @@ AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
 
 Use the returned token credential to authenticate the client:
 
-```typescript
+```ts snippet:CreateFarmBeatsClient
 import FarmBeats from "@azure-rest/agrifood-farming";
 import { DefaultAzureCredential } from "@azure/identity";
 
 const client = FarmBeats(
   "https://<farmbeats resource name>.farmbeats.azure.net",
-  new DefaultAzureCredential()
+  new DefaultAzureCredential(),
 );
 ```
 
@@ -95,17 +95,17 @@ Fam operations includes details pertaining to tilling, planting, application of
 Once you have authenticated and created the client object as shown in the [Authenticate the client](#create-and-authenticate-a-farmbeats-rest-client)
 section, you can create a party within the Data Manager for Agriculture resource like this:
 
-```typescript
+```ts snippet:CreateParty
 import FarmBeats, { isUnexpected } from "@azure-rest/agrifood-farming";
 import { DefaultAzureCredential } from "@azure/identity";
 
 const client = FarmBeats(
   "https://<farmbeats resource name>.farmbeats.azure.net",
-  new DefaultAzureCredential()
+  new DefaultAzureCredential(),
 );
 
 const partyId = "test_party";
-const result = await farmbeatsClient.path("/parties/{partyId}", partyId).patch({
+const result = await client.path("/parties/{partyId}", partyId).patch({
   body: {
     name: "Contoso Party",
     description: "Your custom party description here",
@@ -126,22 +126,22 @@ console.log(`Created Party: ${party.name}`);
 
 ### List Parties
 
-```typescript
-import FarmBeats, { isUnexpected } from "@azure-rest/agrifood-farming";
+```ts snippet:ListParties
+import FarmBeats, { isUnexpected, paginate } from "@azure-rest/agrifood-farming";
 import { DefaultAzureCredential } from "@azure/identity";
 
 const client = FarmBeats(
   "https://<farmbeats resource name>.farmbeats.azure.net",
-  new DefaultAzureCredential()
+  new DefaultAzureCredential(),
 );
 
-const response = await farmbeatsClient.path("/parties").get();
+const response = await client.path("/parties").get();
 
 if (isUnexpected(response)) {
   throw response.body.error;
 }
 
-const parties = paginate(farmbeatsClient, response);
+const parties = paginate(client, response);
 
 // Log each party id
 for await (const party of parties) {
@@ -160,7 +160,7 @@ For additional samples, please refer to the [samples folder][samples_folder]
 
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
-```javascript
+```ts snippet:SetLogLevel
 import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");
@@ -172,7 +172,7 @@ For more detailed instructions on how to enable logs, you can look at the [@azur
 
 ### Additional documentation
 
-For more extensive documentation on the FarmBeats, see the [FarmBeats documentation][product_docs] on docs.microsoft.com.
+For more extensive documentation on the FarmBeats, see the [FarmBeats documentation][product_docs] on learn.microsoft.com.
 
 ## Contributing
 
@@ -182,16 +182,14 @@ If you'd like to contribute to this library, please read the [contributing guide
 
 - [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
 
-![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fagrifood%2Fagrifood-farming-rest%2FREADME.png)
-
-[product_documentation]: https://docs.microsoft.com/azure/industry/agriculture/overview-azure-farmbeats
+[product_documentation]: https://learn.microsoft.com/azure/industry/agriculture/overview-azure-farmbeats
 [rest_client]: https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md
 [source_code]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/agrifood/agrifood-farming-rest
 [npm]: https://www.npmjs.com/org/azure-rest
 [ref_docs]: https://azure.github.io/azure-sdk-for-js
 [azure_subscription]: https://azure.microsoft.com/free/
-[farmbeats_resource]: https://docs.microsoft.com/azure/industry/agriculture/install-azure-farmbeats
-[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
+[farmbeats_resource]: https://learn.microsoft.com/azure/industry/agriculture/install-azure-farmbeats
+[authenticate_with_token]: https://learn.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
 [azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials
 [azure_identity_npm]: https://www.npmjs.com/package/@azure/identity
 [default_azure_credential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential