@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
package/README.md CHANGED
@@ -21,7 +21,7 @@ Key links:
21
21
 
22
22
  ### Currently supported environments
23
23
 
24
- - Node.js version 14.x.x or higher
24
+ - [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
25
25
 
26
26
  ### Prerequisites
27
27
 
@@ -53,13 +53,13 @@ AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
53
53
 
54
54
  Use the returned token credential to authenticate the client:
55
55
 
56
- ```typescript
56
+ ```ts snippet:CreateFarmBeatsClient
57
57
  import FarmBeats from "@azure-rest/agrifood-farming";
58
58
  import { DefaultAzureCredential } from "@azure/identity";
59
59
 
60
60
  const client = FarmBeats(
61
61
  "https://<farmbeats resource name>.farmbeats.azure.net",
62
- new DefaultAzureCredential()
62
+ new DefaultAzureCredential(),
63
63
  );
64
64
  ```
65
65
 
@@ -95,17 +95,17 @@ Fam operations includes details pertaining to tilling, planting, application of
95
95
  Once you have authenticated and created the client object as shown in the [Authenticate the client](#create-and-authenticate-a-farmbeats-rest-client)
96
96
  section, you can create a party within the Data Manager for Agriculture resource like this:
97
97
 
98
- ```typescript
98
+ ```ts snippet:CreateParty
99
99
  import FarmBeats, { isUnexpected } from "@azure-rest/agrifood-farming";
100
100
  import { DefaultAzureCredential } from "@azure/identity";
101
101
 
102
102
  const client = FarmBeats(
103
103
  "https://<farmbeats resource name>.farmbeats.azure.net",
104
- new DefaultAzureCredential()
104
+ new DefaultAzureCredential(),
105
105
  );
106
106
 
107
107
  const partyId = "test_party";
108
- const result = await farmbeatsClient.path("/parties/{partyId}", partyId).patch({
108
+ const result = await client.path("/parties/{partyId}", partyId).patch({
109
109
  body: {
110
110
  name: "Contoso Party",
111
111
  description: "Your custom party description here",
@@ -126,22 +126,22 @@ console.log(`Created Party: ${party.name}`);
126
126
 
127
127
  ### List Parties
128
128
 
129
- ```typescript
130
- import FarmBeats, { isUnexpected } from "@azure-rest/agrifood-farming";
129
+ ```ts snippet:ListParties
130
+ import FarmBeats, { isUnexpected, paginate } from "@azure-rest/agrifood-farming";
131
131
  import { DefaultAzureCredential } from "@azure/identity";
132
132
 
133
133
  const client = FarmBeats(
134
134
  "https://<farmbeats resource name>.farmbeats.azure.net",
135
- new DefaultAzureCredential()
135
+ new DefaultAzureCredential(),
136
136
  );
137
137
 
138
- const response = await farmbeatsClient.path("/parties").get();
138
+ const response = await client.path("/parties").get();
139
139
 
140
140
  if (isUnexpected(response)) {
141
141
  throw response.body.error;
142
142
  }
143
143
 
144
- const parties = paginate(farmbeatsClient, response);
144
+ const parties = paginate(client, response);
145
145
 
146
146
  // Log each party id
147
147
  for await (const party of parties) {
@@ -160,7 +160,7 @@ For additional samples, please refer to the [samples folder][samples_folder]
160
160
 
161
161
  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`:
162
162
 
163
- ```javascript
163
+ ```ts snippet:SetLogLevel
164
164
  import { setLogLevel } from "@azure/logger";
165
165
 
166
166
  setLogLevel("info");
@@ -172,7 +172,7 @@ For more detailed instructions on how to enable logs, you can look at the [@azur
172
172
 
173
173
  ### Additional documentation
174
174
 
175
- For more extensive documentation on the FarmBeats, see the [FarmBeats documentation][product_docs] on docs.microsoft.com.
175
+ For more extensive documentation on the FarmBeats, see the [FarmBeats documentation][product_docs] on learn.microsoft.com.
176
176
 
177
177
  ## Contributing
178
178
 
@@ -182,16 +182,14 @@ If you'd like to contribute to this library, please read the [contributing guide
182
182
 
183
183
  - [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
184
184
 
185
- ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fagrifood%2Fagrifood-farming-rest%2FREADME.png)
186
-
187
- [product_documentation]: https://docs.microsoft.com/azure/industry/agriculture/overview-azure-farmbeats
185
+ [product_documentation]: https://learn.microsoft.com/azure/industry/agriculture/overview-azure-farmbeats
188
186
  [rest_client]: https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md
189
187
  [source_code]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/agrifood/agrifood-farming-rest
190
188
  [npm]: https://www.npmjs.com/org/azure-rest
191
189
  [ref_docs]: https://azure.github.io/azure-sdk-for-js
192
190
  [azure_subscription]: https://azure.microsoft.com/free/
193
- [farmbeats_resource]: https://docs.microsoft.com/azure/industry/agriculture/install-azure-farmbeats
194
- [authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
191
+ [farmbeats_resource]: https://learn.microsoft.com/azure/industry/agriculture/install-azure-farmbeats
192
+ [authenticate_with_token]: https://learn.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
195
193
  [azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials
196
194
  [azure_identity_npm]: https://www.npmjs.com/package/@azure/identity
197
195
  [default_azure_credential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential