diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index 70071d718ddc..4bab8bec3a24 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -118,8 +118,6 @@ specifiers: '@rush-temp/core-auth': file:./projects/core-auth.tgz '@rush-temp/core-client': file:./projects/core-client.tgz '@rush-temp/core-client-1': file:./projects/core-client-1.tgz - '@rush-temp/core-client-lro': file:./projects/core-client-lro.tgz - '@rush-temp/core-client-paging': file:./projects/core-client-paging.tgz '@rush-temp/core-crypto': file:./projects/core-crypto.tgz '@rush-temp/core-http': file:./projects/core-http.tgz '@rush-temp/core-lro': file:./projects/core-lro.tgz @@ -174,7 +172,6 @@ specifiers: '@rush-temp/perf-storage-file-datalake': file:./projects/perf-storage-file-datalake.tgz '@rush-temp/perf-storage-file-share': file:./projects/perf-storage-file-share.tgz '@rush-temp/perf-template': file:./projects/perf-template.tgz - '@rush-temp/purview-account': file:./projects/purview-account.tgz '@rush-temp/purview-administration': file:./projects/purview-administration.tgz '@rush-temp/purview-catalog': file:./projects/purview-catalog.tgz '@rush-temp/purview-scanning': file:./projects/purview-scanning.tgz @@ -323,8 +320,6 @@ dependencies: '@rush-temp/core-auth': file:projects/core-auth.tgz '@rush-temp/core-client': file:projects/core-client.tgz '@rush-temp/core-client-1': file:projects/core-client-1.tgz - '@rush-temp/core-client-lro': file:projects/core-client-lro.tgz - '@rush-temp/core-client-paging': file:projects/core-client-paging.tgz '@rush-temp/core-crypto': file:projects/core-crypto.tgz '@rush-temp/core-http': file:projects/core-http.tgz '@rush-temp/core-lro': file:projects/core-lro.tgz @@ -379,7 +374,6 @@ dependencies: '@rush-temp/perf-storage-file-datalake': file:projects/perf-storage-file-datalake.tgz '@rush-temp/perf-storage-file-share': file:projects/perf-storage-file-share.tgz '@rush-temp/perf-template': file:projects/perf-template.tgz - '@rush-temp/purview-account': file:projects/purview-account.tgz '@rush-temp/purview-administration': file:projects/purview-administration.tgz '@rush-temp/purview-catalog': file:projects/purview-catalog.tgz '@rush-temp/purview-scanning': file:projects/purview-scanning.tgz @@ -853,7 +847,7 @@ packages: resolution: {integrity: sha512-Q71Buur3RMcg6lCnisLL8Im562DBw+ybzgm+YQj/FbAaI8ZNu/zl/5z1fE4k3Q9LSIzYrz6HLRzlhdSBXpydlQ==} engines: {node: '>=8.0.0'} dependencies: - '@azure/core-http': 1.2.3 + '@azure/core-http': 1.2.6 '@azure/core-tracing': 1.0.0-preview.9 '@azure/logger': 1.0.3 '@azure/msal-node': 1.0.0-beta.6_debug@4.3.3 @@ -1562,7 +1556,6 @@ packages: /@opentelemetry/node/0.22.0_@opentelemetry+api@1.0.4: resolution: {integrity: sha512-+HhGbDruQ7cwejVOIYyxRa28uosnG8W95NiQZ6qE8PXXPsDSyGeftAPbtYpGit0H2f5hrVcMlwmWHeAo9xkSLA==} engines: {node: '>=8.0.0'} - deprecated: Package renamed to @opentelemetry/sdk-trace-node peerDependencies: '@opentelemetry/api': ^1.0.0 dependencies: @@ -1919,7 +1912,7 @@ packages: /@types/fs-extra/9.0.13: resolution: {integrity: sha512-nEnwB++1u5lVDM2UI4c1+5R+FYaKfaAzS4OococimjVm3nQw3TuzH5UNsocrcTBbhnerblyHj4A49qXbIiZdpA==} dependencies: - '@types/node': 17.0.1 + '@types/node': 12.20.42 dev: false /@types/glob/7.2.0: @@ -3124,7 +3117,7 @@ packages: resolution: {integrity: sha512-mel+jf7nrtEl5Pn1Qx46zARXKDpBbvzezse7p7LqINmdoIk8PYP5SySaxEmYv6TZ0JyEKA1hsCId6DIhgITtWQ==} deprecated: Debug versions >=3.2.0 <3.2.7 || >=4 <4.3.1 have a low-severity ReDos regression when used in a Node.js environment. It is recommended you upgrade to 3.2.7 or 4.3.1. (https://github.com/visionmedia/debug/issues/797) dependencies: - ms: 2.1.1 + ms: 2.1.3 dev: false /debug/3.2.7: @@ -3346,7 +3339,7 @@ packages: dependencies: semver: 7.3.5 shelljs: 0.8.5 - typescript: 4.2.4 + typescript: 4.5.4 dev: false /ecdsa-sig-formatter/1.0.11: @@ -4095,7 +4088,7 @@ packages: resolution: {integrity: sha512-C5owb14u9eJwizKGdchcDUQeFtlSHHthBk8pbX9Vc1PFZrLombudjDnNns88aYslCyF6IY5SUw3Roz6xShcEIQ==} engines: {node: '>=12'} dependencies: - graceful-fs: 4.2.8 + graceful-fs: 4.2.9 jsonfile: 6.1.0 universalify: 2.0.0 dev: false @@ -5040,7 +5033,7 @@ packages: dependencies: universalify: 2.0.0 optionalDependencies: - graceful-fs: 4.2.8 + graceful-fs: 4.2.9 dev: false /jsonwebtoken/8.5.1: @@ -7942,7 +7935,7 @@ packages: /wide-align/1.1.5: resolution: {integrity: sha512-eDMORYaPNZ4sQIuuYPDHdQvf4gyCF9rEEV/yPxGfwPkRodwEgiMUUXTx/dex+Me0wxx53S+NgUHaP7y3MGlDmg==} dependencies: - string-width: 1.0.2 + string-width: 4.2.3 dev: false /word-wrap/1.2.3: @@ -8239,7 +8232,7 @@ packages: dev: false file:projects/agrifood-farming.tgz: - resolution: {integrity: sha512-tIbV71Sekmb01b/mAU9iH2ZNEe2nbzNTiGPFmlNRnGLOAEXkxRYdLDbSR26JEGicN3V76kUlOxbLl3wkCLHY+Q==, tarball: file:projects/agrifood-farming.tgz} + resolution: {integrity: sha512-saAvK6YHHP9F+QkkLbJ5ne7O7Ofz0gszl3PAhJA8+amdY7FEZJUg/G17cdirfQBSRQe4S43PojN3aGCUEFHJeQ==, tarball: file:projects/agrifood-farming.tgz} name: '@rush-temp/agrifood-farming' version: 0.0.0 dependencies: @@ -10013,7 +10006,7 @@ packages: version: 0.0.0 dependencies: '@azure-tools/test-recorder': 1.0.2 - '@microsoft/api-extractor': 7.19.2 + '@microsoft/api-extractor': 7.19.4 '@rollup/plugin-commonjs': 11.0.2_rollup@1.32.1 '@rollup/plugin-json': 4.1.0_rollup@1.32.1 '@rollup/plugin-multi-entry': 3.0.1_rollup@1.32.1 @@ -10028,6 +10021,7 @@ packages: typescript: 4.2.4 uglify-js: 3.14.5 transitivePeerDependencies: + - encoding - supports-color dev: false @@ -10037,7 +10031,7 @@ packages: version: 0.0.0 dependencies: '@azure-tools/test-recorder': 1.0.2 - '@microsoft/api-extractor': 7.19.2 + '@microsoft/api-extractor': 7.19.4 '@rollup/plugin-commonjs': 11.0.2_rollup@1.32.1 '@rollup/plugin-json': 4.1.0_rollup@1.32.1 '@rollup/plugin-multi-entry': 3.0.1_rollup@1.32.1 @@ -10052,6 +10046,7 @@ packages: typescript: 4.2.4 uglify-js: 3.14.5 transitivePeerDependencies: + - encoding - supports-color dev: false @@ -11629,88 +11624,6 @@ packages: - utf-8-validate dev: false - file:projects/core-client-lro.tgz: - resolution: {integrity: sha512-uuzKjbvA+d3YYjaMpHoBSzGNVmD7ijLLid2k1EDfPMIdC/u4twFoPO9jtvO/b+rIhVm54H9wuOzlHDjfT3vXJA==, tarball: file:projects/core-client-lro.tgz} - name: '@rush-temp/core-client-lro' - version: 0.0.0 - dependencies: - '@azure-rest/core-client': 1.0.0-beta.7 - '@microsoft/api-extractor': 7.19.4 - '@types/chai': 4.3.0 - '@types/mocha': 7.0.2 - '@types/node': 12.20.42 - chai: 4.3.4 - cross-env: 7.0.3 - eslint: 7.32.0 - inherits: 2.0.4 - karma: 6.3.11 - karma-chrome-launcher: 3.1.0 - karma-coverage: 2.1.0 - karma-edge-launcher: 0.4.2_karma@6.3.11 - karma-env-preprocessor: 0.1.1 - karma-firefox-launcher: 1.3.0 - karma-ie-launcher: 1.0.0_karma@6.3.11 - karma-junit-reporter: 2.0.1_karma@6.3.11 - karma-mocha: 2.0.1 - karma-mocha-reporter: 2.2.5_karma@6.3.11 - karma-sourcemap-loader: 0.3.8 - mocha: 7.2.0 - mocha-junit-reporter: 2.0.2_mocha@7.2.0 - prettier: 2.5.1 - rimraf: 3.0.2 - rollup: 1.32.1 - sinon: 9.2.4 - tslib: 2.3.1 - typescript: 4.2.4 - util: 0.12.4 - transitivePeerDependencies: - - bufferutil - - debug - - supports-color - - utf-8-validate - dev: false - - file:projects/core-client-paging.tgz: - resolution: {integrity: sha512-w4rFFKYeYTOzy0brScMDf2zgA4wTohOD7f25owSDSw/mLAHH3EzFdFovSVSiDtjC1tetMPZvT053jNMTW9mr4Q==, tarball: file:projects/core-client-paging.tgz} - name: '@rush-temp/core-client-paging' - version: 0.0.0 - dependencies: - '@azure-rest/core-client': 1.0.0-beta.7 - '@microsoft/api-extractor': 7.19.4 - '@types/chai': 4.3.0 - '@types/mocha': 7.0.2 - '@types/node': 12.20.42 - chai: 4.3.4 - cross-env: 7.0.3 - eslint: 7.32.0 - inherits: 2.0.4 - karma: 6.3.11 - karma-chrome-launcher: 3.1.0 - karma-coverage: 2.1.0 - karma-edge-launcher: 0.4.2_karma@6.3.11 - karma-env-preprocessor: 0.1.1 - karma-firefox-launcher: 1.3.0 - karma-ie-launcher: 1.0.0_karma@6.3.11 - karma-junit-reporter: 2.0.1_karma@6.3.11 - karma-mocha: 2.0.1 - karma-mocha-reporter: 2.2.5_karma@6.3.11 - karma-sourcemap-loader: 0.3.8 - mocha: 7.2.0 - mocha-junit-reporter: 2.0.2_mocha@7.2.0 - prettier: 2.5.1 - rimraf: 3.0.2 - rollup: 1.32.1 - sinon: 9.2.4 - tslib: 2.3.1 - typescript: 4.2.4 - util: 0.12.4 - transitivePeerDependencies: - - bufferutil - - debug - - supports-color - - utf-8-validate - dev: false - file:projects/core-client.tgz: resolution: {integrity: sha512-HRu+sUu7H7/XqCEvdxtxRkT6EvZ1OL2EDch1hbOZLYe9ta6DR8Cykxc/o+Zpr6k33MdXe2V7cZo137mbGDonMA==, tarball: file:projects/core-client.tgz} name: '@rush-temp/core-client' @@ -13768,54 +13681,6 @@ packages: - supports-color dev: false - file:projects/purview-account.tgz: - resolution: {integrity: sha512-leMQ9qnzNBLZmtEkf+cdL5rZ7p+wE9Oj4GBzWEhiCUSe7kxS7Q5qrFjLo/ajrHNz9PQsx/uelkvbDKmjb8Qbaw==, tarball: file:projects/purview-account.tgz} - name: '@rush-temp/purview-account' - version: 0.0.0 - dependencies: - '@azure-rest/core-client': 1.0.0-beta.7 - '@azure-rest/core-client-paging': 1.0.0-beta.1 - '@azure-tools/test-recorder': 1.0.2 - '@microsoft/api-extractor': 7.19.4 - '@types/chai': 4.3.0 - '@types/mocha': 7.0.2 - '@types/node': 12.20.42 - chai: 4.3.4 - cross-env: 7.0.3 - dotenv: 8.6.0 - eslint: 7.32.0 - karma: 6.3.11 - karma-chrome-launcher: 3.1.0 - karma-coverage: 2.1.0 - karma-edge-launcher: 0.4.2_karma@6.3.11 - karma-env-preprocessor: 0.1.1 - karma-firefox-launcher: 1.3.0 - karma-ie-launcher: 1.0.0_karma@6.3.11 - karma-json-preprocessor: 0.3.3_karma@6.3.11 - karma-json-to-file-reporter: 1.0.1 - karma-junit-reporter: 2.0.1_karma@6.3.11 - karma-mocha: 2.0.1 - karma-mocha-reporter: 2.2.5_karma@6.3.11 - karma-source-map-support: 1.4.0 - karma-sourcemap-loader: 0.3.8 - mkdirp: 1.0.4 - mocha: 7.2.0 - mocha-junit-reporter: 2.0.2_mocha@7.2.0 - nyc: 15.1.0 - prettier: 2.5.1 - rimraf: 3.0.2 - rollup: 1.32.1 - source-map-support: 0.5.21 - tslib: 2.3.1 - typescript: 4.2.4 - transitivePeerDependencies: - - bufferutil - - debug - - encoding - - supports-color - - utf-8-validate - dev: false - file:projects/purview-administration.tgz: resolution: {integrity: sha512-+f2xAQp9pW5Iq912G3NdWDzEh23gD1nNxL4cv1JBEJbRcuELdwlkkgedV7ywjM6fkFz385l9GfTg2M8lJabKyQ==, tarball: file:projects/purview-administration.tgz} name: '@rush-temp/purview-administration' diff --git a/dataplane.code-workspace b/dataplane.code-workspace index aa16b6a8be9f..24c2b5de2e06 100644 --- a/dataplane.code-workspace +++ b/dataplane.code-workspace @@ -60,10 +60,6 @@ "name": "core-client-rest", "path": "sdk/core/core-client-rest" }, - { - "name": "core-client-lro-rest", - "path": "sdk/core/core-client-lro-rest" - }, { "name": "ai-document-translator", "path": "sdk/documenttranslator/ai-document-translator-rest" diff --git a/eng/tools/rush-runner.js b/eng/tools/rush-runner.js index 6a615786f90e..b213d48283f2 100644 --- a/eng/tools/rush-runner.js +++ b/eng/tools/rush-runner.js @@ -5,8 +5,6 @@ const { spawnSync } = require("child_process"); const reducedDependencyTestMatrix = { 'core': ['@azure-rest/core-client', - '@azure-rest/core-client-lro', - '@azure-rest/core-client-paging', '@azure-rest/purview-account', '@azure-tests/perf-storage-blob', '@azure/ai-text-analytics', @@ -37,9 +35,6 @@ const reducedDependencyTestMatrix = { ], 'identity': [ '@azure-rest/core-client', - '@azure-rest/core-client-lro', - '@azure-rest/core-client-paging', - '@azure-rest/purview-account', '@azure-tests/perf-storage-blob', '@azure/ai-text-analytics', '@azure/arm-compute', diff --git a/rush.json b/rush.json index f6a4dab1109b..8e8941b83d0b 100644 --- a/rush.json +++ b/rush.json @@ -336,11 +336,6 @@ "projectFolder": "sdk/agrifood/agrifood-farming-rest", "versionPolicyName": "client" }, - { - "packageName": "@azure-rest/purview-account", - "projectFolder": "sdk/purview/purview-account-rest", - "versionPolicyName": "client" - }, { "packageName": "@azure-rest/purview-administration", "projectFolder": "sdk/purview/purview-administration-rest", @@ -446,21 +441,11 @@ "projectFolder": "sdk/core/core-amqp", "versionPolicyName": "core" }, - { - "packageName": "@azure-rest/core-client-lro", - "projectFolder": "sdk/core/core-client-lro-rest", - "versionPolicyName": "core" - }, { "packageName": "@azure-rest/core-client", "projectFolder": "sdk/core/core-client-rest", "versionPolicyName": "core" }, - { - "packageName": "@azure-rest/core-client-paging", - "projectFolder": "sdk/core/core-client-paging-rest", - "versionPolicyName": "core" - }, { "packageName": "@azure/core-asynciterator-polyfill", "projectFolder": "sdk/core/core-asynciterator-polyfill", @@ -1337,4 +1322,4 @@ "versionPolicyName": "management" } ] -} \ No newline at end of file +} diff --git a/sdk/agrifood/agrifood-farming-rest/package.json b/sdk/agrifood/agrifood-farming-rest/package.json index 2607fe539035..f6d97d22b876 100644 --- a/sdk/agrifood/agrifood-farming-rest/package.json +++ b/sdk/agrifood/agrifood-farming-rest/package.json @@ -83,9 +83,9 @@ "autoPublish": false, "dependencies": { "@azure/core-auth": "^1.3.0", - "@azure-rest/core-client-paging": "1.0.0-beta.1", + "@azure/core-lro": "^2.0.0", + "@azure/core-paging": "^1.2.0", "@azure-rest/core-client": "1.0.0-beta.7", - "@azure-rest/core-client-lro": "1.0.0-beta.1", "@azure/logger": "^1.0.0", "tslib": "^2.2.0" }, diff --git a/sdk/agrifood/agrifood-farming-rest/review/agrifood-farming.api.md b/sdk/agrifood/agrifood-farming-rest/review/agrifood-farming.api.md index 284ca459ab02..02a59a74cdf1 100644 --- a/sdk/agrifood/agrifood-farming-rest/review/agrifood-farming.api.md +++ b/sdk/agrifood/agrifood-farming-rest/review/agrifood-farming.api.md @@ -7,42 +7,73 @@ import { Client } from '@azure-rest/core-client'; import { ClientOptions } from '@azure-rest/core-client'; import { HttpResponse } from '@azure-rest/core-client'; -import { PagedAsyncIterableIterator } from '@azure-rest/core-client-paging'; +import { LroEngineOptions } from '@azure/core-lro'; +import { PagedAsyncIterableIterator } from '@azure/core-paging'; import { PathUncheckedResponse } from '@azure-rest/core-client'; -import { PollerLike } from '@azure-rest/core-client-lro'; -import { PollerOptions } from '@azure-rest/core-client-lro'; -import { PollOperationState } from '@azure-rest/core-client-lro'; +import { PollerLike } from '@azure/core-lro'; +import { PollOperationState } from '@azure/core-lro'; import { RequestParameters } from '@azure-rest/core-client'; import { TokenCredential } from '@azure/core-auth'; // @public (undocumented) export interface ApplicationData { - applicationProductDetails?: ApplicationProductDetail[]; + applicationProductDetails?: Array; area?: Measure; associatedBoundaryId?: string; attachmentsLink?: string; avgMaterial?: Measure; - createdDateTime?: Date; + createdDateTime?: Date | string; description?: string; eTag?: string; farmerId?: string; id?: string; - modifiedDateTime?: Date; + modifiedDateTime?: Date | string; name?: string; operationBoundaryId?: string; - operationEndDateTime?: Date; - operationModifiedDateTime?: Date; - operationStartDateTime?: Date; - properties?: ApplicationDataPropertiesDictionary; + operationEndDateTime?: Date | string; + operationModifiedDateTime?: Date | string; + operationStartDateTime?: Date | string; + properties?: Record>; source?: string; status?: string; totalMaterial?: Measure; } +// @public +export interface ApplicationDataCreateCascadeDeleteJob202Response extends HttpResponse { + // (undocumented) + body: CascadeDeleteJobOutput; + // (undocumented) + status: "202"; +} + +// @public +export interface ApplicationDataCreateCascadeDeleteJobdefaultResponse extends HttpResponse { + // (undocumented) + body: ErrorResponseOutput; + // (undocumented) + status: "500"; +} + +// @public (undocumented) +export type ApplicationDataCreateCascadeDeleteJobParameters = ApplicationDataCreateCascadeDeleteJobQueryParam & RequestParameters; + +// @public (undocumented) +export interface ApplicationDataCreateCascadeDeleteJobQueryParam { + // (undocumented) + queryParameters: ApplicationDataCreateCascadeDeleteJobQueryParamProperties; +} + +// @public (undocumented) +export interface ApplicationDataCreateCascadeDeleteJobQueryParamProperties { + applicationDataId: string; + farmerId: string; +} + // @public export interface ApplicationDataCreateOrUpdate200Response extends HttpResponse { // (undocumented) - body: ApplicationData; + body: ApplicationDataOutput; // (undocumented) status: "200"; } @@ -50,37 +81,36 @@ export interface ApplicationDataCreateOrUpdate200Response extends HttpResponse { // @public export interface ApplicationDataCreateOrUpdate201Response extends HttpResponse { // (undocumented) - body: ApplicationData; + body: ApplicationDataOutput; // (undocumented) status: "201"; } // @public (undocumented) export interface ApplicationDataCreateOrUpdateBodyParam { - // (undocumented) body?: ApplicationData; } // @public export interface ApplicationDataCreateOrUpdatedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type ApplicationDataCreateOrUpdateParameters = RequestParameters & ApplicationDataCreateOrUpdateBodyParam; +export interface ApplicationDataCreateOrUpdateMediaTypesParam { + contentType?: "application/merge-patch+json"; +} // @public (undocumented) -export interface ApplicationDataDelete { - delete(options?: ApplicationDataDeleteParameters): Promise; - get(options?: ApplicationDataGetParameters): Promise; - patch(options?: ApplicationDataCreateOrUpdateParameters): Promise; -} +export type ApplicationDataCreateOrUpdateParameters = ApplicationDataCreateOrUpdateMediaTypesParam & ApplicationDataCreateOrUpdateBodyParam & RequestParameters; // @public export interface ApplicationDataDelete204Response extends HttpResponse { + // (undocumented) + body: Record; // (undocumented) status: "204"; } @@ -88,7 +118,7 @@ export interface ApplicationDataDelete204Response extends HttpResponse { // @public export interface ApplicationDataDeletedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -96,18 +126,50 @@ export interface ApplicationDataDeletedefaultResponse extends HttpResponse { // @public (undocumented) export type ApplicationDataDeleteParameters = RequestParameters; +// @public (undocumented) +export interface ApplicationDataGet { + delete(options?: ApplicationDataDeleteParameters): Promise; + get(options?: ApplicationDataGetParameters): Promise; + patch(options?: ApplicationDataCreateOrUpdateParameters): Promise; +} + // @public export interface ApplicationDataGet200Response extends HttpResponse { // (undocumented) - body: ApplicationData; + body: ApplicationDataOutput; + // (undocumented) + status: "200"; +} + +// @public (undocumented) +export interface ApplicationDataGetCascadeDeleteJobDetails { + get(options?: ApplicationDataGetCascadeDeleteJobDetailsParameters): Promise; + put(options: ApplicationDataCreateCascadeDeleteJobParameters): Promise; +} + +// @public +export interface ApplicationDataGetCascadeDeleteJobDetails200Response extends HttpResponse { + // (undocumented) + body: CascadeDeleteJobOutput; // (undocumented) status: "200"; } +// @public +export interface ApplicationDataGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { + // (undocumented) + body: ErrorResponseOutput; + // (undocumented) + status: "500"; +} + +// @public (undocumented) +export type ApplicationDataGetCascadeDeleteJobDetailsParameters = RequestParameters; + // @public export interface ApplicationDataGetdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -123,7 +185,7 @@ export interface ApplicationDataList { // @public export interface ApplicationDataList200Response extends HttpResponse { // (undocumented) - body: ApplicationDataListResponse; + body: ApplicationDataListResponseOutput; // (undocumented) status: "200"; } @@ -136,7 +198,7 @@ export interface ApplicationDataListByFarmerId { // @public export interface ApplicationDataListByFarmerId200Response extends HttpResponse { // (undocumented) - body: ApplicationDataListResponse; + body: ApplicationDataListResponseOutput; // (undocumented) status: "200"; } @@ -144,13 +206,13 @@ export interface ApplicationDataListByFarmerId200Response extends HttpResponse { // @public export interface ApplicationDataListByFarmerIddefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type ApplicationDataListByFarmerIdParameters = RequestParameters & ApplicationDataListByFarmerIdQueryParam; +export type ApplicationDataListByFarmerIdParameters = ApplicationDataListByFarmerIdQueryParam & RequestParameters; // @public (undocumented) export interface ApplicationDataListByFarmerIdQueryParam { @@ -162,41 +224,41 @@ export interface ApplicationDataListByFarmerIdQueryParam { export interface ApplicationDataListByFarmerIdQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - associatedBoundaryIds?: string[]; - ids?: string[]; + associatedBoundaryIds?: Array; + ids?: Array; maxArea?: number; maxAvgMaterial?: number; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - maxOperationEndDateTime?: Date; - maxOperationModifiedDateTime?: Date; - maxOperationStartDateTime?: Date; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + maxOperationEndDateTime?: Date | string; + maxOperationModifiedDateTime?: Date | string; + maxOperationStartDateTime?: Date | string; maxTotalMaterial?: number; minArea?: number; minAvgMaterial?: number; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - minOperationEndDateTime?: Date; - minOperationModifiedDateTime?: Date; - minOperationStartDateTime?: Date; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + minOperationEndDateTime?: Date | string; + minOperationModifiedDateTime?: Date | string; + minOperationStartDateTime?: Date | string; minTotalMaterial?: number; - names?: string[]; - operationBoundaryIds?: string[]; - propertyFilters?: string[]; - sources?: string[]; - statuses?: string[]; + names?: Array; + operationBoundaryIds?: Array; + propertyFilters?: Array; + sources?: Array; + statuses?: Array; } // @public export interface ApplicationDataListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type ApplicationDataListParameters = RequestParameters & ApplicationDataListQueryParam; +export type ApplicationDataListParameters = ApplicationDataListQueryParam & RequestParameters; // @public (undocumented) export interface ApplicationDataListQueryParam { @@ -208,40 +270,61 @@ export interface ApplicationDataListQueryParam { export interface ApplicationDataListQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - associatedBoundaryIds?: string[]; - ids?: string[]; + associatedBoundaryIds?: Array; + ids?: Array; maxArea?: number; maxAvgMaterial?: number; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - maxOperationEndDateTime?: Date; - maxOperationModifiedDateTime?: Date; - maxOperationStartDateTime?: Date; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + maxOperationEndDateTime?: Date | string; + maxOperationModifiedDateTime?: Date | string; + maxOperationStartDateTime?: Date | string; maxTotalMaterial?: number; minArea?: number; minAvgMaterial?: number; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - minOperationEndDateTime?: Date; - minOperationModifiedDateTime?: Date; - minOperationStartDateTime?: Date; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + minOperationEndDateTime?: Date | string; + minOperationModifiedDateTime?: Date | string; + minOperationStartDateTime?: Date | string; minTotalMaterial?: number; - names?: string[]; - operationBoundaryIds?: string[]; - propertyFilters?: string[]; - sources?: string[]; - statuses?: string[]; + names?: Array; + operationBoundaryIds?: Array; + propertyFilters?: Array; + sources?: Array; + statuses?: Array; } // @public (undocumented) -export interface ApplicationDataListResponse { +export interface ApplicationDataListResponseOutput { + $skipToken?: string; nextLink?: string; - skipToken?: string; - value?: ApplicationData[]; + value?: Array; } // @public (undocumented) -export type ApplicationDataPropertiesDictionary = Record; +export interface ApplicationDataOutput { + applicationProductDetails?: Array; + area?: MeasureOutput; + associatedBoundaryId?: string; + attachmentsLink?: string; + avgMaterial?: MeasureOutput; + createdDateTime?: string; + description?: string; + eTag?: string; + farmerId?: string; + id?: string; + modifiedDateTime?: string; + name?: string; + operationBoundaryId?: string; + operationEndDateTime?: string; + operationModifiedDateTime?: string; + operationStartDateTime?: string; + properties?: Record>; + source?: string; + status?: string; + totalMaterial?: MeasureOutput; +} // @public (undocumented) export interface ApplicationProductDetail { @@ -252,13 +335,28 @@ export interface ApplicationProductDetail { } // @public (undocumented) -export interface Attachment { - createdDateTime?: Date; +export interface ApplicationProductDetailOutput { + avgMaterial?: MeasureOutput; + isCarrier?: boolean; + productName?: string; + totalMaterial?: MeasureOutput; +} + +// @public (undocumented) +export interface AttachmentListResponseOutput { + $skipToken?: string; + nextLink?: string; + value?: Array; +} + +// @public (undocumented) +export interface AttachmentOutput { + createdDateTime?: string; description?: string; eTag?: string; farmerId?: string; id?: string; - modifiedDateTime?: Date; + modifiedDateTime?: string; name?: string; originalFileName?: string; resourceId?: string; @@ -266,17 +364,10 @@ export interface Attachment { status?: string; } -// @public (undocumented) -export interface AttachmentListResponse { - nextLink?: string; - skipToken?: string; - value?: Attachment[]; -} - // @public export interface AttachmentsCreateOrUpdate200Response extends HttpResponse { // (undocumented) - body: Attachment; + body: AttachmentOutput; // (undocumented) status: "200"; } @@ -284,7 +375,7 @@ export interface AttachmentsCreateOrUpdate200Response extends HttpResponse { // @public export interface AttachmentsCreateOrUpdate201Response extends HttpResponse { // (undocumented) - body: Attachment; + body: AttachmentOutput; // (undocumented) status: "201"; } @@ -292,29 +383,45 @@ export interface AttachmentsCreateOrUpdate201Response extends HttpResponse { // @public (undocumented) export interface AttachmentsCreateOrUpdateBodyParam { // (undocumented) - body?: string; + body?: AttachmentsCreateOrUpdateFormBody; } // @public export interface AttachmentsCreateOrUpdatedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type AttachmentsCreateOrUpdateParameters = RequestParameters & AttachmentsCreateOrUpdateBodyParam; +export interface AttachmentsCreateOrUpdateFormBody { + CreatedDateTime?: string; + Description?: string; + ETag?: string; + FarmerId?: string; + file?: string | Uint8Array; + Id?: string; + ModifiedDateTime?: string; + Name?: string; + OriginalFileName?: string; + ResourceId?: string; + ResourceType?: string; + Status?: string; +} // @public (undocumented) -export interface AttachmentsDelete { - delete(options?: AttachmentsDeleteParameters): Promise; - get(options?: AttachmentsGetParameters): Promise; - patch(options?: AttachmentsCreateOrUpdateParameters): Promise; +export interface AttachmentsCreateOrUpdateMediaTypesParam { + contentType?: "multipart/form-data"; } +// @public (undocumented) +export type AttachmentsCreateOrUpdateParameters = AttachmentsCreateOrUpdateMediaTypesParam & AttachmentsCreateOrUpdateBodyParam & RequestParameters; + // @public export interface AttachmentsDelete204Response extends HttpResponse { + // (undocumented) + body: Record; // (undocumented) status: "204"; } @@ -322,7 +429,7 @@ export interface AttachmentsDelete204Response extends HttpResponse { // @public export interface AttachmentsDeletedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -337,6 +444,7 @@ export interface AttachmentsDownload { // @public export interface AttachmentsDownload200Response extends HttpResponse { + body: Uint8Array; // (undocumented) status: "200"; } @@ -344,7 +452,7 @@ export interface AttachmentsDownload200Response extends HttpResponse { // @public export interface AttachmentsDownloaddefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -352,10 +460,17 @@ export interface AttachmentsDownloaddefaultResponse extends HttpResponse { // @public (undocumented) export type AttachmentsDownloadParameters = RequestParameters; +// @public (undocumented) +export interface AttachmentsGet { + delete(options?: AttachmentsDeleteParameters): Promise; + get(options?: AttachmentsGetParameters): Promise; + patch(options?: AttachmentsCreateOrUpdateParameters): Promise; +} + // @public export interface AttachmentsGet200Response extends HttpResponse { // (undocumented) - body: Attachment; + body: AttachmentOutput; // (undocumented) status: "200"; } @@ -363,7 +478,7 @@ export interface AttachmentsGet200Response extends HttpResponse { // @public export interface AttachmentsGetdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -379,7 +494,7 @@ export interface AttachmentsListByFarmerId { // @public export interface AttachmentsListByFarmerId200Response extends HttpResponse { // (undocumented) - body: AttachmentListResponse; + body: AttachmentListResponseOutput; // (undocumented) status: "200"; } @@ -387,13 +502,13 @@ export interface AttachmentsListByFarmerId200Response extends HttpResponse { // @public export interface AttachmentsListByFarmerIddefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type AttachmentsListByFarmerIdParameters = RequestParameters & AttachmentsListByFarmerIdQueryParam; +export type AttachmentsListByFarmerIdParameters = AttachmentsListByFarmerIdQueryParam & RequestParameters; // @public (undocumented) export interface AttachmentsListByFarmerIdQueryParam { @@ -405,28 +520,22 @@ export interface AttachmentsListByFarmerIdQueryParam { export interface AttachmentsListByFarmerIdQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - ids?: string[]; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - names?: string[]; - propertyFilters?: string[]; - resourceIds?: string[]; - resourceTypes?: string[]; - statuses?: string[]; -} - -// @public (undocumented) -export interface BoundariesCreateCascadeDeleteJob { - get(options?: BoundariesGetCascadeDeleteJobDetailsParameters): Promise; - put(options?: BoundariesCreateCascadeDeleteJobParameters): Promise; + ids?: Array; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + names?: Array; + propertyFilters?: Array; + resourceIds?: Array; + resourceTypes?: Array; + statuses?: Array; } // @public export interface BoundariesCreateCascadeDeleteJob202Response extends HttpResponse { // (undocumented) - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; // (undocumented) status: "202"; } @@ -434,13 +543,13 @@ export interface BoundariesCreateCascadeDeleteJob202Response extends HttpRespons // @public export interface BoundariesCreateCascadeDeleteJobdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type BoundariesCreateCascadeDeleteJobParameters = RequestParameters & BoundariesCreateCascadeDeleteJobQueryParam; +export type BoundariesCreateCascadeDeleteJobParameters = BoundariesCreateCascadeDeleteJobQueryParam & RequestParameters; // @public (undocumented) export interface BoundariesCreateCascadeDeleteJobQueryParam { @@ -457,7 +566,7 @@ export interface BoundariesCreateCascadeDeleteJobQueryParamProperties { // @public export interface BoundariesCreateOrUpdate200Response extends HttpResponse { // (undocumented) - body: Boundary; + body: BoundaryOutput; // (undocumented) status: "200"; } @@ -465,37 +574,36 @@ export interface BoundariesCreateOrUpdate200Response extends HttpResponse { // @public export interface BoundariesCreateOrUpdate201Response extends HttpResponse { // (undocumented) - body: Boundary; + body: BoundaryOutput; // (undocumented) status: "201"; } // @public (undocumented) export interface BoundariesCreateOrUpdateBodyParam { - // (undocumented) body?: Boundary; } // @public export interface BoundariesCreateOrUpdatedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type BoundariesCreateOrUpdateParameters = RequestParameters & BoundariesCreateOrUpdateBodyParam; +export interface BoundariesCreateOrUpdateMediaTypesParam { + contentType?: "application/merge-patch+json"; +} // @public (undocumented) -export interface BoundariesDelete { - delete(options?: BoundariesDeleteParameters): Promise; - get(options?: BoundariesGetParameters): Promise; - patch(options?: BoundariesCreateOrUpdateParameters): Promise; -} +export type BoundariesCreateOrUpdateParameters = BoundariesCreateOrUpdateMediaTypesParam & BoundariesCreateOrUpdateBodyParam & RequestParameters; // @public export interface BoundariesDelete204Response extends HttpResponse { + // (undocumented) + body: Record; // (undocumented) status: "204"; } @@ -503,7 +611,7 @@ export interface BoundariesDelete204Response extends HttpResponse { // @public export interface BoundariesDeletedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -511,18 +619,31 @@ export interface BoundariesDeletedefaultResponse extends HttpResponse { // @public (undocumented) export type BoundariesDeleteParameters = RequestParameters; +// @public (undocumented) +export interface BoundariesGet { + delete(options?: BoundariesDeleteParameters): Promise; + get(options?: BoundariesGetParameters): Promise; + patch(options?: BoundariesCreateOrUpdateParameters): Promise; +} + // @public export interface BoundariesGet200Response extends HttpResponse { // (undocumented) - body: Boundary; + body: BoundaryOutput; // (undocumented) status: "200"; } +// @public (undocumented) +export interface BoundariesGetCascadeDeleteJobDetails { + get(options?: BoundariesGetCascadeDeleteJobDetailsParameters): Promise; + put(options: BoundariesCreateCascadeDeleteJobParameters): Promise; +} + // @public export interface BoundariesGetCascadeDeleteJobDetails200Response extends HttpResponse { // (undocumented) - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; // (undocumented) status: "200"; } @@ -530,7 +651,7 @@ export interface BoundariesGetCascadeDeleteJobDetails200Response extends HttpRes // @public export interface BoundariesGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -541,20 +662,20 @@ export type BoundariesGetCascadeDeleteJobDetailsParameters = RequestParameters; // @public export interface BoundariesGetdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) export interface BoundariesGetOverlap { - get(options?: BoundariesGetOverlapParameters): Promise; + get(options: BoundariesGetOverlapParameters): Promise; } // @public export interface BoundariesGetOverlap200Response extends HttpResponse { // (undocumented) - body: BoundaryOverlapResponse; + body: BoundaryOverlapResponseOutput; // (undocumented) status: "200"; } @@ -562,13 +683,13 @@ export interface BoundariesGetOverlap200Response extends HttpResponse { // @public export interface BoundariesGetOverlapdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type BoundariesGetOverlapParameters = RequestParameters & BoundariesGetOverlapQueryParam; +export type BoundariesGetOverlapParameters = BoundariesGetOverlapQueryParam & RequestParameters; // @public (undocumented) export interface BoundariesGetOverlapQueryParam { @@ -585,18 +706,30 @@ export interface BoundariesGetOverlapQueryParamProperties { // @public (undocumented) export type BoundariesGetParameters = RequestParameters; +// @public (undocumented) +export interface BoundariesList { + get(options?: BoundariesListParameters): Promise; + post(options?: BoundariesSearchParameters): Promise; +} + // @public export interface BoundariesList200Response extends HttpResponse { // (undocumented) - body: BoundaryListResponse; + body: BoundaryListResponseOutput; // (undocumented) status: "200"; } +// @public (undocumented) +export interface BoundariesListByFarmerId { + get(options?: BoundariesListByFarmerIdParameters): Promise; + post(options?: BoundariesSearchByFarmerIdParameters): Promise; +} + // @public export interface BoundariesListByFarmerId200Response extends HttpResponse { // (undocumented) - body: BoundaryListResponse; + body: BoundaryListResponseOutput; // (undocumented) status: "200"; } @@ -604,13 +737,13 @@ export interface BoundariesListByFarmerId200Response extends HttpResponse { // @public export interface BoundariesListByFarmerIddefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type BoundariesListByFarmerIdParameters = RequestParameters & BoundariesListByFarmerIdQueryParam; +export type BoundariesListByFarmerIdParameters = BoundariesListByFarmerIdQueryParam & RequestParameters; // @public (undocumented) export interface BoundariesListByFarmerIdQueryParam { @@ -622,31 +755,31 @@ export interface BoundariesListByFarmerIdQueryParam { export interface BoundariesListByFarmerIdQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - ids?: string[]; + ids?: Array; isPrimary?: boolean; maxAcreage?: number; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; minAcreage?: number; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - names?: string[]; - parentIds?: string[]; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + names?: Array; + parentIds?: Array; parentType?: string; - propertyFilters?: string[]; - statuses?: string[]; + propertyFilters?: Array; + statuses?: Array; } // @public export interface BoundariesListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type BoundariesListParameters = RequestParameters & BoundariesListQueryParam; +export type BoundariesListParameters = BoundariesListQueryParam & RequestParameters; // @public (undocumented) export interface BoundariesListQueryParam { @@ -658,166 +791,181 @@ export interface BoundariesListQueryParam { export interface BoundariesListQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - ids?: string[]; + ids?: Array; isPrimary?: boolean; maxAcreage?: number; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; minAcreage?: number; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - names?: string[]; - parentIds?: string[]; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + names?: Array; + parentIds?: Array; parentType?: string; - propertyFilters?: string[]; - statuses?: string[]; -} - -// @public (undocumented) -export interface BoundariesSearch { - get(options?: BoundariesListParameters): Promise; - post(options?: BoundariesSearchParameters): Promise; + propertyFilters?: Array; + statuses?: Array; } // @public export interface BoundariesSearch200Response extends HttpResponse { // (undocumented) - body: BoundaryListResponse; + body: BoundaryListResponseOutput; // (undocumented) status: "200"; } // @public (undocumented) export interface BoundariesSearchBodyParam { - // (undocumented) body?: SearchBoundaryQuery; } -// @public (undocumented) -export interface BoundariesSearchByFarmerId { - get(options?: BoundariesListByFarmerIdParameters): Promise; - post(options?: BoundariesSearchByFarmerIdParameters): Promise; -} - // @public export interface BoundariesSearchByFarmerId200Response extends HttpResponse { // (undocumented) - body: BoundaryListResponse; + body: BoundaryListResponseOutput; // (undocumented) status: "200"; } // @public (undocumented) export interface BoundariesSearchByFarmerIdBodyParam { - // (undocumented) body?: SearchBoundaryQuery; } // @public export interface BoundariesSearchByFarmerIddefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type BoundariesSearchByFarmerIdParameters = RequestParameters & BoundariesSearchByFarmerIdBodyParam; +export interface BoundariesSearchByFarmerIdMediaTypesParam { + contentType?: "application/json"; +} + +// @public (undocumented) +export type BoundariesSearchByFarmerIdParameters = BoundariesSearchByFarmerIdMediaTypesParam & BoundariesSearchByFarmerIdBodyParam & RequestParameters; // @public export interface BoundariesSearchdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type BoundariesSearchParameters = RequestParameters & BoundariesSearchBodyParam; +export interface BoundariesSearchMediaTypesParam { + contentType?: "application/json"; +} + +// @public (undocumented) +export type BoundariesSearchParameters = BoundariesSearchMediaTypesParam & BoundariesSearchBodyParam & RequestParameters; // @public (undocumented) export interface Boundary { acreage?: number; - createdDateTime?: Date; + createdDateTime?: Date | string; description?: string; eTag?: string; farmerId?: string; geometry?: GeoJsonObject; id?: string; isPrimary?: boolean; - modifiedDateTime?: Date; + modifiedDateTime?: Date | string; name?: string; parentId?: string; parentType?: string; - properties?: BoundaryPropertiesDictionary; + properties?: Record>; status?: string; } // @public (undocumented) -export interface BoundaryListResponse { +export interface BoundaryListResponseOutput { + $skipToken?: string; nextLink?: string; - skipToken?: string; - value?: Boundary[]; + value?: Array; +} + +// @public (undocumented) +export interface BoundaryOutput { + acreage?: number; + createdDateTime?: string; + description?: string; + eTag?: string; + farmerId?: string; + geometry?: GeoJsonObjectOutput; + id?: string; + isPrimary?: boolean; + modifiedDateTime?: string; + name?: string; + parentId?: string; + parentType?: string; + properties?: Record>; + status?: string; } // @public (undocumented) -export interface BoundaryOverlapResponse { +export interface BoundaryOverlapResponseOutput { boundaryAcreage?: number; intersectingAcreage?: number; otherBoundaryAcreage?: number; } // @public (undocumented) -export type BoundaryPropertiesDictionary = Record; - -// @public (undocumented) -export interface CascadeDeleteJob { - createdDateTime?: Date; - description?: string; +export interface CascadeDeleteJobOutput { + createdDateTime?: string; durationInSeconds?: number; - endTime?: Date; + endTime?: string; farmerId: string; id?: string; - lastActionDateTime?: Date; + lastActionDateTime?: string; message?: string; - name?: string; - properties?: CascadeDeleteJobPropertiesDictionary; resourceId: string; resourceType: string; - startTime?: Date; - status?: string; + startTime?: string; + status?: "Waiting" | "Running" | "Succeeded" | "Failed" | "Cancelled"; } -// @public (undocumented) -export type CascadeDeleteJobPropertiesDictionary = Record; - // @public (undocumented) export interface Crop { - createdDateTime?: Date; + createdDateTime?: Date | string; description?: string; eTag?: string; id?: string; - modifiedDateTime?: Date; + modifiedDateTime?: Date | string; name?: string; phenotype?: string; - properties?: CropPropertiesDictionary; + properties?: Record>; status?: string; } // @public (undocumented) -export interface CropListResponse { +export interface CropListResponseOutput { + $skipToken?: string; nextLink?: string; - skipToken?: string; - value?: Crop[]; + value?: Array; } // @public (undocumented) -export type CropPropertiesDictionary = Record; +export interface CropOutput { + createdDateTime?: string; + description?: string; + eTag?: string; + id?: string; + modifiedDateTime?: string; + name?: string; + phenotype?: string; + properties?: Record>; + status?: string; +} // @public export interface CropsCreateOrUpdate200Response extends HttpResponse { // (undocumented) - body: Crop; + body: CropOutput; // (undocumented) status: "200"; } @@ -825,37 +973,36 @@ export interface CropsCreateOrUpdate200Response extends HttpResponse { // @public export interface CropsCreateOrUpdate201Response extends HttpResponse { // (undocumented) - body: Crop; + body: CropOutput; // (undocumented) status: "201"; } // @public (undocumented) export interface CropsCreateOrUpdateBodyParam { - // (undocumented) body?: Crop; } // @public export interface CropsCreateOrUpdatedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type CropsCreateOrUpdateParameters = RequestParameters & CropsCreateOrUpdateBodyParam; +export interface CropsCreateOrUpdateMediaTypesParam { + contentType?: "application/merge-patch+json"; +} // @public (undocumented) -export interface CropsDelete { - delete(options?: CropsDeleteParameters): Promise; - get(options?: CropsGetParameters): Promise; - patch(options?: CropsCreateOrUpdateParameters): Promise; -} +export type CropsCreateOrUpdateParameters = CropsCreateOrUpdateMediaTypesParam & CropsCreateOrUpdateBodyParam & RequestParameters; // @public export interface CropsDelete204Response extends HttpResponse { + // (undocumented) + body: Record; // (undocumented) status: "204"; } @@ -863,7 +1010,7 @@ export interface CropsDelete204Response extends HttpResponse { // @public export interface CropsDeletedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -871,10 +1018,17 @@ export interface CropsDeletedefaultResponse extends HttpResponse { // @public (undocumented) export type CropsDeleteParameters = RequestParameters; +// @public (undocumented) +export interface CropsGet { + delete(options?: CropsDeleteParameters): Promise; + get(options?: CropsGetParameters): Promise; + patch(options?: CropsCreateOrUpdateParameters): Promise; +} + // @public export interface CropsGet200Response extends HttpResponse { // (undocumented) - body: Crop; + body: CropOutput; // (undocumented) status: "200"; } @@ -882,7 +1036,7 @@ export interface CropsGet200Response extends HttpResponse { // @public export interface CropsGetdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -898,7 +1052,7 @@ export interface CropsList { // @public export interface CropsList200Response extends HttpResponse { // (undocumented) - body: CropListResponse; + body: CropListResponseOutput; // (undocumented) status: "200"; } @@ -906,13 +1060,13 @@ export interface CropsList200Response extends HttpResponse { // @public export interface CropsListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type CropsListParameters = RequestParameters & CropsListQueryParam; +export type CropsListParameters = CropsListQueryParam & RequestParameters; // @public (undocumented) export interface CropsListQueryParam { @@ -924,21 +1078,21 @@ export interface CropsListQueryParam { export interface CropsListQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - ids?: string[]; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - names?: string[]; - phenotypes?: string[]; - propertyFilters?: string[]; - statuses?: string[]; + ids?: Array; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + names?: Array; + phenotypes?: Array; + propertyFilters?: Array; + statuses?: Array; } // @public export interface CropVarietiesCreateOrUpdate200Response extends HttpResponse { // (undocumented) - body: CropVariety; + body: CropVarietyOutput; // (undocumented) status: "200"; } @@ -946,37 +1100,36 @@ export interface CropVarietiesCreateOrUpdate200Response extends HttpResponse { // @public export interface CropVarietiesCreateOrUpdate201Response extends HttpResponse { // (undocumented) - body: CropVariety; + body: CropVarietyOutput; // (undocumented) status: "201"; } // @public (undocumented) export interface CropVarietiesCreateOrUpdateBodyParam { - // (undocumented) body?: CropVariety; } // @public export interface CropVarietiesCreateOrUpdatedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type CropVarietiesCreateOrUpdateParameters = RequestParameters & CropVarietiesCreateOrUpdateBodyParam; +export interface CropVarietiesCreateOrUpdateMediaTypesParam { + contentType?: "application/merge-patch+json"; +} // @public (undocumented) -export interface CropVarietiesDelete { - delete(options?: CropVarietiesDeleteParameters): Promise; - get(options?: CropVarietiesGetParameters): Promise; - patch(options?: CropVarietiesCreateOrUpdateParameters): Promise; -} +export type CropVarietiesCreateOrUpdateParameters = CropVarietiesCreateOrUpdateMediaTypesParam & CropVarietiesCreateOrUpdateBodyParam & RequestParameters; // @public export interface CropVarietiesDelete204Response extends HttpResponse { + // (undocumented) + body: Record; // (undocumented) status: "204"; } @@ -984,7 +1137,7 @@ export interface CropVarietiesDelete204Response extends HttpResponse { // @public export interface CropVarietiesDeletedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -992,10 +1145,17 @@ export interface CropVarietiesDeletedefaultResponse extends HttpResponse { // @public (undocumented) export type CropVarietiesDeleteParameters = RequestParameters; +// @public (undocumented) +export interface CropVarietiesGet { + delete(options?: CropVarietiesDeleteParameters): Promise; + get(options?: CropVarietiesGetParameters): Promise; + patch(options?: CropVarietiesCreateOrUpdateParameters): Promise; +} + // @public export interface CropVarietiesGet200Response extends HttpResponse { // (undocumented) - body: CropVariety; + body: CropVarietyOutput; // (undocumented) status: "200"; } @@ -1003,7 +1163,7 @@ export interface CropVarietiesGet200Response extends HttpResponse { // @public export interface CropVarietiesGetdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -1019,7 +1179,7 @@ export interface CropVarietiesList { // @public export interface CropVarietiesList200Response extends HttpResponse { // (undocumented) - body: CropVarietyListResponse; + body: CropVarietyListResponseOutput; // (undocumented) status: "200"; } @@ -1032,7 +1192,7 @@ export interface CropVarietiesListByCropId { // @public export interface CropVarietiesListByCropId200Response extends HttpResponse { // (undocumented) - body: CropVarietyListResponse; + body: CropVarietyListResponseOutput; // (undocumented) status: "200"; } @@ -1040,13 +1200,13 @@ export interface CropVarietiesListByCropId200Response extends HttpResponse { // @public export interface CropVarietiesListByCropIddefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type CropVarietiesListByCropIdParameters = RequestParameters & CropVarietiesListByCropIdQueryParam; +export type CropVarietiesListByCropIdParameters = CropVarietiesListByCropIdQueryParam & RequestParameters; // @public (undocumented) export interface CropVarietiesListByCropIdQueryParam { @@ -1058,29 +1218,29 @@ export interface CropVarietiesListByCropIdQueryParam { export interface CropVarietiesListByCropIdQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - brands?: string[]; - cropIds?: string[]; - ids?: string[]; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - names?: string[]; - products?: string[]; - propertyFilters?: string[]; - statuses?: string[]; + brands?: Array; + cropIds?: Array; + ids?: Array; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + names?: Array; + products?: Array; + propertyFilters?: Array; + statuses?: Array; } // @public export interface CropVarietiesListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type CropVarietiesListParameters = RequestParameters & CropVarietiesListQueryParam; +export type CropVarietiesListParameters = CropVarietiesListQueryParam & RequestParameters; // @public (undocumented) export interface CropVarietiesListQueryParam { @@ -1092,80 +1252,86 @@ export interface CropVarietiesListQueryParam { export interface CropVarietiesListQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - brands?: string[]; - cropIds?: string[]; - ids?: string[]; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - names?: string[]; - products?: string[]; - propertyFilters?: string[]; - statuses?: string[]; + brands?: Array; + cropIds?: Array; + ids?: Array; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + names?: Array; + products?: Array; + propertyFilters?: Array; + statuses?: Array; } // @public (undocumented) export interface CropVariety { brand?: string; - createdDateTime?: Date; + createdDateTime?: Date | string; cropId?: string; description?: string; eTag?: string; id?: string; - modifiedDateTime?: Date; + modifiedDateTime?: Date | string; name?: string; product?: string; - properties?: CropVarietyPropertiesDictionary; + properties?: Record>; status?: string; } // @public (undocumented) -export interface CropVarietyListResponse { +export interface CropVarietyListResponseOutput { + $skipToken?: string; nextLink?: string; - skipToken?: string; - value?: CropVariety[]; + value?: Array; } // @public (undocumented) -export type CropVarietyPropertiesDictionary = Record; - -// @public (undocumented) -export type DataProvider = "Microsoft"; +export interface CropVarietyOutput { + brand?: string; + createdDateTime?: string; + cropId?: string; + description?: string; + eTag?: string; + id?: string; + modifiedDateTime?: string; + name?: string; + product?: string; + properties?: Record>; + status?: string; +} // @public (undocumented) -interface Error_2 { +export interface ErrorModelOutput { code?: string; - details?: Error_2[]; - innererror?: InnerError; + details?: Array; + innererror?: InnerErrorOutput; message?: string; target?: string; } -export { Error_2 as Error } - // @public (undocumented) -export interface ErrorResponse { - error?: Error_2; +export interface ErrorResponseOutput { + error?: ErrorModelOutput; traceId?: string; } // @public (undocumented) export interface Farm { - createdDateTime?: Date; + createdDateTime?: Date | string; description?: string; eTag?: string; farmerId?: string; id?: string; - modifiedDateTime?: Date; + modifiedDateTime?: Date | string; name?: string; - properties?: FarmPropertiesDictionary; + properties?: Record>; status?: string; } // @public (undocumented) -function FarmBeats(Endpoint: string, credentials: TokenCredential, options?: ClientOptions): FarmBeatsRestClient; - +function FarmBeats($host: string, credentials: TokenCredential, options?: ClientOptions): FarmBeatsRestClient; export default FarmBeats; // @public (undocumented) @@ -1175,36 +1341,39 @@ export type FarmBeatsRestClient = Client & { // @public (undocumented) export interface Farmer { - createdDateTime?: Date; + createdDateTime?: Date | string; description?: string; eTag?: string; id?: string; - modifiedDateTime?: Date; + modifiedDateTime?: Date | string; name?: string; - properties?: FarmerPropertiesDictionary; + properties?: Record; status?: string; } // @public (undocumented) -export interface FarmerListResponse { +export interface FarmerListResponseOutput { + $skipToken?: string; nextLink?: string; - skipToken?: string; - value?: Farmer[]; + value?: Array; } // @public (undocumented) -export type FarmerPropertiesDictionary = Record; - -// @public (undocumented) -export interface FarmersCreateCascadeDeleteJob { - get(options?: FarmersGetCascadeDeleteJobDetailsParameters): Promise; - put(options?: FarmersCreateCascadeDeleteJobParameters): Promise; +export interface FarmerOutput { + createdDateTime?: string; + description?: string; + eTag?: string; + id?: string; + modifiedDateTime?: string; + name?: string; + properties?: Record; + status?: string; } // @public export interface FarmersCreateCascadeDeleteJob202Response extends HttpResponse { // (undocumented) - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; // (undocumented) status: "202"; } @@ -1212,13 +1381,13 @@ export interface FarmersCreateCascadeDeleteJob202Response extends HttpResponse { // @public export interface FarmersCreateCascadeDeleteJobdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type FarmersCreateCascadeDeleteJobParameters = RequestParameters & FarmersCreateCascadeDeleteJobQueryParam; +export type FarmersCreateCascadeDeleteJobParameters = FarmersCreateCascadeDeleteJobQueryParam & RequestParameters; // @public (undocumented) export interface FarmersCreateCascadeDeleteJobQueryParam { @@ -1234,7 +1403,7 @@ export interface FarmersCreateCascadeDeleteJobQueryParamProperties { // @public export interface FarmersCreateOrUpdate200Response extends HttpResponse { // (undocumented) - body: Farmer; + body: FarmerOutput; // (undocumented) status: "200"; } @@ -1242,37 +1411,36 @@ export interface FarmersCreateOrUpdate200Response extends HttpResponse { // @public export interface FarmersCreateOrUpdate201Response extends HttpResponse { // (undocumented) - body: Farmer; + body: FarmerOutput; // (undocumented) status: "201"; } // @public (undocumented) export interface FarmersCreateOrUpdateBodyParam { - // (undocumented) body?: Farmer; } // @public export interface FarmersCreateOrUpdatedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type FarmersCreateOrUpdateParameters = RequestParameters & FarmersCreateOrUpdateBodyParam; +export interface FarmersCreateOrUpdateMediaTypesParam { + contentType?: "application/merge-patch+json"; +} // @public (undocumented) -export interface FarmersDelete { - delete(options?: FarmersDeleteParameters): Promise; - get(options?: FarmersGetParameters): Promise; - patch(options?: FarmersCreateOrUpdateParameters): Promise; -} +export type FarmersCreateOrUpdateParameters = FarmersCreateOrUpdateMediaTypesParam & FarmersCreateOrUpdateBodyParam & RequestParameters; // @public export interface FarmersDelete204Response extends HttpResponse { + // (undocumented) + body: Record; // (undocumented) status: "204"; } @@ -1280,7 +1448,7 @@ export interface FarmersDelete204Response extends HttpResponse { // @public export interface FarmersDeletedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -1288,18 +1456,31 @@ export interface FarmersDeletedefaultResponse extends HttpResponse { // @public (undocumented) export type FarmersDeleteParameters = RequestParameters; +// @public (undocumented) +export interface FarmersGet { + delete(options?: FarmersDeleteParameters): Promise; + get(options?: FarmersGetParameters): Promise; + patch(options?: FarmersCreateOrUpdateParameters): Promise; +} + // @public export interface FarmersGet200Response extends HttpResponse { // (undocumented) - body: Farmer; + body: FarmerOutput; // (undocumented) status: "200"; } +// @public (undocumented) +export interface FarmersGetCascadeDeleteJobDetails { + get(options?: FarmersGetCascadeDeleteJobDetailsParameters): Promise; + put(options: FarmersCreateCascadeDeleteJobParameters): Promise; +} + // @public export interface FarmersGetCascadeDeleteJobDetails200Response extends HttpResponse { // (undocumented) - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; // (undocumented) status: "200"; } @@ -1307,7 +1488,7 @@ export interface FarmersGetCascadeDeleteJobDetails200Response extends HttpRespon // @public export interface FarmersGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -1318,7 +1499,7 @@ export type FarmersGetCascadeDeleteJobDetailsParameters = RequestParameters; // @public export interface FarmersGetdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -1334,7 +1515,7 @@ export interface FarmersList { // @public export interface FarmersList200Response extends HttpResponse { // (undocumented) - body: FarmerListResponse; + body: FarmerListResponseOutput; // (undocumented) status: "200"; } @@ -1342,13 +1523,13 @@ export interface FarmersList200Response extends HttpResponse { // @public export interface FarmersListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type FarmersListParameters = RequestParameters & FarmersListQueryParam; +export type FarmersListParameters = FarmersListQueryParam & RequestParameters; // @public (undocumented) export interface FarmersListQueryParam { @@ -1360,80 +1541,100 @@ export interface FarmersListQueryParam { export interface FarmersListQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - ids?: string[]; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - names?: string[]; - propertyFilters?: string[]; - statuses?: string[]; + ids?: Array; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + names?: Array; + propertyFilters?: Array; + statuses?: Array; } // @public (undocumented) -export interface FarmListResponse { +export interface FarmListResponseOutput { + $skipToken?: string; nextLink?: string; - skipToken?: string; - value?: Farm[]; + value?: Array; } // @public (undocumented) export interface FarmOperationDataIngestionJob { authProviderId: string; - createdDateTime?: Date; + createdDateTime?: Date | string; description?: string; durationInSeconds?: number; - endTime?: Date; + endTime?: Date | string; farmerId: string; id?: string; - lastActionDateTime?: Date; + lastActionDateTime?: Date | string; message?: string; name?: string; - operations?: string[]; - properties?: FarmOperationDataIngestionJobPropertiesDictionary; - startTime?: Date; + operations?: Array; + properties?: Record>; + startTime?: Date | string; startYear: number; status?: string; } // @public (undocumented) -export type FarmOperationDataIngestionJobPropertiesDictionary = Record; - -// @public -export interface FarmOperationsCreateDataIngestionJob202Response extends HttpResponse { - // (undocumented) - body: FarmOperationDataIngestionJob; - // (undocumented) - status: "202"; -} +export interface FarmOperationDataIngestionJobOutput { + authProviderId: string; + createdDateTime?: string; + description?: string; + durationInSeconds?: number; + endTime?: string; + farmerId: string; + id?: string; + lastActionDateTime?: string; + message?: string; + name?: string; + operations?: Array; + properties?: Record>; + startTime?: string; + startYear: number; + status?: string; +} // @public (undocumented) -export interface FarmOperationsCreateDataIngestionJobBodyParam { +export interface FarmOperationsCreateDataIngestionJob { + get(options?: FarmOperationsGetDataIngestionJobDetailsParameters): Promise; + put(options?: FarmOperationsCreateDataIngestionJobParameters): Promise; +} + +// @public +export interface FarmOperationsCreateDataIngestionJob202Response extends HttpResponse { // (undocumented) + body: FarmOperationDataIngestionJobOutput; + // (undocumented) + status: "202"; +} + +// @public (undocumented) +export interface FarmOperationsCreateDataIngestionJobBodyParam { body?: FarmOperationDataIngestionJob; } // @public export interface FarmOperationsCreateDataIngestionJobdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type FarmOperationsCreateDataIngestionJobParameters = RequestParameters & FarmOperationsCreateDataIngestionJobBodyParam; +export interface FarmOperationsCreateDataIngestionJobMediaTypesParam { + contentType?: "application/json"; +} // @public (undocumented) -export interface FarmOperationsGetDataIngestionJobDetails { - get(options?: FarmOperationsGetDataIngestionJobDetailsParameters): Promise; - put(options?: FarmOperationsCreateDataIngestionJobParameters): Promise; -} +export type FarmOperationsCreateDataIngestionJobParameters = FarmOperationsCreateDataIngestionJobMediaTypesParam & FarmOperationsCreateDataIngestionJobBodyParam & RequestParameters; // @public export interface FarmOperationsGetDataIngestionJobDetails200Response extends HttpResponse { // (undocumented) - body: FarmOperationDataIngestionJob; + body: FarmOperationDataIngestionJobOutput; // (undocumented) status: "200"; } @@ -1441,7 +1642,7 @@ export interface FarmOperationsGetDataIngestionJobDetails200Response extends Htt // @public export interface FarmOperationsGetDataIngestionJobDetailsdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -1450,18 +1651,22 @@ export interface FarmOperationsGetDataIngestionJobDetailsdefaultResponse extends export type FarmOperationsGetDataIngestionJobDetailsParameters = RequestParameters; // @public (undocumented) -export type FarmPropertiesDictionary = Record; - -// @public (undocumented) -export interface FarmsCreateCascadeDeleteJob { - get(options?: FarmsGetCascadeDeleteJobDetailsParameters): Promise; - put(options?: FarmsCreateCascadeDeleteJobParameters): Promise; +export interface FarmOutput { + createdDateTime?: string; + description?: string; + eTag?: string; + farmerId?: string; + id?: string; + modifiedDateTime?: string; + name?: string; + properties?: Record>; + status?: string; } // @public export interface FarmsCreateCascadeDeleteJob202Response extends HttpResponse { // (undocumented) - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; // (undocumented) status: "202"; } @@ -1469,13 +1674,13 @@ export interface FarmsCreateCascadeDeleteJob202Response extends HttpResponse { // @public export interface FarmsCreateCascadeDeleteJobdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type FarmsCreateCascadeDeleteJobParameters = RequestParameters & FarmsCreateCascadeDeleteJobQueryParam; +export type FarmsCreateCascadeDeleteJobParameters = FarmsCreateCascadeDeleteJobQueryParam & RequestParameters; // @public (undocumented) export interface FarmsCreateCascadeDeleteJobQueryParam { @@ -1492,7 +1697,7 @@ export interface FarmsCreateCascadeDeleteJobQueryParamProperties { // @public export interface FarmsCreateOrUpdate200Response extends HttpResponse { // (undocumented) - body: Farm; + body: FarmOutput; // (undocumented) status: "200"; } @@ -1500,37 +1705,36 @@ export interface FarmsCreateOrUpdate200Response extends HttpResponse { // @public export interface FarmsCreateOrUpdate201Response extends HttpResponse { // (undocumented) - body: Farm; + body: FarmOutput; // (undocumented) status: "201"; } // @public (undocumented) export interface FarmsCreateOrUpdateBodyParam { - // (undocumented) body?: Farm; } // @public export interface FarmsCreateOrUpdatedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type FarmsCreateOrUpdateParameters = RequestParameters & FarmsCreateOrUpdateBodyParam; +export interface FarmsCreateOrUpdateMediaTypesParam { + contentType?: "application/merge-patch+json"; +} // @public (undocumented) -export interface FarmsDelete { - delete(options?: FarmsDeleteParameters): Promise; - get(options?: FarmsGetParameters): Promise; - patch(options?: FarmsCreateOrUpdateParameters): Promise; -} +export type FarmsCreateOrUpdateParameters = FarmsCreateOrUpdateMediaTypesParam & FarmsCreateOrUpdateBodyParam & RequestParameters; // @public export interface FarmsDelete204Response extends HttpResponse { + // (undocumented) + body: Record; // (undocumented) status: "204"; } @@ -1538,7 +1742,7 @@ export interface FarmsDelete204Response extends HttpResponse { // @public export interface FarmsDeletedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -1546,18 +1750,31 @@ export interface FarmsDeletedefaultResponse extends HttpResponse { // @public (undocumented) export type FarmsDeleteParameters = RequestParameters; +// @public (undocumented) +export interface FarmsGet { + delete(options?: FarmsDeleteParameters): Promise; + get(options?: FarmsGetParameters): Promise; + patch(options?: FarmsCreateOrUpdateParameters): Promise; +} + // @public export interface FarmsGet200Response extends HttpResponse { // (undocumented) - body: Farm; + body: FarmOutput; // (undocumented) status: "200"; } +// @public (undocumented) +export interface FarmsGetCascadeDeleteJobDetails { + get(options?: FarmsGetCascadeDeleteJobDetailsParameters): Promise; + put(options: FarmsCreateCascadeDeleteJobParameters): Promise; +} + // @public export interface FarmsGetCascadeDeleteJobDetails200Response extends HttpResponse { // (undocumented) - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; // (undocumented) status: "200"; } @@ -1565,7 +1782,7 @@ export interface FarmsGetCascadeDeleteJobDetails200Response extends HttpResponse // @public export interface FarmsGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -1576,7 +1793,7 @@ export type FarmsGetCascadeDeleteJobDetailsParameters = RequestParameters; // @public export interface FarmsGetdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -1592,7 +1809,7 @@ export interface FarmsList { // @public export interface FarmsList200Response extends HttpResponse { // (undocumented) - body: FarmListResponse; + body: FarmListResponseOutput; // (undocumented) status: "200"; } @@ -1605,7 +1822,7 @@ export interface FarmsListByFarmerId { // @public export interface FarmsListByFarmerId200Response extends HttpResponse { // (undocumented) - body: FarmListResponse; + body: FarmListResponseOutput; // (undocumented) status: "200"; } @@ -1613,13 +1830,13 @@ export interface FarmsListByFarmerId200Response extends HttpResponse { // @public export interface FarmsListByFarmerIddefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type FarmsListByFarmerIdParameters = RequestParameters & FarmsListByFarmerIdQueryParam; +export type FarmsListByFarmerIdParameters = FarmsListByFarmerIdQueryParam & RequestParameters; // @public (undocumented) export interface FarmsListByFarmerIdQueryParam { @@ -1631,26 +1848,26 @@ export interface FarmsListByFarmerIdQueryParam { export interface FarmsListByFarmerIdQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - ids?: string[]; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - names?: string[]; - propertyFilters?: string[]; - statuses?: string[]; + ids?: Array; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + names?: Array; + propertyFilters?: Array; + statuses?: Array; } // @public export interface FarmsListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type FarmsListParameters = RequestParameters & FarmsListQueryParam; +export type FarmsListParameters = FarmsListQueryParam & RequestParameters; // @public (undocumented) export interface FarmsListQueryParam { @@ -1662,52 +1879,59 @@ export interface FarmsListQueryParam { export interface FarmsListQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - ids?: string[]; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - names?: string[]; - propertyFilters?: string[]; - statuses?: string[]; + ids?: Array; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + names?: Array; + propertyFilters?: Array; + statuses?: Array; } // @public (undocumented) export interface Field { - boundaryIds?: string[]; - createdDateTime?: Date; + boundaryIds?: Array; + createdDateTime?: Date | string; description?: string; eTag?: string; farmerId?: string; farmId?: string; id?: string; - modifiedDateTime?: Date; + modifiedDateTime?: Date | string; name?: string; primaryBoundaryId?: string; - properties?: FieldPropertiesDictionary; + properties?: Record>; status?: string; } // @public (undocumented) -export interface FieldListResponse { +export interface FieldListResponseOutput { + $skipToken?: string; nextLink?: string; - skipToken?: string; - value?: Field[]; + value?: Array; } // @public (undocumented) -export type FieldPropertiesDictionary = Record; - -// @public (undocumented) -export interface FieldsCreateCascadeDeleteJob { - get(options?: FieldsGetCascadeDeleteJobDetailsParameters): Promise; - put(options?: FieldsCreateCascadeDeleteJobParameters): Promise; +export interface FieldOutput { + boundaryIds?: Array; + createdDateTime?: string; + description?: string; + eTag?: string; + farmerId?: string; + farmId?: string; + id?: string; + modifiedDateTime?: string; + name?: string; + primaryBoundaryId?: string; + properties?: Record>; + status?: string; } // @public export interface FieldsCreateCascadeDeleteJob202Response extends HttpResponse { // (undocumented) - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; // (undocumented) status: "202"; } @@ -1715,13 +1939,13 @@ export interface FieldsCreateCascadeDeleteJob202Response extends HttpResponse { // @public export interface FieldsCreateCascadeDeleteJobdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type FieldsCreateCascadeDeleteJobParameters = RequestParameters & FieldsCreateCascadeDeleteJobQueryParam; +export type FieldsCreateCascadeDeleteJobParameters = FieldsCreateCascadeDeleteJobQueryParam & RequestParameters; // @public (undocumented) export interface FieldsCreateCascadeDeleteJobQueryParam { @@ -1738,7 +1962,7 @@ export interface FieldsCreateCascadeDeleteJobQueryParamProperties { // @public export interface FieldsCreateOrUpdate200Response extends HttpResponse { // (undocumented) - body: Field; + body: FieldOutput; // (undocumented) status: "200"; } @@ -1746,37 +1970,36 @@ export interface FieldsCreateOrUpdate200Response extends HttpResponse { // @public export interface FieldsCreateOrUpdate201Response extends HttpResponse { // (undocumented) - body: Field; + body: FieldOutput; // (undocumented) status: "201"; } // @public (undocumented) export interface FieldsCreateOrUpdateBodyParam { - // (undocumented) body?: Field; } // @public export interface FieldsCreateOrUpdatedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type FieldsCreateOrUpdateParameters = RequestParameters & FieldsCreateOrUpdateBodyParam; +export interface FieldsCreateOrUpdateMediaTypesParam { + contentType?: "application/merge-patch+json"; +} // @public (undocumented) -export interface FieldsDelete { - delete(options?: FieldsDeleteParameters): Promise; - get(options?: FieldsGetParameters): Promise; - patch(options?: FieldsCreateOrUpdateParameters): Promise; -} +export type FieldsCreateOrUpdateParameters = FieldsCreateOrUpdateMediaTypesParam & FieldsCreateOrUpdateBodyParam & RequestParameters; // @public export interface FieldsDelete204Response extends HttpResponse { + // (undocumented) + body: Record; // (undocumented) status: "204"; } @@ -1784,7 +2007,7 @@ export interface FieldsDelete204Response extends HttpResponse { // @public export interface FieldsDeletedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -1792,18 +2015,31 @@ export interface FieldsDeletedefaultResponse extends HttpResponse { // @public (undocumented) export type FieldsDeleteParameters = RequestParameters; +// @public (undocumented) +export interface FieldsGet { + delete(options?: FieldsDeleteParameters): Promise; + get(options?: FieldsGetParameters): Promise; + patch(options?: FieldsCreateOrUpdateParameters): Promise; +} + // @public export interface FieldsGet200Response extends HttpResponse { // (undocumented) - body: Field; + body: FieldOutput; // (undocumented) status: "200"; } +// @public (undocumented) +export interface FieldsGetCascadeDeleteJobDetails { + get(options?: FieldsGetCascadeDeleteJobDetailsParameters): Promise; + put(options: FieldsCreateCascadeDeleteJobParameters): Promise; +} + // @public export interface FieldsGetCascadeDeleteJobDetails200Response extends HttpResponse { // (undocumented) - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; // (undocumented) status: "200"; } @@ -1811,7 +2047,7 @@ export interface FieldsGetCascadeDeleteJobDetails200Response extends HttpRespons // @public export interface FieldsGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -1822,7 +2058,7 @@ export type FieldsGetCascadeDeleteJobDetailsParameters = RequestParameters; // @public export interface FieldsGetdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -1838,7 +2074,7 @@ export interface FieldsList { // @public export interface FieldsList200Response extends HttpResponse { // (undocumented) - body: FieldListResponse; + body: FieldListResponseOutput; // (undocumented) status: "200"; } @@ -1851,7 +2087,7 @@ export interface FieldsListByFarmerId { // @public export interface FieldsListByFarmerId200Response extends HttpResponse { // (undocumented) - body: FieldListResponse; + body: FieldListResponseOutput; // (undocumented) status: "200"; } @@ -1859,13 +2095,13 @@ export interface FieldsListByFarmerId200Response extends HttpResponse { // @public export interface FieldsListByFarmerIddefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type FieldsListByFarmerIdParameters = RequestParameters & FieldsListByFarmerIdQueryParam; +export type FieldsListByFarmerIdParameters = FieldsListByFarmerIdQueryParam & RequestParameters; // @public (undocumented) export interface FieldsListByFarmerIdQueryParam { @@ -1877,27 +2113,27 @@ export interface FieldsListByFarmerIdQueryParam { export interface FieldsListByFarmerIdQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - farmIds?: string[]; - ids?: string[]; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - names?: string[]; - propertyFilters?: string[]; - statuses?: string[]; + farmIds?: Array; + ids?: Array; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + names?: Array; + propertyFilters?: Array; + statuses?: Array; } // @public export interface FieldsListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type FieldsListParameters = RequestParameters & FieldsListQueryParam; +export type FieldsListParameters = FieldsListQueryParam & RequestParameters; // @public (undocumented) export interface FieldsListQueryParam { @@ -1909,28 +2145,46 @@ export interface FieldsListQueryParam { export interface FieldsListQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - farmIds?: string[]; - ids?: string[]; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - names?: string[]; - propertyFilters?: string[]; - statuses?: string[]; + farmIds?: Array; + ids?: Array; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + names?: Array; + propertyFilters?: Array; + statuses?: Array; +} + +// @public (undocumented) +export type GeoJsonObject = MultiPolygon | Point | Polygon; + +// @public (undocumented) +export interface GeoJsonObjectBase { + // (undocumented) + type: "MultiPolygon" | "Point" | "Polygon"; } // @public (undocumented) -export type GeoJsonObject = Polygon | MultiPolygon | Point; +export type GeoJsonObjectOutput = MultiPolygonOutput | PointOutput | PolygonOutput; // @public (undocumented) -export type GeoJsonObjectType = "Point" | "Polygon" | "MultiPolygon"; +export interface GeoJsonObjectOutputBase { + // (undocumented) + type: "MultiPolygon" | "Point" | "Polygon"; +} // @public export type GetArrayType = T extends Array ? TData : never; // @public -export function getPoller(client: FarmBeatsRestClient, initialResponse: TResult, options?: PollerOptions): PollerLike, TResult>; +export function getLongRunningPoller(client: Client, initialResponse: TResult, options?: LroEngineOptions>): PollerLike, TResult>; + +// @public +export type GetPage = (pageLink: string, maxPageSize?: number) => Promise<{ + page: TPage; + nextPageLink?: string; +}>; // @public (undocumented) export interface HarvestData { @@ -1941,29 +2195,60 @@ export interface HarvestData { avgSpeed?: Measure; avgWetMass?: Measure; avgYield?: Measure; - createdDateTime?: Date; + createdDateTime?: Date | string; description?: string; eTag?: string; farmerId?: string; - harvestProductDetails?: HarvestProductDetail[]; + harvestProductDetails?: Array; id?: string; - modifiedDateTime?: Date; + modifiedDateTime?: Date | string; name?: string; operationBoundaryId?: string; - operationEndDateTime?: Date; - operationModifiedDateTime?: Date; - operationStartDateTime?: Date; - properties?: HarvestDataPropertiesDictionary; + operationEndDateTime?: Date | string; + operationModifiedDateTime?: Date | string; + operationStartDateTime?: Date | string; + properties?: Record>; source?: string; status?: string; totalWetMass?: Measure; totalYield?: Measure; } +// @public +export interface HarvestDataCreateCascadeDeleteJob202Response extends HttpResponse { + // (undocumented) + body: CascadeDeleteJobOutput; + // (undocumented) + status: "202"; +} + +// @public +export interface HarvestDataCreateCascadeDeleteJobdefaultResponse extends HttpResponse { + // (undocumented) + body: ErrorResponseOutput; + // (undocumented) + status: "500"; +} + +// @public (undocumented) +export type HarvestDataCreateCascadeDeleteJobParameters = HarvestDataCreateCascadeDeleteJobQueryParam & RequestParameters; + +// @public (undocumented) +export interface HarvestDataCreateCascadeDeleteJobQueryParam { + // (undocumented) + queryParameters: HarvestDataCreateCascadeDeleteJobQueryParamProperties; +} + +// @public (undocumented) +export interface HarvestDataCreateCascadeDeleteJobQueryParamProperties { + farmerId: string; + harvestDataId: string; +} + // @public export interface HarvestDataCreateOrUpdate200Response extends HttpResponse { // (undocumented) - body: HarvestData; + body: HarvestDataOutput; // (undocumented) status: "200"; } @@ -1971,37 +2256,36 @@ export interface HarvestDataCreateOrUpdate200Response extends HttpResponse { // @public export interface HarvestDataCreateOrUpdate201Response extends HttpResponse { // (undocumented) - body: HarvestData; + body: HarvestDataOutput; // (undocumented) status: "201"; } // @public (undocumented) export interface HarvestDataCreateOrUpdateBodyParam { - // (undocumented) body?: HarvestData; } // @public export interface HarvestDataCreateOrUpdatedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type HarvestDataCreateOrUpdateParameters = RequestParameters & HarvestDataCreateOrUpdateBodyParam; +export interface HarvestDataCreateOrUpdateMediaTypesParam { + contentType?: "application/merge-patch+json"; +} // @public (undocumented) -export interface HarvestDataDelete { - delete(options?: HarvestDataDeleteParameters): Promise; - get(options?: HarvestDataGetParameters): Promise; - patch(options?: HarvestDataCreateOrUpdateParameters): Promise; -} +export type HarvestDataCreateOrUpdateParameters = HarvestDataCreateOrUpdateMediaTypesParam & HarvestDataCreateOrUpdateBodyParam & RequestParameters; // @public export interface HarvestDataDelete204Response extends HttpResponse { + // (undocumented) + body: Record; // (undocumented) status: "204"; } @@ -2009,7 +2293,7 @@ export interface HarvestDataDelete204Response extends HttpResponse { // @public export interface HarvestDataDeletedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -2017,18 +2301,50 @@ export interface HarvestDataDeletedefaultResponse extends HttpResponse { // @public (undocumented) export type HarvestDataDeleteParameters = RequestParameters; +// @public (undocumented) +export interface HarvestDataGet { + delete(options?: HarvestDataDeleteParameters): Promise; + get(options?: HarvestDataGetParameters): Promise; + patch(options?: HarvestDataCreateOrUpdateParameters): Promise; +} + // @public export interface HarvestDataGet200Response extends HttpResponse { // (undocumented) - body: HarvestData; + body: HarvestDataOutput; + // (undocumented) + status: "200"; +} + +// @public (undocumented) +export interface HarvestDataGetCascadeDeleteJobDetails { + get(options?: HarvestDataGetCascadeDeleteJobDetailsParameters): Promise; + put(options: HarvestDataCreateCascadeDeleteJobParameters): Promise; +} + +// @public +export interface HarvestDataGetCascadeDeleteJobDetails200Response extends HttpResponse { + // (undocumented) + body: CascadeDeleteJobOutput; // (undocumented) status: "200"; } +// @public +export interface HarvestDataGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { + // (undocumented) + body: ErrorResponseOutput; + // (undocumented) + status: "500"; +} + +// @public (undocumented) +export type HarvestDataGetCascadeDeleteJobDetailsParameters = RequestParameters; + // @public export interface HarvestDataGetdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -2044,7 +2360,7 @@ export interface HarvestDataList { // @public export interface HarvestDataList200Response extends HttpResponse { // (undocumented) - body: HarvestDataListResponse; + body: HarvestDataListResponseOutput; // (undocumented) status: "200"; } @@ -2057,7 +2373,7 @@ export interface HarvestDataListByFarmerId { // @public export interface HarvestDataListByFarmerId200Response extends HttpResponse { // (undocumented) - body: HarvestDataListResponse; + body: HarvestDataListResponseOutput; // (undocumented) status: "200"; } @@ -2065,13 +2381,13 @@ export interface HarvestDataListByFarmerId200Response extends HttpResponse { // @public export interface HarvestDataListByFarmerIddefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type HarvestDataListByFarmerIdParameters = RequestParameters & HarvestDataListByFarmerIdQueryParam; +export type HarvestDataListByFarmerIdParameters = HarvestDataListByFarmerIdQueryParam & RequestParameters; // @public (undocumented) export interface HarvestDataListByFarmerIdQueryParam { @@ -2083,18 +2399,18 @@ export interface HarvestDataListByFarmerIdQueryParam { export interface HarvestDataListByFarmerIdQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - associatedBoundaryIds?: string[]; - ids?: string[]; + associatedBoundaryIds?: Array; + ids?: Array; maxArea?: number; maxAvgMoisture?: number; maxAvgSpeed?: number; maxAvgWetMass?: number; maxAvgYield?: number; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - maxOperationEndDateTime?: Date; - maxOperationModifiedDateTime?: Date; - maxOperationStartDateTime?: Date; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + maxOperationEndDateTime?: Date | string; + maxOperationModifiedDateTime?: Date | string; + maxOperationStartDateTime?: Date | string; maxTotalWetMass?: number; maxTotalYield?: number; minArea?: number; @@ -2102,30 +2418,30 @@ export interface HarvestDataListByFarmerIdQueryParamProperties { minAvgSpeed?: number; minAvgWetMass?: number; minAvgYield?: number; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - minOperationEndDateTime?: Date; - minOperationModifiedDateTime?: Date; - minOperationStartDateTime?: Date; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + minOperationEndDateTime?: Date | string; + minOperationModifiedDateTime?: Date | string; + minOperationStartDateTime?: Date | string; minTotalWetMass?: number; minTotalYield?: number; - names?: string[]; - operationBoundaryIds?: string[]; - propertyFilters?: string[]; - sources?: string[]; - statuses?: string[]; + names?: Array; + operationBoundaryIds?: Array; + propertyFilters?: Array; + sources?: Array; + statuses?: Array; } // @public export interface HarvestDataListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type HarvestDataListParameters = RequestParameters & HarvestDataListQueryParam; +export type HarvestDataListParameters = HarvestDataListQueryParam & RequestParameters; // @public (undocumented) export interface HarvestDataListQueryParam { @@ -2137,18 +2453,18 @@ export interface HarvestDataListQueryParam { export interface HarvestDataListQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - associatedBoundaryIds?: string[]; - ids?: string[]; + associatedBoundaryIds?: Array; + ids?: Array; maxArea?: number; maxAvgMoisture?: number; maxAvgSpeed?: number; maxAvgWetMass?: number; maxAvgYield?: number; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - maxOperationEndDateTime?: Date; - maxOperationModifiedDateTime?: Date; - maxOperationStartDateTime?: Date; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + maxOperationEndDateTime?: Date | string; + maxOperationModifiedDateTime?: Date | string; + maxOperationStartDateTime?: Date | string; maxTotalWetMass?: number; maxTotalYield?: number; minArea?: number; @@ -2156,29 +2472,54 @@ export interface HarvestDataListQueryParamProperties { minAvgSpeed?: number; minAvgWetMass?: number; minAvgYield?: number; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - minOperationEndDateTime?: Date; - minOperationModifiedDateTime?: Date; - minOperationStartDateTime?: Date; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + minOperationEndDateTime?: Date | string; + minOperationModifiedDateTime?: Date | string; + minOperationStartDateTime?: Date | string; minTotalWetMass?: number; minTotalYield?: number; - names?: string[]; - operationBoundaryIds?: string[]; - propertyFilters?: string[]; - sources?: string[]; - statuses?: string[]; + names?: Array; + operationBoundaryIds?: Array; + propertyFilters?: Array; + sources?: Array; + statuses?: Array; } // @public (undocumented) -export interface HarvestDataListResponse { +export interface HarvestDataListResponseOutput { + $skipToken?: string; nextLink?: string; - skipToken?: string; - value?: HarvestData[]; + value?: Array; } // @public (undocumented) -export type HarvestDataPropertiesDictionary = Record; +export interface HarvestDataOutput { + area?: MeasureOutput; + associatedBoundaryId?: string; + attachmentsLink?: string; + avgMoisture?: MeasureOutput; + avgSpeed?: MeasureOutput; + avgWetMass?: MeasureOutput; + avgYield?: MeasureOutput; + createdDateTime?: string; + description?: string; + eTag?: string; + farmerId?: string; + harvestProductDetails?: Array; + id?: string; + modifiedDateTime?: string; + name?: string; + operationBoundaryId?: string; + operationEndDateTime?: string; + operationModifiedDateTime?: string; + operationStartDateTime?: string; + properties?: Record>; + source?: string; + status?: string; + totalWetMass?: MeasureOutput; + totalYield?: MeasureOutput; +} // @public (undocumented) export interface HarvestProductDetail { @@ -2192,49 +2533,63 @@ export interface HarvestProductDetail { } // @public (undocumented) -export interface ImageFile { +export interface HarvestProductDetailOutput { + area?: MeasureOutput; + avgMoisture?: MeasureOutput; + avgWetMass?: MeasureOutput; + avgYield?: MeasureOutput; + productName?: string; + totalWetMass?: MeasureOutput; + totalYield?: MeasureOutput; +} + +// @public (undocumented) +export interface ImageFileOutput { fileLink?: string; - imageFormat?: ImageFormat; + imageFormat?: "TIF"; name: string; resolution?: number; } // @public (undocumented) -export type ImageFormat = "TIF"; +export interface ImageProcessingCreateRasterizeJob { + get(options?: ImageProcessingGetRasterizeJobParameters): Promise; + put(options?: ImageProcessingCreateRasterizeJobParameters): Promise; +} // @public export interface ImageProcessingCreateRasterizeJob202Response extends HttpResponse { // (undocumented) - body: ImageProcessingRasterizeJob; + body: ImageProcessingRasterizeJobOutput; // (undocumented) status: "202"; } // @public (undocumented) export interface ImageProcessingCreateRasterizeJobBodyParam { - // (undocumented) body?: ImageProcessingRasterizeJob; } // @public export interface ImageProcessingCreateRasterizeJobdefaultResponse extends HttpResponse { + // (undocumented) + body: Record; // (undocumented) status: "500"; } // @public (undocumented) -export type ImageProcessingCreateRasterizeJobParameters = RequestParameters & ImageProcessingCreateRasterizeJobBodyParam; +export interface ImageProcessingCreateRasterizeJobMediaTypesParam { + contentType?: "application/json"; +} // @public (undocumented) -export interface ImageProcessingGetRasterizeJob { - get(options?: ImageProcessingGetRasterizeJobParameters): Promise; - put(options?: ImageProcessingCreateRasterizeJobParameters): Promise; -} +export type ImageProcessingCreateRasterizeJobParameters = ImageProcessingCreateRasterizeJobMediaTypesParam & ImageProcessingCreateRasterizeJobBodyParam & RequestParameters; // @public export interface ImageProcessingGetRasterizeJob200Response extends HttpResponse { // (undocumented) - body: ImageProcessingRasterizeJob; + body: ImageProcessingRasterizeJobOutput; // (undocumented) status: "200"; } @@ -2244,39 +2599,48 @@ export type ImageProcessingGetRasterizeJobParameters = RequestParameters; // @public (undocumented) export interface ImageProcessingRasterizeJob { - createdDateTime?: Date; + createdDateTime?: Date | string; description?: string; durationInSeconds?: number; - endTime?: Date; + endTime?: Date | string; farmerId: string; id?: string; - lastActionDateTime?: Date; + lastActionDateTime?: Date | string; message?: string; name?: string; - properties?: ImageProcessingRasterizeJobPropertiesDictionary; + properties?: Record>; shapefileAttachmentId: string; - shapefileColumnNames: string[]; - startTime?: Date; + shapefileColumnNames: Array; + startTime?: Date | string; status?: string; } // @public (undocumented) -export type ImageProcessingRasterizeJobPropertiesDictionary = Record; - -// @public (undocumented) -export type InnerError = InnerErrorBase & InnerErrorDictionary; +export interface ImageProcessingRasterizeJobOutput { + createdDateTime?: string; + description?: string; + durationInSeconds?: number; + endTime?: string; + farmerId: string; + id?: string; + lastActionDateTime?: string; + message?: string; + name?: string; + properties?: Record>; + shapefileAttachmentId: string; + shapefileColumnNames: Array; + startTime?: string; + status?: string; +} // @public (undocumented) -export interface InnerErrorBase { +export interface InnerErrorOutput extends Record { code?: string; - innererror?: InnerError; + innererror?: InnerErrorOutput; } // @public (undocumented) -export type InnerErrorDictionary = Record; - -// @public (undocumented) -export interface Location { +export interface LocationOutput { latitude: number; longitude: number; } @@ -2288,17 +2652,31 @@ export interface Measure { } // @public (undocumented) -export type MultiPolygon = MultiPolygonBase & MultiPolygonCoordinates & { - type: "MultiPolygon"; -}; +export interface MeasureOutput { + unit?: string; + value?: number; +} // @public (undocumented) -export interface MultiPolygonBase { +export interface MultiPolygon extends GeoJsonObjectBase, MultiPolygonCoordinates { + // (undocumented) + type: "MultiPolygon"; } // @public (undocumented) export interface MultiPolygonCoordinates { - coordinates: number[][][][]; + coordinates: Array>>>; +} + +// @public (undocumented) +export interface MultiPolygonCoordinatesOutput { + coordinates: Array>>>; +} + +// @public (undocumented) +export interface MultiPolygonOutput extends GeoJsonObjectOutputBase, MultiPolygonCoordinatesOutput { + // (undocumented) + type: "MultiPolygon"; } // @public (undocumented) @@ -2314,30 +2692,88 @@ export interface OAuthProvider { apiKey?: string; appId?: string; appSecret?: string; - createdDateTime?: Date; + createdDateTime?: Date | string; description?: string; eTag?: string; id?: string; isProductionApp?: boolean; - modifiedDateTime?: Date; + modifiedDateTime?: Date | string; + name?: string; + properties?: Record>; +} + +// @public (undocumented) +export interface OAuthProviderCascadeDeleteJobOutput { + createdDateTime?: string; + description?: string; + durationInSeconds?: number; + endTime?: string; + id?: string; + lastActionDateTime?: string; + message?: string; name?: string; - properties?: OAuthProviderPropertiesDictionary; + oauthProviderId: string; + properties?: Record>; + startTime?: string; + status?: string; } // @public (undocumented) -export interface OAuthProviderListResponse { +export interface OAuthProviderListResponseOutput { + $skipToken?: string; nextLink?: string; - skipToken?: string; - value?: OAuthProvider[]; + value?: Array; +} + +// @public (undocumented) +export interface OAuthProviderOutput { + apiKey?: string; + appId?: string; + appSecret?: string; + createdDateTime?: string; + description?: string; + eTag?: string; + id?: string; + isProductionApp?: boolean; + modifiedDateTime?: string; + name?: string; + properties?: Record>; +} + +// @public +export interface OAuthProvidersCreateCascadeDeleteJob202Response extends HttpResponse { + // (undocumented) + body: OAuthProviderCascadeDeleteJobOutput; + // (undocumented) + status: "202"; +} + +// @public +export interface OAuthProvidersCreateCascadeDeleteJobdefaultResponse extends HttpResponse { + // (undocumented) + body: ErrorResponseOutput; + // (undocumented) + status: "500"; +} + +// @public (undocumented) +export type OAuthProvidersCreateCascadeDeleteJobParameters = OAuthProvidersCreateCascadeDeleteJobQueryParam & RequestParameters; + +// @public (undocumented) +export interface OAuthProvidersCreateCascadeDeleteJobQueryParam { + // (undocumented) + queryParameters: OAuthProvidersCreateCascadeDeleteJobQueryParamProperties; } // @public (undocumented) -export type OAuthProviderPropertiesDictionary = Record; +export interface OAuthProvidersCreateCascadeDeleteJobQueryParamProperties { + oauthProviderId: string; +} // @public export interface OAuthProvidersCreateOrUpdate200Response extends HttpResponse { // (undocumented) - body: OAuthProvider; + body: OAuthProviderOutput; // (undocumented) status: "200"; } @@ -2345,37 +2781,36 @@ export interface OAuthProvidersCreateOrUpdate200Response extends HttpResponse { // @public export interface OAuthProvidersCreateOrUpdate201Response extends HttpResponse { // (undocumented) - body: OAuthProvider; + body: OAuthProviderOutput; // (undocumented) status: "201"; } // @public (undocumented) export interface OAuthProvidersCreateOrUpdateBodyParam { - // (undocumented) body?: OAuthProvider; } // @public export interface OAuthProvidersCreateOrUpdatedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type OAuthProvidersCreateOrUpdateParameters = RequestParameters & OAuthProvidersCreateOrUpdateBodyParam; +export interface OAuthProvidersCreateOrUpdateMediaTypesParam { + contentType?: "application/merge-patch+json"; +} // @public (undocumented) -export interface OAuthProvidersDelete { - delete(options?: OAuthProvidersDeleteParameters): Promise; - get(options?: OAuthProvidersGetParameters): Promise; - patch(options?: OAuthProvidersCreateOrUpdateParameters): Promise; -} +export type OAuthProvidersCreateOrUpdateParameters = OAuthProvidersCreateOrUpdateMediaTypesParam & OAuthProvidersCreateOrUpdateBodyParam & RequestParameters; // @public export interface OAuthProvidersDelete204Response extends HttpResponse { + // (undocumented) + body: Record; // (undocumented) status: "204"; } @@ -2383,7 +2818,7 @@ export interface OAuthProvidersDelete204Response extends HttpResponse { // @public export interface OAuthProvidersDeletedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -2391,18 +2826,50 @@ export interface OAuthProvidersDeletedefaultResponse extends HttpResponse { // @public (undocumented) export type OAuthProvidersDeleteParameters = RequestParameters; +// @public (undocumented) +export interface OAuthProvidersGet { + delete(options?: OAuthProvidersDeleteParameters): Promise; + get(options?: OAuthProvidersGetParameters): Promise; + patch(options?: OAuthProvidersCreateOrUpdateParameters): Promise; +} + // @public export interface OAuthProvidersGet200Response extends HttpResponse { // (undocumented) - body: OAuthProvider; + body: OAuthProviderOutput; // (undocumented) status: "200"; } +// @public (undocumented) +export interface OAuthProvidersGetCascadeDeleteJobDetails { + get(options?: OAuthProvidersGetCascadeDeleteJobDetailsParameters): Promise; + put(options: OAuthProvidersCreateCascadeDeleteJobParameters): Promise; +} + +// @public +export interface OAuthProvidersGetCascadeDeleteJobDetails200Response extends HttpResponse { + // (undocumented) + body: OAuthProviderCascadeDeleteJobOutput; + // (undocumented) + status: "200"; +} + +// @public +export interface OAuthProvidersGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { + // (undocumented) + body: ErrorResponseOutput; + // (undocumented) + status: "500"; +} + +// @public (undocumented) +export type OAuthProvidersGetCascadeDeleteJobDetailsParameters = RequestParameters; + // @public export interface OAuthProvidersGetdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -2418,7 +2885,7 @@ export interface OAuthProvidersList { // @public export interface OAuthProvidersList200Response extends HttpResponse { // (undocumented) - body: OAuthProviderListResponse; + body: OAuthProviderListResponseOutput; // (undocumented) status: "200"; } @@ -2426,13 +2893,13 @@ export interface OAuthProvidersList200Response extends HttpResponse { // @public export interface OAuthProvidersListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type OAuthProvidersListParameters = RequestParameters & OAuthProvidersListQueryParam; +export type OAuthProvidersListParameters = OAuthProvidersListQueryParam & RequestParameters; // @public (undocumented) export interface OAuthProvidersListQueryParam { @@ -2444,43 +2911,37 @@ export interface OAuthProvidersListQueryParam { export interface OAuthProvidersListQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - ids?: string[]; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - names?: string[]; - propertyFilters?: string[]; - statuses?: string[]; -} - -// @public (undocumented) -export interface OAuthToken { - authProviderId: string; - createdDateTime?: Date; - eTag?: string; - farmerId: string; - isValid?: boolean; - modifiedDateTime?: Date; + ids?: Array; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + names?: Array; + propertyFilters?: Array; + statuses?: Array; } // @public (undocumented) -export interface OAuthTokenListResponse { +export interface OAuthTokenListResponseOutput { + $skipToken?: string; nextLink?: string; - skipToken?: string; - value?: OAuthToken[]; + value?: Array; } // @public (undocumented) -export interface OAuthTokensCreateCascadeDeleteJob { - get(options?: OAuthTokensGetCascadeDeleteJobDetailsParameters): Promise; - put(options?: OAuthTokensCreateCascadeDeleteJobParameters): Promise; +export interface OAuthTokenOutput { + authProviderId: string; + createdDateTime?: string; + eTag?: string; + farmerId: string; + isValid?: boolean; + modifiedDateTime?: string; } // @public export interface OAuthTokensCreateCascadeDeleteJob202Response extends HttpResponse { // (undocumented) - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; // (undocumented) status: "202"; } @@ -2488,13 +2949,13 @@ export interface OAuthTokensCreateCascadeDeleteJob202Response extends HttpRespon // @public export interface OAuthTokensCreateCascadeDeleteJobdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type OAuthTokensCreateCascadeDeleteJobParameters = RequestParameters & OAuthTokensCreateCascadeDeleteJobQueryParam; +export type OAuthTokensCreateCascadeDeleteJobParameters = OAuthTokensCreateCascadeDeleteJobQueryParam & RequestParameters; // @public (undocumented) export interface OAuthTokensCreateCascadeDeleteJobQueryParam { @@ -2508,10 +2969,16 @@ export interface OAuthTokensCreateCascadeDeleteJobQueryParamProperties { oauthProviderId: string; } +// @public (undocumented) +export interface OAuthTokensGetCascadeDeleteJobDetails { + get(options?: OAuthTokensGetCascadeDeleteJobDetailsParameters): Promise; + put(options: OAuthTokensCreateCascadeDeleteJobParameters): Promise; +} + // @public export interface OAuthTokensGetCascadeDeleteJobDetails200Response extends HttpResponse { // (undocumented) - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; // (undocumented) status: "200"; } @@ -2519,7 +2986,7 @@ export interface OAuthTokensGetCascadeDeleteJobDetails200Response extends HttpRe // @public export interface OAuthTokensGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -2542,20 +3009,24 @@ export interface OAuthTokensGetOAuthConnectionLink200Response extends HttpRespon // @public (undocumented) export interface OAuthTokensGetOAuthConnectionLinkBodyParam { - // (undocumented) body?: OAuthConnectRequest; } // @public export interface OAuthTokensGetOAuthConnectionLinkdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type OAuthTokensGetOAuthConnectionLinkParameters = RequestParameters & OAuthTokensGetOAuthConnectionLinkBodyParam; +export interface OAuthTokensGetOAuthConnectionLinkMediaTypesParam { + contentType?: "application/json"; +} + +// @public (undocumented) +export type OAuthTokensGetOAuthConnectionLinkParameters = OAuthTokensGetOAuthConnectionLinkMediaTypesParam & OAuthTokensGetOAuthConnectionLinkBodyParam & RequestParameters; // @public (undocumented) export interface OAuthTokensList { @@ -2565,7 +3036,7 @@ export interface OAuthTokensList { // @public export interface OAuthTokensList200Response extends HttpResponse { // (undocumented) - body: OAuthTokenListResponse; + body: OAuthTokenListResponseOutput; // (undocumented) status: "200"; } @@ -2573,13 +3044,13 @@ export interface OAuthTokensList200Response extends HttpResponse { // @public export interface OAuthTokensListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type OAuthTokensListParameters = RequestParameters & OAuthTokensListQueryParam; +export type OAuthTokensListParameters = OAuthTokensListQueryParam & RequestParameters; // @public (undocumented) export interface OAuthTokensListQueryParam { @@ -2591,17 +3062,17 @@ export interface OAuthTokensListQueryParam { export interface OAuthTokensListQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - authProviderIds?: string[]; - farmerIds?: string[]; + authProviderIds?: Array; + farmerIds?: Array; isValid?: boolean; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; } // @public -export function paginate(client: Client, initialResponse: TReturn): PagedAsyncIterableIterator, PaginateReturn[]>; +export function paginate(client: Client, initialResponse: TResponse, options?: PagingOptions): PagedAsyncIterableIterator>; // @public export type PaginateReturn = TResult extends { @@ -2610,20 +3081,9 @@ export type PaginateReturn = TResult extends { }; } ? GetArrayType : Array; -// @public (undocumented) -export interface Paths1LxjoxzFarmersFarmeridAttachmentsAttachmentidPatchRequestbodyContentMultipartFormDataSchema { - createdDateTime?: string; - description?: string; - eTag?: string; - farmerId?: string; - file?: string; - id?: string; - modifiedDateTime?: string; - name?: string; - originalFileName?: string; - resourceId?: string; - resourceType?: string; - status?: string; +// @public +export interface PagingOptions { + customGetPage?: GetPage[]>; } // @public (undocumented) @@ -2633,28 +3093,59 @@ export interface PlantingData { attachmentsLink?: string; avgMaterial?: Measure; avgPlantingRate?: Measure; - createdDateTime?: Date; + createdDateTime?: Date | string; description?: string; eTag?: string; farmerId?: string; id?: string; - modifiedDateTime?: Date; + modifiedDateTime?: Date | string; name?: string; operationBoundaryId?: string; - operationEndDateTime?: Date; - operationModifiedDateTime?: Date; - operationStartDateTime?: Date; - plantingProductDetails?: PlantingProductDetail[]; - properties?: PlantingDataPropertiesDictionary; + operationEndDateTime?: Date | string; + operationModifiedDateTime?: Date | string; + operationStartDateTime?: Date | string; + plantingProductDetails?: Array; + properties?: Record>; source?: string; status?: string; totalMaterial?: Measure; } +// @public +export interface PlantingDataCreateCascadeDeleteJob202Response extends HttpResponse { + // (undocumented) + body: CascadeDeleteJobOutput; + // (undocumented) + status: "202"; +} + +// @public +export interface PlantingDataCreateCascadeDeleteJobdefaultResponse extends HttpResponse { + // (undocumented) + body: ErrorResponseOutput; + // (undocumented) + status: "500"; +} + +// @public (undocumented) +export type PlantingDataCreateCascadeDeleteJobParameters = PlantingDataCreateCascadeDeleteJobQueryParam & RequestParameters; + +// @public (undocumented) +export interface PlantingDataCreateCascadeDeleteJobQueryParam { + // (undocumented) + queryParameters: PlantingDataCreateCascadeDeleteJobQueryParamProperties; +} + +// @public (undocumented) +export interface PlantingDataCreateCascadeDeleteJobQueryParamProperties { + farmerId: string; + plantingDataId: string; +} + // @public export interface PlantingDataCreateOrUpdate200Response extends HttpResponse { // (undocumented) - body: PlantingData; + body: PlantingDataOutput; // (undocumented) status: "200"; } @@ -2662,37 +3153,36 @@ export interface PlantingDataCreateOrUpdate200Response extends HttpResponse { // @public export interface PlantingDataCreateOrUpdate201Response extends HttpResponse { // (undocumented) - body: PlantingData; + body: PlantingDataOutput; // (undocumented) status: "201"; } // @public (undocumented) export interface PlantingDataCreateOrUpdateBodyParam { - // (undocumented) body?: PlantingData; } // @public export interface PlantingDataCreateOrUpdatedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type PlantingDataCreateOrUpdateParameters = RequestParameters & PlantingDataCreateOrUpdateBodyParam; +export interface PlantingDataCreateOrUpdateMediaTypesParam { + contentType?: "application/merge-patch+json"; +} // @public (undocumented) -export interface PlantingDataDelete { - delete(options?: PlantingDataDeleteParameters): Promise; - get(options?: PlantingDataGetParameters): Promise; - patch(options?: PlantingDataCreateOrUpdateParameters): Promise; -} +export type PlantingDataCreateOrUpdateParameters = PlantingDataCreateOrUpdateMediaTypesParam & PlantingDataCreateOrUpdateBodyParam & RequestParameters; // @public export interface PlantingDataDelete204Response extends HttpResponse { + // (undocumented) + body: Record; // (undocumented) status: "204"; } @@ -2700,7 +3190,7 @@ export interface PlantingDataDelete204Response extends HttpResponse { // @public export interface PlantingDataDeletedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -2708,18 +3198,50 @@ export interface PlantingDataDeletedefaultResponse extends HttpResponse { // @public (undocumented) export type PlantingDataDeleteParameters = RequestParameters; +// @public (undocumented) +export interface PlantingDataGet { + delete(options?: PlantingDataDeleteParameters): Promise; + get(options?: PlantingDataGetParameters): Promise; + patch(options?: PlantingDataCreateOrUpdateParameters): Promise; +} + // @public export interface PlantingDataGet200Response extends HttpResponse { // (undocumented) - body: PlantingData; + body: PlantingDataOutput; // (undocumented) status: "200"; } +// @public (undocumented) +export interface PlantingDataGetCascadeDeleteJobDetails { + get(options?: PlantingDataGetCascadeDeleteJobDetailsParameters): Promise; + put(options: PlantingDataCreateCascadeDeleteJobParameters): Promise; +} + +// @public +export interface PlantingDataGetCascadeDeleteJobDetails200Response extends HttpResponse { + // (undocumented) + body: CascadeDeleteJobOutput; + // (undocumented) + status: "200"; +} + +// @public +export interface PlantingDataGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { + // (undocumented) + body: ErrorResponseOutput; + // (undocumented) + status: "500"; +} + +// @public (undocumented) +export type PlantingDataGetCascadeDeleteJobDetailsParameters = RequestParameters; + // @public export interface PlantingDataGetdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -2735,7 +3257,7 @@ export interface PlantingDataList { // @public export interface PlantingDataList200Response extends HttpResponse { // (undocumented) - body: PlantingDataListResponse; + body: PlantingDataListResponseOutput; // (undocumented) status: "200"; } @@ -2748,7 +3270,7 @@ export interface PlantingDataListByFarmerId { // @public export interface PlantingDataListByFarmerId200Response extends HttpResponse { // (undocumented) - body: PlantingDataListResponse; + body: PlantingDataListResponseOutput; // (undocumented) status: "200"; } @@ -2756,13 +3278,13 @@ export interface PlantingDataListByFarmerId200Response extends HttpResponse { // @public export interface PlantingDataListByFarmerIddefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type PlantingDataListByFarmerIdParameters = RequestParameters & PlantingDataListByFarmerIdQueryParam; +export type PlantingDataListByFarmerIdParameters = PlantingDataListByFarmerIdQueryParam & RequestParameters; // @public (undocumented) export interface PlantingDataListByFarmerIdQueryParam { @@ -2774,43 +3296,43 @@ export interface PlantingDataListByFarmerIdQueryParam { export interface PlantingDataListByFarmerIdQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - associatedBoundaryIds?: string[]; - ids?: string[]; + associatedBoundaryIds?: Array; + ids?: Array; maxArea?: number; maxAvgMaterial?: number; maxAvgPlantingRate?: number; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - maxOperationEndDateTime?: Date; - maxOperationModifiedDateTime?: Date; - maxOperationStartDateTime?: Date; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + maxOperationEndDateTime?: Date | string; + maxOperationModifiedDateTime?: Date | string; + maxOperationStartDateTime?: Date | string; maxTotalMaterial?: number; minArea?: number; minAvgMaterial?: number; minAvgPlantingRate?: number; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - minOperationEndDateTime?: Date; - minOperationModifiedDateTime?: Date; - minOperationStartDateTime?: Date; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + minOperationEndDateTime?: Date | string; + minOperationModifiedDateTime?: Date | string; + minOperationStartDateTime?: Date | string; minTotalMaterial?: number; - names?: string[]; - operationBoundaryIds?: string[]; - propertyFilters?: string[]; - sources?: string[]; - statuses?: string[]; + names?: Array; + operationBoundaryIds?: Array; + propertyFilters?: Array; + sources?: Array; + statuses?: Array; } // @public export interface PlantingDataListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type PlantingDataListParameters = RequestParameters & PlantingDataListQueryParam; +export type PlantingDataListParameters = PlantingDataListQueryParam & RequestParameters; // @public (undocumented) export interface PlantingDataListQueryParam { @@ -2822,43 +3344,65 @@ export interface PlantingDataListQueryParam { export interface PlantingDataListQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - associatedBoundaryIds?: string[]; - ids?: string[]; + associatedBoundaryIds?: Array; + ids?: Array; maxArea?: number; maxAvgMaterial?: number; maxAvgPlantingRate?: number; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - maxOperationEndDateTime?: Date; - maxOperationModifiedDateTime?: Date; - maxOperationStartDateTime?: Date; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + maxOperationEndDateTime?: Date | string; + maxOperationModifiedDateTime?: Date | string; + maxOperationStartDateTime?: Date | string; maxTotalMaterial?: number; minArea?: number; minAvgMaterial?: number; minAvgPlantingRate?: number; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - minOperationEndDateTime?: Date; - minOperationModifiedDateTime?: Date; - minOperationStartDateTime?: Date; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + minOperationEndDateTime?: Date | string; + minOperationModifiedDateTime?: Date | string; + minOperationStartDateTime?: Date | string; minTotalMaterial?: number; - names?: string[]; - operationBoundaryIds?: string[]; - propertyFilters?: string[]; - sources?: string[]; - statuses?: string[]; + names?: Array; + operationBoundaryIds?: Array; + propertyFilters?: Array; + sources?: Array; + statuses?: Array; } // @public (undocumented) -export interface PlantingDataListResponse { +export interface PlantingDataListResponseOutput { + $skipToken?: string; nextLink?: string; - skipToken?: string; - value?: PlantingData[]; + value?: Array; +} + +// @public (undocumented) +export interface PlantingDataOutput { + area?: MeasureOutput; + associatedBoundaryId?: string; + attachmentsLink?: string; + avgMaterial?: MeasureOutput; + avgPlantingRate?: MeasureOutput; + createdDateTime?: string; + description?: string; + eTag?: string; + farmerId?: string; + id?: string; + modifiedDateTime?: string; + name?: string; + operationBoundaryId?: string; + operationEndDateTime?: string; + operationModifiedDateTime?: string; + operationStartDateTime?: string; + plantingProductDetails?: Array; + properties?: Record>; + source?: string; + status?: string; + totalMaterial?: MeasureOutput; } -// @public (undocumented) -export type PlantingDataPropertiesDictionary = Record; - // @public (undocumented) export interface PlantingProductDetail { area?: Measure; @@ -2868,179 +3412,245 @@ export interface PlantingProductDetail { } // @public (undocumented) -export type Point = PointBase & PointCoordinates & { - type: "Point"; -}; +export interface PlantingProductDetailOutput { + area?: MeasureOutput; + avgMaterial?: MeasureOutput; + productName?: string; + totalMaterial?: MeasureOutput; +} // @public (undocumented) -export interface PointBase { +export interface Point extends GeoJsonObjectBase, PointCoordinates { + // (undocumented) + type: "Point"; } // @public (undocumented) export interface PointCoordinates { - coordinates: number[]; + coordinates: Array; } // @public (undocumented) -export type Polygon = PolygonBase & PolygonCoordinates & { - type: "Polygon"; -}; +export interface PointCoordinatesOutput { + coordinates: Array; +} + +// @public (undocumented) +export interface PointOutput extends GeoJsonObjectOutputBase, PointCoordinatesOutput { + // (undocumented) + type: "Point"; +} // @public (undocumented) -export interface PolygonBase { +export interface Polygon extends GeoJsonObjectBase, PolygonCoordinates { + // (undocumented) + type: "Polygon"; } // @public (undocumented) export interface PolygonCoordinates { - coordinates: number[][][]; + coordinates: Array>>; +} + +// @public (undocumented) +export interface PolygonCoordinatesOutput { + coordinates: Array>>; +} + +// @public (undocumented) +export interface PolygonOutput extends GeoJsonObjectOutputBase, PolygonCoordinatesOutput { + // (undocumented) + type: "Polygon"; } // @public (undocumented) export interface Routes { (path: "/farmers/{farmerId}/application-data", farmerId: string): ApplicationDataListByFarmerId; (path: "/application-data"): ApplicationDataList; - (path: "/farmers/{farmerId}/application-data/{applicationDataId}", farmerId: string, applicationDataId: string): ApplicationDataDelete; + (path: "/farmers/{farmerId}/application-data/{applicationDataId}", farmerId: string, applicationDataId: string): ApplicationDataGet; + (path: "/application-data/cascade-delete/{jobId}", jobId: string): ApplicationDataGetCascadeDeleteJobDetails; (path: "/farmers/{farmerId}/attachments", farmerId: string): AttachmentsListByFarmerId; - (path: "/farmers/{farmerId}/attachments/{attachmentId}", farmerId: string, attachmentId: string): AttachmentsDelete; + (path: "/farmers/{farmerId}/attachments/{attachmentId}", farmerId: string, attachmentId: string): AttachmentsGet; (path: "/farmers/{farmerId}/attachments/{attachmentId}/file", farmerId: string, attachmentId: string): AttachmentsDownload; - (path: "/farmers/{farmerId}/boundaries", farmerId: string): BoundariesSearchByFarmerId; - (path: "/boundaries"): BoundariesSearch; - (path: "/boundaries/cascade-delete/{jobId}", jobId: string): BoundariesCreateCascadeDeleteJob; - (path: "/farmers/{farmerId}/boundaries/{boundaryId}", farmerId: string, boundaryId: string): BoundariesDelete; + (path: "/farmers/{farmerId}/boundaries", farmerId: string): BoundariesListByFarmerId; + (path: "/boundaries"): BoundariesList; + (path: "/boundaries/cascade-delete/{jobId}", jobId: string): BoundariesGetCascadeDeleteJobDetails; + (path: "/farmers/{farmerId}/boundaries/{boundaryId}", farmerId: string, boundaryId: string): BoundariesGet; (path: "/farmers/{farmerId}/boundaries/{boundaryId}/overlap", farmerId: string, boundaryId: string): BoundariesGetOverlap; (path: "/crops"): CropsList; - (path: "/crops/{cropId}", cropId: string): CropsDelete; + (path: "/crops/{cropId}", cropId: string): CropsGet; (path: "/crops/{cropId}/crop-varieties", cropId: string): CropVarietiesListByCropId; (path: "/crop-varieties"): CropVarietiesList; - (path: "/crops/{cropId}/crop-varieties/{cropVarietyId}", cropId: string, cropVarietyId: string): CropVarietiesDelete; + (path: "/crops/{cropId}/crop-varieties/{cropVarietyId}", cropId: string, cropVarietyId: string): CropVarietiesGet; (path: "/farmers"): FarmersList; - (path: "/farmers/{farmerId}", farmerId: string): FarmersDelete; - (path: "/farmers/cascade-delete/{jobId}", jobId: string): FarmersCreateCascadeDeleteJob; - (path: "/farm-operations/ingest-data/{jobId}", jobId: string): FarmOperationsGetDataIngestionJobDetails; + (path: "/farmers/{farmerId}", farmerId: string): FarmersGet; + (path: "/farmers/cascade-delete/{jobId}", jobId: string): FarmersGetCascadeDeleteJobDetails; + (path: "/farm-operations/ingest-data/{jobId}", jobId: string): FarmOperationsCreateDataIngestionJob; (path: "/farmers/{farmerId}/farms", farmerId: string): FarmsListByFarmerId; (path: "/farms"): FarmsList; - (path: "/farmers/{farmerId}/farms/{farmId}", farmerId: string, farmId: string): FarmsDelete; - (path: "/farms/cascade-delete/{jobId}", jobId: string): FarmsCreateCascadeDeleteJob; + (path: "/farmers/{farmerId}/farms/{farmId}", farmerId: string, farmId: string): FarmsGet; + (path: "/farms/cascade-delete/{jobId}", jobId: string): FarmsGetCascadeDeleteJobDetails; (path: "/farmers/{farmerId}/fields", farmerId: string): FieldsListByFarmerId; (path: "/fields"): FieldsList; - (path: "/farmers/{farmerId}/fields/{fieldId}", farmerId: string, fieldId: string): FieldsDelete; - (path: "/fields/cascade-delete/{jobId}", jobId: string): FieldsCreateCascadeDeleteJob; + (path: "/farmers/{farmerId}/fields/{fieldId}", farmerId: string, fieldId: string): FieldsGet; + (path: "/fields/cascade-delete/{jobId}", jobId: string): FieldsGetCascadeDeleteJobDetails; (path: "/farmers/{farmerId}/harvest-data", farmerId: string): HarvestDataListByFarmerId; (path: "/harvest-data"): HarvestDataList; - (path: "/farmers/{farmerId}/harvest-data/{harvestDataId}", farmerId: string, harvestDataId: string): HarvestDataDelete; - (path: "/image-processing/rasterize/{jobId}", jobId: string): ImageProcessingGetRasterizeJob; + (path: "/farmers/{farmerId}/harvest-data/{harvestDataId}", farmerId: string, harvestDataId: string): HarvestDataGet; + (path: "/harvest-data/cascade-delete/{jobId}", jobId: string): HarvestDataGetCascadeDeleteJobDetails; + (path: "/image-processing/rasterize/{jobId}", jobId: string): ImageProcessingCreateRasterizeJob; (path: "/oauth/providers"): OAuthProvidersList; - (path: "/oauth/providers/{oauthProviderId}", oauthProviderId: string): OAuthProvidersDelete; + (path: "/oauth/providers/{oauthProviderId}", oauthProviderId: string): OAuthProvidersGet; + (path: "/oauth/providers/cascade-delete/{jobId}", jobId: string): OAuthProvidersGetCascadeDeleteJobDetails; (path: "/oauth/tokens"): OAuthTokensList; (path: "/oauth/tokens/:connect"): OAuthTokensGetOAuthConnectionLink; - (path: "/oauth/tokens/remove/{jobId}", jobId: string): OAuthTokensCreateCascadeDeleteJob; + (path: "/oauth/tokens/remove/{jobId}", jobId: string): OAuthTokensGetCascadeDeleteJobDetails; (path: "/farmers/{farmerId}/planting-data", farmerId: string): PlantingDataListByFarmerId; (path: "/planting-data"): PlantingDataList; - (path: "/farmers/{farmerId}/planting-data/{plantingDataId}", farmerId: string, plantingDataId: string): PlantingDataDelete; + (path: "/farmers/{farmerId}/planting-data/{plantingDataId}", farmerId: string, plantingDataId: string): PlantingDataGet; + (path: "/planting-data/cascade-delete/{jobId}", jobId: string): PlantingDataGetCascadeDeleteJobDetails; (path: "/scenes"): ScenesList; - (path: "/scenes/satellite/ingest-data/{jobId}", jobId: string): ScenesGetSatelliteDataIngestionJobDetails; + (path: "/scenes/satellite/ingest-data/{jobId}", jobId: string): ScenesCreateSatelliteDataIngestionJob; (path: "/scenes/downloadFiles"): ScenesDownload; (path: "/farmers/{farmerId}/seasonal-fields", farmerId: string): SeasonalFieldsListByFarmerId; (path: "/seasonal-fields"): SeasonalFieldsList; - (path: "/farmers/{farmerId}/seasonal-fields/{seasonalFieldId}", farmerId: string, seasonalFieldId: string): SeasonalFieldsDelete; - (path: "/seasonal-fields/cascade-delete/{jobId}", jobId: string): SeasonalFieldsCreateCascadeDeleteJob; + (path: "/farmers/{farmerId}/seasonal-fields/{seasonalFieldId}", farmerId: string, seasonalFieldId: string): SeasonalFieldsGet; + (path: "/seasonal-fields/cascade-delete/{jobId}", jobId: string): SeasonalFieldsGetCascadeDeleteJobDetails; (path: "/seasons"): SeasonsList; - (path: "/seasons/{seasonId}", seasonId: string): SeasonsDelete; + (path: "/seasons/{seasonId}", seasonId: string): SeasonsGet; (path: "/farmers/{farmerId}/tillage-data", farmerId: string): TillageDataListByFarmerId; (path: "/tillage-data"): TillageDataList; - (path: "/farmers/{farmerId}/tillage-data/{tillageDataId}", farmerId: string, tillageDataId: string): TillageDataDelete; + (path: "/farmers/{farmerId}/tillage-data/{tillageDataId}", farmerId: string, tillageDataId: string): TillageDataGet; + (path: "/tillage-data/cascade-delete/{jobId}", jobId: string): TillageDataGetCascadeDeleteJobDetails; (path: "/weather"): WeatherList; - (path: "/weather/ingest-data/{jobId}", jobId: string): WeatherCreateDataIngestionJob; - (path: "/weather/delete-data/{jobId}", jobId: string): WeatherCreateDataDeleteJob; + (path: "/weather/ingest-data/{jobId}", jobId: string): WeatherGetDataIngestionJobDetails; + (path: "/weather/delete-data/{jobId}", jobId: string): WeatherGetDataDeleteJobDetails; } // @public (undocumented) export interface SatelliteData { - imageFormats?: string[]; - imageNames?: string[]; - imageResolutions?: number[]; + imageFormats?: Array; + imageNames?: Array; + imageResolutions?: Array; } // @public (undocumented) export interface SatelliteDataIngestionJob { boundaryId: string; - createdDateTime?: Date; + createdDateTime?: Date | string; data?: SatelliteData; description?: string; durationInSeconds?: number; - endDateTime: Date; - endTime?: Date; + endDateTime: Date | string; + endTime?: Date | string; + farmerId: string; + id?: string; + lastActionDateTime?: Date | string; + message?: string; + name?: string; + properties?: Record>; + provider?: "Microsoft"; + source?: "Sentinel_2_L2A"; + startDateTime: Date | string; + startTime?: Date | string; + status?: string; +} + +// @public (undocumented) +export interface SatelliteDataIngestionJobOutput { + boundaryId: string; + createdDateTime?: string; + data?: SatelliteDataOutput; + description?: string; + durationInSeconds?: number; + endDateTime: string; + endTime?: string; farmerId: string; id?: string; - lastActionDateTime?: Date; + lastActionDateTime?: string; message?: string; name?: string; - properties?: SatelliteDataIngestionJobPropertiesDictionary; - provider?: DataProvider; - source?: Source; - startDateTime: Date; - startTime?: Date; + properties?: Record>; + provider?: "Microsoft"; + source?: "Sentinel_2_L2A"; + startDateTime: string; + startTime?: string; status?: string; } // @public (undocumented) -export type SatelliteDataIngestionJobPropertiesDictionary = Record; +export interface SatelliteDataOutput { + imageFormats?: Array; + imageNames?: Array; + imageResolutions?: Array; +} + +// @public (undocumented) +export interface SceneListResponseOutput { + $skipToken?: string; + nextLink?: string; + value?: Array; +} // @public (undocumented) -export interface Scene { +export interface SceneOutput { boundaryId?: string; cloudCoverPercentage?: number; darkPixelPercentage?: number; eTag?: string; farmerId?: string; id?: string; - imageFiles?: ImageFile[]; - imageFormat?: ImageFormat; + imageFiles?: Array; + imageFormat?: "TIF"; ndviMedianValue?: number; provider?: string; - sceneDateTime?: Date; + sceneDateTime?: string; source?: string; } // @public (undocumented) -export interface SceneListResponse { - nextLink?: string; - skipToken?: string; - value?: Scene[]; +export interface ScenesCreateSatelliteDataIngestionJob { + get(options?: ScenesGetSatelliteDataIngestionJobDetailsParameters): Promise; + put(options?: ScenesCreateSatelliteDataIngestionJobParameters): Promise; } // @public export interface ScenesCreateSatelliteDataIngestionJob202Response extends HttpResponse { // (undocumented) - body: SatelliteDataIngestionJob; + body: SatelliteDataIngestionJobOutput; // (undocumented) status: "202"; } // @public (undocumented) export interface ScenesCreateSatelliteDataIngestionJobBodyParam { - // (undocumented) body?: SatelliteDataIngestionJob; } // @public export interface ScenesCreateSatelliteDataIngestionJobdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type ScenesCreateSatelliteDataIngestionJobParameters = RequestParameters & ScenesCreateSatelliteDataIngestionJobBodyParam; +export interface ScenesCreateSatelliteDataIngestionJobMediaTypesParam { + contentType?: "application/json"; +} + +// @public (undocumented) +export type ScenesCreateSatelliteDataIngestionJobParameters = ScenesCreateSatelliteDataIngestionJobMediaTypesParam & ScenesCreateSatelliteDataIngestionJobBodyParam & RequestParameters; // @public (undocumented) export interface ScenesDownload { - get(options?: ScenesDownloadParameters): Promise; + get(options: ScenesDownloadParameters): Promise; } // @public export interface ScenesDownload200Response extends HttpResponse { + body: Uint8Array; // (undocumented) status: "200"; } @@ -3048,13 +3658,13 @@ export interface ScenesDownload200Response extends HttpResponse { // @public export interface ScenesDownloaddefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type ScenesDownloadParameters = RequestParameters & ScenesDownloadQueryParam; +export type ScenesDownloadParameters = ScenesDownloadQueryParam & RequestParameters; // @public (undocumented) export interface ScenesDownloadQueryParam { @@ -3067,16 +3677,10 @@ export interface ScenesDownloadQueryParamProperties { filePath: string; } -// @public (undocumented) -export interface ScenesGetSatelliteDataIngestionJobDetails { - get(options?: ScenesGetSatelliteDataIngestionJobDetailsParameters): Promise; - put(options?: ScenesCreateSatelliteDataIngestionJobParameters): Promise; -} - // @public export interface ScenesGetSatelliteDataIngestionJobDetails200Response extends HttpResponse { // (undocumented) - body: SatelliteDataIngestionJob; + body: SatelliteDataIngestionJobOutput; // (undocumented) status: "200"; } @@ -3084,7 +3688,7 @@ export interface ScenesGetSatelliteDataIngestionJobDetails200Response extends Ht // @public export interface ScenesGetSatelliteDataIngestionJobDetailsdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -3094,13 +3698,13 @@ export type ScenesGetSatelliteDataIngestionJobDetailsParameters = RequestParamet // @public (undocumented) export interface ScenesList { - get(options?: ScenesListParameters): Promise; + get(options: ScenesListParameters): Promise; } // @public export interface ScenesList200Response extends HttpResponse { // (undocumented) - body: SceneListResponse; + body: SceneListResponseOutput; // (undocumented) status: "200"; } @@ -3108,13 +3712,13 @@ export interface ScenesList200Response extends HttpResponse { // @public export interface ScenesListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type ScenesListParameters = RequestParameters & ScenesListQueryParam; +export type ScenesListParameters = ScenesListQueryParam & RequestParameters; // @public (undocumented) export interface ScenesListQueryParam { @@ -3127,49 +3731,49 @@ export interface ScenesListQueryParamProperties { $maxPageSize?: number; $skipToken?: string; boundaryId: string; - endDateTime?: Date; + endDateTime?: Date | string; farmerId: string; - imageFormats?: string[]; - imageNames?: string[]; - imageResolutions?: number[]; + imageFormats?: Array; + imageNames?: Array; + imageResolutions?: Array; maxCloudCoveragePercentage?: number; maxDarkPixelCoveragePercentage?: number; provider: string; source?: string; - startDateTime?: Date; + startDateTime?: Date | string; } // @public (undocumented) export interface SearchBoundaryQuery { - ids?: string[]; + $maxPageSize?: number; + $skipToken?: string; + ids?: Array; intersectsWithGeometry?: GeoJsonObject; isPrimary?: boolean; maxAcreage?: number; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - maxPageSize?: number; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; minAcreage?: number; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - names?: string[]; - parentIds?: string[]; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + names?: Array; + parentIds?: Array; parentType?: string; - propertyFilters?: string[]; - skipToken?: string; - statuses?: string[]; + propertyFilters?: Array; + statuses?: Array; } // @public (undocumented) export interface Season { - createdDateTime?: Date; + createdDateTime?: Date | string; description?: string; - endDateTime?: Date; + endDateTime?: Date | string; eTag?: string; id?: string; - modifiedDateTime?: Date; + modifiedDateTime?: Date | string; name?: string; - properties?: SeasonPropertiesDictionary; - startDateTime?: Date; + properties?: Record>; + startDateTime?: Date | string; status?: string; year?: number; } @@ -3180,45 +3784,61 @@ export interface SeasonalField { avgSeedPopulationValue?: number; avgYieldUnit?: string; avgYieldValue?: number; - boundaryIds?: string[]; - createdDateTime?: Date; + boundaryIds?: Array; + createdDateTime?: Date | string; cropId?: string; - cropVarietyIds?: string[]; + cropVarietyIds?: Array; description?: string; eTag?: string; farmerId?: string; farmId?: string; fieldId?: string; id?: string; - modifiedDateTime?: Date; + modifiedDateTime?: Date | string; name?: string; - plantingDateTime?: Date; + plantingDateTime?: Date | string; primaryBoundaryId?: string; - properties?: SeasonalFieldPropertiesDictionary; + properties?: Record>; seasonId?: string; status?: string; } // @public (undocumented) -export interface SeasonalFieldListResponse { +export interface SeasonalFieldListResponseOutput { + $skipToken?: string; nextLink?: string; - skipToken?: string; - value?: SeasonalField[]; + value?: Array; } // @public (undocumented) -export type SeasonalFieldPropertiesDictionary = Record; - -// @public (undocumented) -export interface SeasonalFieldsCreateCascadeDeleteJob { - get(options?: SeasonalFieldsGetCascadeDeleteJobDetailsParameters): Promise; - put(options?: SeasonalFieldsCreateCascadeDeleteJobParameters): Promise; +export interface SeasonalFieldOutput { + avgSeedPopulationUnit?: string; + avgSeedPopulationValue?: number; + avgYieldUnit?: string; + avgYieldValue?: number; + boundaryIds?: Array; + createdDateTime?: string; + cropId?: string; + cropVarietyIds?: Array; + description?: string; + eTag?: string; + farmerId?: string; + farmId?: string; + fieldId?: string; + id?: string; + modifiedDateTime?: string; + name?: string; + plantingDateTime?: string; + primaryBoundaryId?: string; + properties?: Record>; + seasonId?: string; + status?: string; } // @public export interface SeasonalFieldsCreateCascadeDeleteJob202Response extends HttpResponse { // (undocumented) - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; // (undocumented) status: "202"; } @@ -3226,13 +3846,13 @@ export interface SeasonalFieldsCreateCascadeDeleteJob202Response extends HttpRes // @public export interface SeasonalFieldsCreateCascadeDeleteJobdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type SeasonalFieldsCreateCascadeDeleteJobParameters = RequestParameters & SeasonalFieldsCreateCascadeDeleteJobQueryParam; +export type SeasonalFieldsCreateCascadeDeleteJobParameters = SeasonalFieldsCreateCascadeDeleteJobQueryParam & RequestParameters; // @public (undocumented) export interface SeasonalFieldsCreateCascadeDeleteJobQueryParam { @@ -3249,7 +3869,7 @@ export interface SeasonalFieldsCreateCascadeDeleteJobQueryParamProperties { // @public export interface SeasonalFieldsCreateOrUpdate200Response extends HttpResponse { // (undocumented) - body: SeasonalField; + body: SeasonalFieldOutput; // (undocumented) status: "200"; } @@ -3257,37 +3877,36 @@ export interface SeasonalFieldsCreateOrUpdate200Response extends HttpResponse { // @public export interface SeasonalFieldsCreateOrUpdate201Response extends HttpResponse { // (undocumented) - body: SeasonalField; + body: SeasonalFieldOutput; // (undocumented) status: "201"; } // @public (undocumented) export interface SeasonalFieldsCreateOrUpdateBodyParam { - // (undocumented) body?: SeasonalField; } // @public export interface SeasonalFieldsCreateOrUpdatedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type SeasonalFieldsCreateOrUpdateParameters = RequestParameters & SeasonalFieldsCreateOrUpdateBodyParam; +export interface SeasonalFieldsCreateOrUpdateMediaTypesParam { + contentType?: "application/merge-patch+json"; +} // @public (undocumented) -export interface SeasonalFieldsDelete { - delete(options?: SeasonalFieldsDeleteParameters): Promise; - get(options?: SeasonalFieldsGetParameters): Promise; - patch(options?: SeasonalFieldsCreateOrUpdateParameters): Promise; -} +export type SeasonalFieldsCreateOrUpdateParameters = SeasonalFieldsCreateOrUpdateMediaTypesParam & SeasonalFieldsCreateOrUpdateBodyParam & RequestParameters; // @public export interface SeasonalFieldsDelete204Response extends HttpResponse { + // (undocumented) + body: Record; // (undocumented) status: "204"; } @@ -3295,7 +3914,7 @@ export interface SeasonalFieldsDelete204Response extends HttpResponse { // @public export interface SeasonalFieldsDeletedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -3303,18 +3922,31 @@ export interface SeasonalFieldsDeletedefaultResponse extends HttpResponse { // @public (undocumented) export type SeasonalFieldsDeleteParameters = RequestParameters; +// @public (undocumented) +export interface SeasonalFieldsGet { + delete(options?: SeasonalFieldsDeleteParameters): Promise; + get(options?: SeasonalFieldsGetParameters): Promise; + patch(options?: SeasonalFieldsCreateOrUpdateParameters): Promise; +} + // @public export interface SeasonalFieldsGet200Response extends HttpResponse { // (undocumented) - body: SeasonalField; + body: SeasonalFieldOutput; // (undocumented) status: "200"; } +// @public (undocumented) +export interface SeasonalFieldsGetCascadeDeleteJobDetails { + get(options?: SeasonalFieldsGetCascadeDeleteJobDetailsParameters): Promise; + put(options: SeasonalFieldsCreateCascadeDeleteJobParameters): Promise; +} + // @public export interface SeasonalFieldsGetCascadeDeleteJobDetails200Response extends HttpResponse { // (undocumented) - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; // (undocumented) status: "200"; } @@ -3322,7 +3954,7 @@ export interface SeasonalFieldsGetCascadeDeleteJobDetails200Response extends Htt // @public export interface SeasonalFieldsGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -3333,7 +3965,7 @@ export type SeasonalFieldsGetCascadeDeleteJobDetailsParameters = RequestParamete // @public export interface SeasonalFieldsGetdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -3349,7 +3981,7 @@ export interface SeasonalFieldsList { // @public export interface SeasonalFieldsList200Response extends HttpResponse { // (undocumented) - body: SeasonalFieldListResponse; + body: SeasonalFieldListResponseOutput; // (undocumented) status: "200"; } @@ -3362,7 +3994,7 @@ export interface SeasonalFieldsListByFarmerId { // @public export interface SeasonalFieldsListByFarmerId200Response extends HttpResponse { // (undocumented) - body: SeasonalFieldListResponse; + body: SeasonalFieldListResponseOutput; // (undocumented) status: "200"; } @@ -3370,13 +4002,13 @@ export interface SeasonalFieldsListByFarmerId200Response extends HttpResponse { // @public export interface SeasonalFieldsListByFarmerIddefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type SeasonalFieldsListByFarmerIdParameters = RequestParameters & SeasonalFieldsListByFarmerIdQueryParam; +export type SeasonalFieldsListByFarmerIdParameters = SeasonalFieldsListByFarmerIdQueryParam & RequestParameters; // @public (undocumented) export interface SeasonalFieldsListByFarmerIdQueryParam { @@ -3390,37 +4022,37 @@ export interface SeasonalFieldsListByFarmerIdQueryParamProperties { $skipToken?: string; avgSeedPopulationUnit?: string; avgYieldUnit?: string; - cropIds?: string[]; - cropVarietyIds?: string[]; - farmIds?: string[]; - fieldIds?: string[]; - ids?: string[]; + cropIds?: Array; + cropVarietyIds?: Array; + farmIds?: Array; + fieldIds?: Array; + ids?: Array; maxAvgSeedPopulationValue?: number; maxAvgYieldValue?: number; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - maxPlantingDateTime?: Date; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + maxPlantingDateTime?: Date | string; minAvgSeedPopulationValue?: number; minAvgYieldValue?: number; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - minPlantingDateTime?: Date; - names?: string[]; - propertyFilters?: string[]; - seasonIds?: string[]; - statuses?: string[]; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + minPlantingDateTime?: Date | string; + names?: Array; + propertyFilters?: Array; + seasonIds?: Array; + statuses?: Array; } // @public export interface SeasonalFieldsListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type SeasonalFieldsListParameters = RequestParameters & SeasonalFieldsListQueryParam; +export type SeasonalFieldsListParameters = SeasonalFieldsListQueryParam & RequestParameters; // @public (undocumented) export interface SeasonalFieldsListQueryParam { @@ -3434,41 +4066,53 @@ export interface SeasonalFieldsListQueryParamProperties { $skipToken?: string; avgSeedPopulationUnit?: string; avgYieldUnit?: string; - cropIds?: string[]; - cropVarietyIds?: string[]; - farmIds?: string[]; - fieldIds?: string[]; - ids?: string[]; + cropIds?: Array; + cropVarietyIds?: Array; + farmIds?: Array; + fieldIds?: Array; + ids?: Array; maxAvgSeedPopulationValue?: number; maxAvgYieldValue?: number; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - maxPlantingDateTime?: Date; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + maxPlantingDateTime?: Date | string; minAvgSeedPopulationValue?: number; minAvgYieldValue?: number; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - minPlantingDateTime?: Date; - names?: string[]; - propertyFilters?: string[]; - seasonIds?: string[]; - statuses?: string[]; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + minPlantingDateTime?: Date | string; + names?: Array; + propertyFilters?: Array; + seasonIds?: Array; + statuses?: Array; } // @public (undocumented) -export interface SeasonListResponse { +export interface SeasonListResponseOutput { + $skipToken?: string; nextLink?: string; - skipToken?: string; - value?: Season[]; + value?: Array; } // @public (undocumented) -export type SeasonPropertiesDictionary = Record; +export interface SeasonOutput { + createdDateTime?: string; + description?: string; + endDateTime?: string; + eTag?: string; + id?: string; + modifiedDateTime?: string; + name?: string; + properties?: Record>; + startDateTime?: string; + status?: string; + year?: number; +} // @public export interface SeasonsCreateOrUpdate200Response extends HttpResponse { // (undocumented) - body: Season; + body: SeasonOutput; // (undocumented) status: "200"; } @@ -3476,37 +4120,36 @@ export interface SeasonsCreateOrUpdate200Response extends HttpResponse { // @public export interface SeasonsCreateOrUpdate201Response extends HttpResponse { // (undocumented) - body: Season; + body: SeasonOutput; // (undocumented) status: "201"; } // @public (undocumented) export interface SeasonsCreateOrUpdateBodyParam { - // (undocumented) body?: Season; } // @public export interface SeasonsCreateOrUpdatedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type SeasonsCreateOrUpdateParameters = RequestParameters & SeasonsCreateOrUpdateBodyParam; +export interface SeasonsCreateOrUpdateMediaTypesParam { + contentType?: "application/merge-patch+json"; +} // @public (undocumented) -export interface SeasonsDelete { - delete(options?: SeasonsDeleteParameters): Promise; - get(options?: SeasonsGetParameters): Promise; - patch(options?: SeasonsCreateOrUpdateParameters): Promise; -} +export type SeasonsCreateOrUpdateParameters = SeasonsCreateOrUpdateMediaTypesParam & SeasonsCreateOrUpdateBodyParam & RequestParameters; // @public export interface SeasonsDelete204Response extends HttpResponse { + // (undocumented) + body: Record; // (undocumented) status: "204"; } @@ -3514,7 +4157,7 @@ export interface SeasonsDelete204Response extends HttpResponse { // @public export interface SeasonsDeletedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -3522,10 +4165,17 @@ export interface SeasonsDeletedefaultResponse extends HttpResponse { // @public (undocumented) export type SeasonsDeleteParameters = RequestParameters; +// @public (undocumented) +export interface SeasonsGet { + delete(options?: SeasonsDeleteParameters): Promise; + get(options?: SeasonsGetParameters): Promise; + patch(options?: SeasonsCreateOrUpdateParameters): Promise; +} + // @public export interface SeasonsGet200Response extends HttpResponse { // (undocumented) - body: Season; + body: SeasonOutput; // (undocumented) status: "200"; } @@ -3533,7 +4183,7 @@ export interface SeasonsGet200Response extends HttpResponse { // @public export interface SeasonsGetdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -3549,7 +4199,7 @@ export interface SeasonsList { // @public export interface SeasonsList200Response extends HttpResponse { // (undocumented) - body: SeasonListResponse; + body: SeasonListResponseOutput; // (undocumented) status: "200"; } @@ -3557,13 +4207,13 @@ export interface SeasonsList200Response extends HttpResponse { // @public export interface SeasonsListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type SeasonsListParameters = RequestParameters & SeasonsListQueryParam; +export type SeasonsListParameters = SeasonsListQueryParam & RequestParameters; // @public (undocumented) export interface SeasonsListQueryParam { @@ -3575,51 +4225,79 @@ export interface SeasonsListQueryParam { export interface SeasonsListQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - ids?: string[]; - maxCreatedDateTime?: Date; - maxEndDateTime?: Date; - maxLastModifiedDateTime?: Date; - maxStartDateTime?: Date; - minCreatedDateTime?: Date; - minEndDateTime?: Date; - minLastModifiedDateTime?: Date; - minStartDateTime?: Date; - names?: string[]; - propertyFilters?: string[]; - statuses?: string[]; - years?: number[]; + ids?: Array; + maxCreatedDateTime?: Date | string; + maxEndDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + maxStartDateTime?: Date | string; + minCreatedDateTime?: Date | string; + minEndDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + minStartDateTime?: Date | string; + names?: Array; + propertyFilters?: Array; + statuses?: Array; + years?: Array; } -// @public (undocumented) -export type Source = "Sentinel_2_L2A"; - // @public (undocumented) export interface TillageData { area?: Measure; associatedBoundaryId?: string; attachmentsLink?: string; - createdDateTime?: Date; + createdDateTime?: Date | string; description?: string; eTag?: string; farmerId?: string; id?: string; - modifiedDateTime?: Date; + modifiedDateTime?: Date | string; name?: string; operationBoundaryId?: string; - operationEndDateTime?: Date; - operationModifiedDateTime?: Date; - operationStartDateTime?: Date; - properties?: TillageDataPropertiesDictionary; + operationEndDateTime?: Date | string; + operationModifiedDateTime?: Date | string; + operationStartDateTime?: Date | string; + properties?: Record>; source?: string; status?: string; tillageDepth?: Measure; tillagePressure?: Measure; } +// @public +export interface TillageDataCreateCascadeDeleteJob202Response extends HttpResponse { + // (undocumented) + body: CascadeDeleteJobOutput; + // (undocumented) + status: "202"; +} + +// @public +export interface TillageDataCreateCascadeDeleteJobdefaultResponse extends HttpResponse { + // (undocumented) + body: ErrorResponseOutput; + // (undocumented) + status: "500"; +} + +// @public (undocumented) +export type TillageDataCreateCascadeDeleteJobParameters = TillageDataCreateCascadeDeleteJobQueryParam & RequestParameters; + +// @public (undocumented) +export interface TillageDataCreateCascadeDeleteJobQueryParam { + // (undocumented) + queryParameters: TillageDataCreateCascadeDeleteJobQueryParamProperties; +} + +// @public (undocumented) +export interface TillageDataCreateCascadeDeleteJobQueryParamProperties { + farmerId: string; + tillageDataId: string; +} + // @public export interface TillageDataCreateOrUpdate200Response extends HttpResponse { // (undocumented) - body: TillageData; + body: TillageDataOutput; // (undocumented) status: "200"; } @@ -3627,37 +4305,36 @@ export interface TillageDataCreateOrUpdate200Response extends HttpResponse { // @public export interface TillageDataCreateOrUpdate201Response extends HttpResponse { // (undocumented) - body: TillageData; + body: TillageDataOutput; // (undocumented) status: "201"; } // @public (undocumented) export interface TillageDataCreateOrUpdateBodyParam { - // (undocumented) body?: TillageData; } // @public export interface TillageDataCreateOrUpdatedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type TillageDataCreateOrUpdateParameters = RequestParameters & TillageDataCreateOrUpdateBodyParam; +export interface TillageDataCreateOrUpdateMediaTypesParam { + contentType?: "application/merge-patch+json"; +} // @public (undocumented) -export interface TillageDataDelete { - delete(options?: TillageDataDeleteParameters): Promise; - get(options?: TillageDataGetParameters): Promise; - patch(options?: TillageDataCreateOrUpdateParameters): Promise; -} +export type TillageDataCreateOrUpdateParameters = TillageDataCreateOrUpdateMediaTypesParam & TillageDataCreateOrUpdateBodyParam & RequestParameters; // @public export interface TillageDataDelete204Response extends HttpResponse { + // (undocumented) + body: Record; // (undocumented) status: "204"; } @@ -3665,7 +4342,7 @@ export interface TillageDataDelete204Response extends HttpResponse { // @public export interface TillageDataDeletedefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -3673,18 +4350,50 @@ export interface TillageDataDeletedefaultResponse extends HttpResponse { // @public (undocumented) export type TillageDataDeleteParameters = RequestParameters; +// @public (undocumented) +export interface TillageDataGet { + delete(options?: TillageDataDeleteParameters): Promise; + get(options?: TillageDataGetParameters): Promise; + patch(options?: TillageDataCreateOrUpdateParameters): Promise; +} + // @public export interface TillageDataGet200Response extends HttpResponse { // (undocumented) - body: TillageData; + body: TillageDataOutput; + // (undocumented) + status: "200"; +} + +// @public (undocumented) +export interface TillageDataGetCascadeDeleteJobDetails { + get(options?: TillageDataGetCascadeDeleteJobDetailsParameters): Promise; + put(options: TillageDataCreateCascadeDeleteJobParameters): Promise; +} + +// @public +export interface TillageDataGetCascadeDeleteJobDetails200Response extends HttpResponse { + // (undocumented) + body: CascadeDeleteJobOutput; // (undocumented) status: "200"; } +// @public +export interface TillageDataGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { + // (undocumented) + body: ErrorResponseOutput; + // (undocumented) + status: "500"; +} + +// @public (undocumented) +export type TillageDataGetCascadeDeleteJobDetailsParameters = RequestParameters; + // @public export interface TillageDataGetdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -3700,7 +4409,7 @@ export interface TillageDataList { // @public export interface TillageDataList200Response extends HttpResponse { // (undocumented) - body: TillageDataListResponse; + body: TillageDataListResponseOutput; // (undocumented) status: "200"; } @@ -3713,7 +4422,7 @@ export interface TillageDataListByFarmerId { // @public export interface TillageDataListByFarmerId200Response extends HttpResponse { // (undocumented) - body: TillageDataListResponse; + body: TillageDataListResponseOutput; // (undocumented) status: "200"; } @@ -3721,13 +4430,13 @@ export interface TillageDataListByFarmerId200Response extends HttpResponse { // @public export interface TillageDataListByFarmerIddefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type TillageDataListByFarmerIdParameters = RequestParameters & TillageDataListByFarmerIdQueryParam; +export type TillageDataListByFarmerIdParameters = TillageDataListByFarmerIdQueryParam & RequestParameters; // @public (undocumented) export interface TillageDataListByFarmerIdQueryParam { @@ -3739,41 +4448,41 @@ export interface TillageDataListByFarmerIdQueryParam { export interface TillageDataListByFarmerIdQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - associatedBoundaryIds?: string[]; - ids?: string[]; + associatedBoundaryIds?: Array; + ids?: Array; maxArea?: number; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - maxOperationEndDateTime?: Date; - maxOperationModifiedDateTime?: Date; - maxOperationStartDateTime?: Date; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + maxOperationEndDateTime?: Date | string; + maxOperationModifiedDateTime?: Date | string; + maxOperationStartDateTime?: Date | string; maxTillageDepth?: number; maxTillagePressure?: number; minArea?: number; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - minOperationEndDateTime?: Date; - minOperationModifiedDateTime?: Date; - minOperationStartDateTime?: Date; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + minOperationEndDateTime?: Date | string; + minOperationModifiedDateTime?: Date | string; + minOperationStartDateTime?: Date | string; minTillageDepth?: number; minTillagePressure?: number; - names?: string[]; - operationBoundaryIds?: string[]; - propertyFilters?: string[]; - sources?: string[]; - statuses?: string[]; + names?: Array; + operationBoundaryIds?: Array; + propertyFilters?: Array; + sources?: Array; + statuses?: Array; } // @public export interface TillageDataListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type TillageDataListParameters = RequestParameters & TillageDataListQueryParam; +export type TillageDataListParameters = TillageDataListQueryParam & RequestParameters; // @public (undocumented) export interface TillageDataListQueryParam { @@ -3785,203 +4494,257 @@ export interface TillageDataListQueryParam { export interface TillageDataListQueryParamProperties { $maxPageSize?: number; $skipToken?: string; - associatedBoundaryIds?: string[]; - ids?: string[]; + associatedBoundaryIds?: Array; + ids?: Array; maxArea?: number; - maxCreatedDateTime?: Date; - maxLastModifiedDateTime?: Date; - maxOperationEndDateTime?: Date; - maxOperationModifiedDateTime?: Date; - maxOperationStartDateTime?: Date; + maxCreatedDateTime?: Date | string; + maxLastModifiedDateTime?: Date | string; + maxOperationEndDateTime?: Date | string; + maxOperationModifiedDateTime?: Date | string; + maxOperationStartDateTime?: Date | string; maxTillageDepth?: number; maxTillagePressure?: number; minArea?: number; - minCreatedDateTime?: Date; - minLastModifiedDateTime?: Date; - minOperationEndDateTime?: Date; - minOperationModifiedDateTime?: Date; - minOperationStartDateTime?: Date; + minCreatedDateTime?: Date | string; + minLastModifiedDateTime?: Date | string; + minOperationEndDateTime?: Date | string; + minOperationModifiedDateTime?: Date | string; + minOperationStartDateTime?: Date | string; minTillageDepth?: number; minTillagePressure?: number; - names?: string[]; - operationBoundaryIds?: string[]; - propertyFilters?: string[]; - sources?: string[]; - statuses?: string[]; + names?: Array; + operationBoundaryIds?: Array; + propertyFilters?: Array; + sources?: Array; + statuses?: Array; } // @public (undocumented) -export interface TillageDataListResponse { +export interface TillageDataListResponseOutput { + $skipToken?: string; nextLink?: string; - skipToken?: string; - value?: TillageData[]; + value?: Array; } // @public (undocumented) -export type TillageDataPropertiesDictionary = Record; - -// @public (undocumented) -export interface WeatherCreateDataDeleteJob { - get(options?: WeatherGetDataDeleteJobDetailsParameters): Promise; - put(options?: WeatherCreateDataDeleteJobParameters): Promise; +export interface TillageDataOutput { + area?: MeasureOutput; + associatedBoundaryId?: string; + attachmentsLink?: string; + createdDateTime?: string; + description?: string; + eTag?: string; + farmerId?: string; + id?: string; + modifiedDateTime?: string; + name?: string; + operationBoundaryId?: string; + operationEndDateTime?: string; + operationModifiedDateTime?: string; + operationStartDateTime?: string; + properties?: Record>; + source?: string; + status?: string; + tillageDepth?: MeasureOutput; + tillagePressure?: MeasureOutput; } // @public export interface WeatherCreateDataDeleteJob202Response extends HttpResponse { // (undocumented) - body: WeatherDataDeleteJob; + body: WeatherDataDeleteJobOutput; // (undocumented) status: "202"; } // @public (undocumented) export interface WeatherCreateDataDeleteJobBodyParam { - // (undocumented) body?: WeatherDataDeleteJob; } // @public export interface WeatherCreateDataDeleteJobdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type WeatherCreateDataDeleteJobParameters = RequestParameters & WeatherCreateDataDeleteJobBodyParam; +export interface WeatherCreateDataDeleteJobMediaTypesParam { + contentType?: "application/json"; +} // @public (undocumented) -export interface WeatherCreateDataIngestionJob { - get(options?: WeatherGetDataIngestionJobDetailsParameters): Promise; - put(options?: WeatherCreateDataIngestionJobParameters): Promise; -} +export type WeatherCreateDataDeleteJobParameters = WeatherCreateDataDeleteJobMediaTypesParam & WeatherCreateDataDeleteJobBodyParam & RequestParameters; // @public export interface WeatherCreateDataIngestionJob202Response extends HttpResponse { // (undocumented) - body: WeatherDataIngestionJob; + body: WeatherDataIngestionJobOutput; // (undocumented) status: "202"; } // @public (undocumented) export interface WeatherCreateDataIngestionJobBodyParam { - // (undocumented) body?: WeatherDataIngestionJob; } // @public export interface WeatherCreateDataIngestionJobdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type WeatherCreateDataIngestionJobParameters = RequestParameters & WeatherCreateDataIngestionJobBodyParam; +export interface WeatherCreateDataIngestionJobMediaTypesParam { + contentType?: "application/json"; +} + +// @public (undocumented) +export type WeatherCreateDataIngestionJobParameters = WeatherCreateDataIngestionJobMediaTypesParam & WeatherCreateDataIngestionJobBodyParam & RequestParameters; // @public (undocumented) -export interface WeatherData { +export interface WeatherDataDeleteJob { boundaryId: string; - cloudCover?: Measure; - createdDateTime?: Date; - dateTime: Date; - dewPoint?: Measure; - eTag?: string; + createdDateTime?: Date | string; + description?: string; + durationInSeconds?: number; + endDateTime?: Date | string; + endTime?: Date | string; extensionId: string; - extensionVersion: string; farmerId: string; - granularity: string; - growingDegreeDay?: Measure; + granularity?: string; id?: string; - location: Location; - modifiedDateTime?: Date; - precipitation?: Measure; - pressure?: Measure; - properties?: WeatherDataPropertiesDictionary; - relativeHumidity?: Measure; - soilMoisture?: Measure; - soilTemperature?: Measure; - temperature?: Measure; - unitSystemCode?: string; - visibility?: Measure; - weatherDataType: string; - wetBulbTemperature?: Measure; - windChill?: Measure; - windDirection?: Measure; - windGust?: Measure; - windSpeed?: Measure; + lastActionDateTime?: Date | string; + message?: string; + name?: string; + properties?: Record>; + startDateTime?: Date | string; + startTime?: Date | string; + status?: string; + weatherDataType?: string; } // @public (undocumented) -export interface WeatherDataDeleteJob { +export interface WeatherDataDeleteJobOutput { boundaryId: string; - createdDateTime?: Date; + createdDateTime?: string; description?: string; durationInSeconds?: number; - endDateTime?: Date; - endTime?: Date; + endDateTime?: string; + endTime?: string; extensionId: string; farmerId: string; granularity?: string; id?: string; - lastActionDateTime?: Date; + lastActionDateTime?: string; message?: string; name?: string; - properties?: WeatherDataDeleteJobPropertiesDictionary; - startDateTime?: Date; - startTime?: Date; + properties?: Record>; + startDateTime?: string; + startTime?: string; status?: string; weatherDataType?: string; } -// @public (undocumented) -export type WeatherDataDeleteJobPropertiesDictionary = Record; - // @public (undocumented) export interface WeatherDataIngestionJob { boundaryId: string; - createdDateTime?: Date; + createdDateTime?: Date | string; description?: string; durationInSeconds?: number; - endTime?: Date; - extensionApiInput: WeatherDataIngestionJobExtensionApiInputDictionary; + endTime?: Date | string; + extensionApiInput: Record>; extensionApiName: string; extensionDataProviderApiKey?: string; extensionDataProviderAppId?: string; extensionId: string; farmerId: string; id?: string; - lastActionDateTime?: Date; + lastActionDateTime?: Date | string; message?: string; name?: string; - properties?: WeatherDataIngestionJobPropertiesDictionary; - startTime?: Date; + properties?: Record>; + startTime?: Date | string; status?: string; } // @public (undocumented) -export type WeatherDataIngestionJobExtensionApiInputDictionary = Record; +export interface WeatherDataIngestionJobOutput { + boundaryId: string; + createdDateTime?: string; + description?: string; + durationInSeconds?: number; + endTime?: string; + extensionApiInput: Record>; + extensionApiName: string; + extensionDataProviderApiKey?: string; + extensionDataProviderAppId?: string; + extensionId: string; + farmerId: string; + id?: string; + lastActionDateTime?: string; + message?: string; + name?: string; + properties?: Record>; + startTime?: string; + status?: string; +} // @public (undocumented) -export type WeatherDataIngestionJobPropertiesDictionary = Record; +export interface WeatherDataListResponseOutput { + $skipToken?: string; + nextLink?: string; + value?: Array; +} // @public (undocumented) -export interface WeatherDataListResponse { - nextLink?: string; - skipToken?: string; - value?: WeatherData[]; +export interface WeatherDataOutput { + boundaryId: string; + cloudCover?: MeasureOutput; + createdDateTime?: string; + dateTime: string; + dewPoint?: MeasureOutput; + eTag?: string; + extensionId: string; + extensionVersion: string; + farmerId: string; + granularity: string; + growingDegreeDay?: MeasureOutput; + id?: string; + location: LocationOutput; + modifiedDateTime?: string; + precipitation?: MeasureOutput; + pressure?: MeasureOutput; + properties?: Record>; + relativeHumidity?: MeasureOutput; + soilMoisture?: MeasureOutput; + soilTemperature?: MeasureOutput; + temperature?: MeasureOutput; + unitSystemCode?: string; + visibility?: MeasureOutput; + weatherDataType: string; + wetBulbTemperature?: MeasureOutput; + windChill?: MeasureOutput; + windDirection?: MeasureOutput; + windGust?: MeasureOutput; + windSpeed?: MeasureOutput; } // @public (undocumented) -export type WeatherDataPropertiesDictionary = Record; +export interface WeatherGetDataDeleteJobDetails { + get(options?: WeatherGetDataDeleteJobDetailsParameters): Promise; + put(options?: WeatherCreateDataDeleteJobParameters): Promise; +} // @public export interface WeatherGetDataDeleteJobDetails200Response extends HttpResponse { // (undocumented) - body: WeatherDataDeleteJob; + body: WeatherDataDeleteJobOutput; // (undocumented) status: "200"; } @@ -3989,7 +4752,7 @@ export interface WeatherGetDataDeleteJobDetails200Response extends HttpResponse // @public export interface WeatherGetDataDeleteJobDetailsdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -3997,10 +4760,16 @@ export interface WeatherGetDataDeleteJobDetailsdefaultResponse extends HttpRespo // @public (undocumented) export type WeatherGetDataDeleteJobDetailsParameters = RequestParameters; +// @public (undocumented) +export interface WeatherGetDataIngestionJobDetails { + get(options?: WeatherGetDataIngestionJobDetailsParameters): Promise; + put(options?: WeatherCreateDataIngestionJobParameters): Promise; +} + // @public export interface WeatherGetDataIngestionJobDetails200Response extends HttpResponse { // (undocumented) - body: WeatherDataIngestionJob; + body: WeatherDataIngestionJobOutput; // (undocumented) status: "200"; } @@ -4008,7 +4777,7 @@ export interface WeatherGetDataIngestionJobDetails200Response extends HttpRespon // @public export interface WeatherGetDataIngestionJobDetailsdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } @@ -4018,13 +4787,13 @@ export type WeatherGetDataIngestionJobDetailsParameters = RequestParameters; // @public (undocumented) export interface WeatherList { - get(options?: WeatherListParameters): Promise; + get(options: WeatherListParameters): Promise; } // @public export interface WeatherList200Response extends HttpResponse { // (undocumented) - body: WeatherDataListResponse; + body: WeatherDataListResponseOutput; // (undocumented) status: "200"; } @@ -4032,13 +4801,13 @@ export interface WeatherList200Response extends HttpResponse { // @public export interface WeatherListdefaultResponse extends HttpResponse { // (undocumented) - body: ErrorResponse; + body: ErrorResponseOutput; // (undocumented) status: "500"; } // @public (undocumented) -export type WeatherListParameters = RequestParameters & WeatherListQueryParam; +export type WeatherListParameters = WeatherListQueryParam & RequestParameters; // @public (undocumented) export interface WeatherListQueryParam { @@ -4051,15 +4820,14 @@ export interface WeatherListQueryParamProperties { $maxPageSize?: number; $skipToken?: string; boundaryId: string; - endDateTime?: Date; + endDateTime?: Date | string; extensionId: string; farmerId: string; granularity: string; - startDateTime?: Date; + startDateTime?: Date | string; weatherDataType: string; } - // (No @packageDocumentation comment for this package) ``` diff --git a/sdk/agrifood/agrifood-farming-rest/src/clientDefinitions.ts b/sdk/agrifood/agrifood-farming-rest/src/clientDefinitions.ts new file mode 100644 index 000000000000..bc500970e061 --- /dev/null +++ b/sdk/agrifood/agrifood-farming-rest/src/clientDefinitions.ts @@ -0,0 +1,1984 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + +import { + ApplicationDataCreateCascadeDeleteJobParameters, + ApplicationDataCreateOrUpdateParameters, + ApplicationDataDeleteParameters, + ApplicationDataGetCascadeDeleteJobDetailsParameters, + ApplicationDataGetParameters, + ApplicationDataListByFarmerIdParameters, + ApplicationDataListParameters, + AttachmentsCreateOrUpdateParameters, + AttachmentsDeleteParameters, + AttachmentsDownloadParameters, + AttachmentsGetParameters, + AttachmentsListByFarmerIdParameters, + BoundariesCreateCascadeDeleteJobParameters, + BoundariesCreateOrUpdateParameters, + BoundariesDeleteParameters, + BoundariesGetCascadeDeleteJobDetailsParameters, + BoundariesGetOverlapParameters, + BoundariesGetParameters, + BoundariesListByFarmerIdParameters, + BoundariesListParameters, + BoundariesSearchByFarmerIdParameters, + BoundariesSearchParameters, + CropVarietiesCreateOrUpdateParameters, + CropVarietiesDeleteParameters, + CropVarietiesGetParameters, + CropVarietiesListByCropIdParameters, + CropVarietiesListParameters, + CropsCreateOrUpdateParameters, + CropsDeleteParameters, + CropsGetParameters, + CropsListParameters, + FarmOperationsCreateDataIngestionJobParameters, + FarmOperationsGetDataIngestionJobDetailsParameters, + FarmersCreateCascadeDeleteJobParameters, + FarmersCreateOrUpdateParameters, + FarmersDeleteParameters, + FarmersGetCascadeDeleteJobDetailsParameters, + FarmersGetParameters, + FarmersListParameters, + FarmsCreateCascadeDeleteJobParameters, + FarmsCreateOrUpdateParameters, + FarmsDeleteParameters, + FarmsGetCascadeDeleteJobDetailsParameters, + FarmsGetParameters, + FarmsListByFarmerIdParameters, + FarmsListParameters, + FieldsCreateCascadeDeleteJobParameters, + FieldsCreateOrUpdateParameters, + FieldsDeleteParameters, + FieldsGetCascadeDeleteJobDetailsParameters, + FieldsGetParameters, + FieldsListByFarmerIdParameters, + FieldsListParameters, + HarvestDataCreateCascadeDeleteJobParameters, + HarvestDataCreateOrUpdateParameters, + HarvestDataDeleteParameters, + HarvestDataGetCascadeDeleteJobDetailsParameters, + HarvestDataGetParameters, + HarvestDataListByFarmerIdParameters, + HarvestDataListParameters, + ImageProcessingCreateRasterizeJobParameters, + ImageProcessingGetRasterizeJobParameters, + OAuthProvidersCreateCascadeDeleteJobParameters, + OAuthProvidersCreateOrUpdateParameters, + OAuthProvidersDeleteParameters, + OAuthProvidersGetCascadeDeleteJobDetailsParameters, + OAuthProvidersGetParameters, + OAuthProvidersListParameters, + OAuthTokensCreateCascadeDeleteJobParameters, + OAuthTokensGetCascadeDeleteJobDetailsParameters, + OAuthTokensGetOAuthConnectionLinkParameters, + OAuthTokensListParameters, + PlantingDataCreateCascadeDeleteJobParameters, + PlantingDataCreateOrUpdateParameters, + PlantingDataDeleteParameters, + PlantingDataGetCascadeDeleteJobDetailsParameters, + PlantingDataGetParameters, + PlantingDataListByFarmerIdParameters, + PlantingDataListParameters, + ScenesCreateSatelliteDataIngestionJobParameters, + ScenesDownloadParameters, + ScenesGetSatelliteDataIngestionJobDetailsParameters, + ScenesListParameters, + SeasonalFieldsCreateCascadeDeleteJobParameters, + SeasonalFieldsCreateOrUpdateParameters, + SeasonalFieldsDeleteParameters, + SeasonalFieldsGetCascadeDeleteJobDetailsParameters, + SeasonalFieldsGetParameters, + SeasonalFieldsListByFarmerIdParameters, + SeasonalFieldsListParameters, + SeasonsCreateOrUpdateParameters, + SeasonsDeleteParameters, + SeasonsGetParameters, + SeasonsListParameters, + TillageDataCreateCascadeDeleteJobParameters, + TillageDataCreateOrUpdateParameters, + TillageDataDeleteParameters, + TillageDataGetCascadeDeleteJobDetailsParameters, + TillageDataGetParameters, + TillageDataListByFarmerIdParameters, + TillageDataListParameters, + WeatherCreateDataDeleteJobParameters, + WeatherCreateDataIngestionJobParameters, + WeatherGetDataDeleteJobDetailsParameters, + WeatherGetDataIngestionJobDetailsParameters, + WeatherListParameters, +} from "./parameters"; +import { + ApplicationDataCreateCascadeDeleteJob202Response, + ApplicationDataCreateCascadeDeleteJobdefaultResponse, + ApplicationDataCreateOrUpdate200Response, + ApplicationDataCreateOrUpdate201Response, + ApplicationDataCreateOrUpdatedefaultResponse, + ApplicationDataDelete204Response, + ApplicationDataDeletedefaultResponse, + ApplicationDataGet200Response, + ApplicationDataGetCascadeDeleteJobDetails200Response, + ApplicationDataGetCascadeDeleteJobDetailsdefaultResponse, + ApplicationDataGetdefaultResponse, + ApplicationDataList200Response, + ApplicationDataListByFarmerId200Response, + ApplicationDataListByFarmerIddefaultResponse, + ApplicationDataListdefaultResponse, + AttachmentsCreateOrUpdate200Response, + AttachmentsCreateOrUpdate201Response, + AttachmentsCreateOrUpdatedefaultResponse, + AttachmentsDelete204Response, + AttachmentsDeletedefaultResponse, + AttachmentsDownload200Response, + AttachmentsDownloaddefaultResponse, + AttachmentsGet200Response, + AttachmentsGetdefaultResponse, + AttachmentsListByFarmerId200Response, + AttachmentsListByFarmerIddefaultResponse, + BoundariesCreateCascadeDeleteJob202Response, + BoundariesCreateCascadeDeleteJobdefaultResponse, + BoundariesCreateOrUpdate200Response, + BoundariesCreateOrUpdate201Response, + BoundariesCreateOrUpdatedefaultResponse, + BoundariesDelete204Response, + BoundariesDeletedefaultResponse, + BoundariesGet200Response, + BoundariesGetCascadeDeleteJobDetails200Response, + BoundariesGetCascadeDeleteJobDetailsdefaultResponse, + BoundariesGetOverlap200Response, + BoundariesGetOverlapdefaultResponse, + BoundariesGetdefaultResponse, + BoundariesList200Response, + BoundariesListByFarmerId200Response, + BoundariesListByFarmerIddefaultResponse, + BoundariesListdefaultResponse, + BoundariesSearch200Response, + BoundariesSearchByFarmerId200Response, + BoundariesSearchByFarmerIddefaultResponse, + BoundariesSearchdefaultResponse, + CropVarietiesCreateOrUpdate200Response, + CropVarietiesCreateOrUpdate201Response, + CropVarietiesCreateOrUpdatedefaultResponse, + CropVarietiesDelete204Response, + CropVarietiesDeletedefaultResponse, + CropVarietiesGet200Response, + CropVarietiesGetdefaultResponse, + CropVarietiesList200Response, + CropVarietiesListByCropId200Response, + CropVarietiesListByCropIddefaultResponse, + CropVarietiesListdefaultResponse, + CropsCreateOrUpdate200Response, + CropsCreateOrUpdate201Response, + CropsCreateOrUpdatedefaultResponse, + CropsDelete204Response, + CropsDeletedefaultResponse, + CropsGet200Response, + CropsGetdefaultResponse, + CropsList200Response, + CropsListdefaultResponse, + FarmOperationsCreateDataIngestionJob202Response, + FarmOperationsCreateDataIngestionJobdefaultResponse, + FarmOperationsGetDataIngestionJobDetails200Response, + FarmOperationsGetDataIngestionJobDetailsdefaultResponse, + FarmersCreateCascadeDeleteJob202Response, + FarmersCreateCascadeDeleteJobdefaultResponse, + FarmersCreateOrUpdate200Response, + FarmersCreateOrUpdate201Response, + FarmersCreateOrUpdatedefaultResponse, + FarmersDelete204Response, + FarmersDeletedefaultResponse, + FarmersGet200Response, + FarmersGetCascadeDeleteJobDetails200Response, + FarmersGetCascadeDeleteJobDetailsdefaultResponse, + FarmersGetdefaultResponse, + FarmersList200Response, + FarmersListdefaultResponse, + FarmsCreateCascadeDeleteJob202Response, + FarmsCreateCascadeDeleteJobdefaultResponse, + FarmsCreateOrUpdate200Response, + FarmsCreateOrUpdate201Response, + FarmsCreateOrUpdatedefaultResponse, + FarmsDelete204Response, + FarmsDeletedefaultResponse, + FarmsGet200Response, + FarmsGetCascadeDeleteJobDetails200Response, + FarmsGetCascadeDeleteJobDetailsdefaultResponse, + FarmsGetdefaultResponse, + FarmsList200Response, + FarmsListByFarmerId200Response, + FarmsListByFarmerIddefaultResponse, + FarmsListdefaultResponse, + FieldsCreateCascadeDeleteJob202Response, + FieldsCreateCascadeDeleteJobdefaultResponse, + FieldsCreateOrUpdate200Response, + FieldsCreateOrUpdate201Response, + FieldsCreateOrUpdatedefaultResponse, + FieldsDelete204Response, + FieldsDeletedefaultResponse, + FieldsGet200Response, + FieldsGetCascadeDeleteJobDetails200Response, + FieldsGetCascadeDeleteJobDetailsdefaultResponse, + FieldsGetdefaultResponse, + FieldsList200Response, + FieldsListByFarmerId200Response, + FieldsListByFarmerIddefaultResponse, + FieldsListdefaultResponse, + HarvestDataCreateCascadeDeleteJob202Response, + HarvestDataCreateCascadeDeleteJobdefaultResponse, + HarvestDataCreateOrUpdate200Response, + HarvestDataCreateOrUpdate201Response, + HarvestDataCreateOrUpdatedefaultResponse, + HarvestDataDelete204Response, + HarvestDataDeletedefaultResponse, + HarvestDataGet200Response, + HarvestDataGetCascadeDeleteJobDetails200Response, + HarvestDataGetCascadeDeleteJobDetailsdefaultResponse, + HarvestDataGetdefaultResponse, + HarvestDataList200Response, + HarvestDataListByFarmerId200Response, + HarvestDataListByFarmerIddefaultResponse, + HarvestDataListdefaultResponse, + ImageProcessingCreateRasterizeJob202Response, + ImageProcessingCreateRasterizeJobdefaultResponse, + ImageProcessingGetRasterizeJob200Response, + OAuthProvidersCreateCascadeDeleteJob202Response, + OAuthProvidersCreateCascadeDeleteJobdefaultResponse, + OAuthProvidersCreateOrUpdate200Response, + OAuthProvidersCreateOrUpdate201Response, + OAuthProvidersCreateOrUpdatedefaultResponse, + OAuthProvidersDelete204Response, + OAuthProvidersDeletedefaultResponse, + OAuthProvidersGet200Response, + OAuthProvidersGetCascadeDeleteJobDetails200Response, + OAuthProvidersGetCascadeDeleteJobDetailsdefaultResponse, + OAuthProvidersGetdefaultResponse, + OAuthProvidersList200Response, + OAuthProvidersListdefaultResponse, + OAuthTokensCreateCascadeDeleteJob202Response, + OAuthTokensCreateCascadeDeleteJobdefaultResponse, + OAuthTokensGetCascadeDeleteJobDetails200Response, + OAuthTokensGetCascadeDeleteJobDetailsdefaultResponse, + OAuthTokensGetOAuthConnectionLink200Response, + OAuthTokensGetOAuthConnectionLinkdefaultResponse, + OAuthTokensList200Response, + OAuthTokensListdefaultResponse, + PlantingDataCreateCascadeDeleteJob202Response, + PlantingDataCreateCascadeDeleteJobdefaultResponse, + PlantingDataCreateOrUpdate200Response, + PlantingDataCreateOrUpdate201Response, + PlantingDataCreateOrUpdatedefaultResponse, + PlantingDataDelete204Response, + PlantingDataDeletedefaultResponse, + PlantingDataGet200Response, + PlantingDataGetCascadeDeleteJobDetails200Response, + PlantingDataGetCascadeDeleteJobDetailsdefaultResponse, + PlantingDataGetdefaultResponse, + PlantingDataList200Response, + PlantingDataListByFarmerId200Response, + PlantingDataListByFarmerIddefaultResponse, + PlantingDataListdefaultResponse, + ScenesCreateSatelliteDataIngestionJob202Response, + ScenesCreateSatelliteDataIngestionJobdefaultResponse, + ScenesDownload200Response, + ScenesDownloaddefaultResponse, + ScenesGetSatelliteDataIngestionJobDetails200Response, + ScenesGetSatelliteDataIngestionJobDetailsdefaultResponse, + ScenesList200Response, + ScenesListdefaultResponse, + SeasonalFieldsCreateCascadeDeleteJob202Response, + SeasonalFieldsCreateCascadeDeleteJobdefaultResponse, + SeasonalFieldsCreateOrUpdate200Response, + SeasonalFieldsCreateOrUpdate201Response, + SeasonalFieldsCreateOrUpdatedefaultResponse, + SeasonalFieldsDelete204Response, + SeasonalFieldsDeletedefaultResponse, + SeasonalFieldsGet200Response, + SeasonalFieldsGetCascadeDeleteJobDetails200Response, + SeasonalFieldsGetCascadeDeleteJobDetailsdefaultResponse, + SeasonalFieldsGetdefaultResponse, + SeasonalFieldsList200Response, + SeasonalFieldsListByFarmerId200Response, + SeasonalFieldsListByFarmerIddefaultResponse, + SeasonalFieldsListdefaultResponse, + SeasonsCreateOrUpdate200Response, + SeasonsCreateOrUpdate201Response, + SeasonsCreateOrUpdatedefaultResponse, + SeasonsDelete204Response, + SeasonsDeletedefaultResponse, + SeasonsGet200Response, + SeasonsGetdefaultResponse, + SeasonsList200Response, + SeasonsListdefaultResponse, + TillageDataCreateCascadeDeleteJob202Response, + TillageDataCreateCascadeDeleteJobdefaultResponse, + TillageDataCreateOrUpdate200Response, + TillageDataCreateOrUpdate201Response, + TillageDataCreateOrUpdatedefaultResponse, + TillageDataDelete204Response, + TillageDataDeletedefaultResponse, + TillageDataGet200Response, + TillageDataGetCascadeDeleteJobDetails200Response, + TillageDataGetCascadeDeleteJobDetailsdefaultResponse, + TillageDataGetdefaultResponse, + TillageDataList200Response, + TillageDataListByFarmerId200Response, + TillageDataListByFarmerIddefaultResponse, + TillageDataListdefaultResponse, + WeatherCreateDataDeleteJob202Response, + WeatherCreateDataDeleteJobdefaultResponse, + WeatherCreateDataIngestionJob202Response, + WeatherCreateDataIngestionJobdefaultResponse, + WeatherGetDataDeleteJobDetails200Response, + WeatherGetDataDeleteJobDetailsdefaultResponse, + WeatherGetDataIngestionJobDetails200Response, + WeatherGetDataIngestionJobDetailsdefaultResponse, + WeatherList200Response, + WeatherListdefaultResponse, +} from "./responses"; +import { Client } from "@azure-rest/core-client"; + +export interface ApplicationDataListByFarmerId { + /** + * Get a paginated list of application data resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: ApplicationDataListByFarmerIdParameters + ): Promise< + ApplicationDataListByFarmerId200Response | ApplicationDataListByFarmerIddefaultResponse + >; +} + +export interface ApplicationDataList { + /** + * Get a paginated list of application data resources across all the farmers for a given search criteria. + * + * + * ###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: ApplicationDataListParameters + ): Promise; +} + +export interface ApplicationDataGet { + /** + * Get a specified application data resource for a given farmer. + * + * + */ + get( + options?: ApplicationDataGetParameters + ): Promise; + /** + * Create or update an application data resource for a given farmer. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + patch( + options?: ApplicationDataCreateOrUpdateParameters + ): Promise< + | ApplicationDataCreateOrUpdate200Response + | ApplicationDataCreateOrUpdate201Response + | ApplicationDataCreateOrUpdatedefaultResponse + >; + /** + * Delete a specified application data resource for a given farmer. + * + * + */ + delete( + options?: ApplicationDataDeleteParameters + ): Promise; +} + +export interface ApplicationDataGetCascadeDeleteJobDetails { + /** + * Get details of a cascade delete job for application data resource. + * + * + */ + get( + options?: ApplicationDataGetCascadeDeleteJobDetailsParameters + ): Promise< + | ApplicationDataGetCascadeDeleteJobDetails200Response + | ApplicationDataGetCascadeDeleteJobDetailsdefaultResponse + >; + /** + * Create cascade delete job for application data resource. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ + put( + options: ApplicationDataCreateCascadeDeleteJobParameters + ): Promise< + | ApplicationDataCreateCascadeDeleteJob202Response + | ApplicationDataCreateCascadeDeleteJobdefaultResponse + >; +} + +export interface AttachmentsListByFarmerId { + /** + * Get a paginated list of attachment resources for a given farmer and search criteria. + * + * + */ + get( + options?: AttachmentsListByFarmerIdParameters + ): Promise; +} + +export interface AttachmentsGet { + /** + * Get a specified attachment resource for a given farmer. + * + * + */ + get( + options?: AttachmentsGetParameters + ): Promise; + /** + * Create or update an attachment resource for a given farmer. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * + * + */ + patch( + options?: AttachmentsCreateOrUpdateParameters + ): Promise< + | AttachmentsCreateOrUpdate200Response + | AttachmentsCreateOrUpdate201Response + | AttachmentsCreateOrUpdatedefaultResponse + >; + /** + * Delete a specified attachment resource for a given farmer. + * + * + */ + delete( + options?: AttachmentsDeleteParameters + ): Promise; +} + +export interface AttachmentsDownload { + /** + * Return attachment as a file stream for a given input filePath. + * + * + */ + get( + options?: AttachmentsDownloadParameters + ): Promise; +} + +export interface BoundariesListByFarmerId { + /** + * Get a paginated list of boundary resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: BoundariesListByFarmerIdParameters + ): Promise; + /** + * Search for boundaries of a farmer intersecting with a given geometry. + * This API is expected to be used when users want to find boundaries that intersect with a given geometry. Otherwise, this is functionally same as 'List by Farmer Id' API for boundaries. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + post( + options?: BoundariesSearchByFarmerIdParameters + ): Promise; +} + +export interface BoundariesList { + /** + * Get a paginated list of boundary resources across all the farmers for a given search criteria. + * + * + * ###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: BoundariesListParameters + ): Promise; + /** + * Search for boundaries across all the farmers intersecting with a given geometry. + * This API is expected to be used when users want to find boundaries that intersect with a given geometry. Otherwise, this is functionally same as 'List' API for boundaries. + * + * + * + * + * ###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘Search by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + post( + options?: BoundariesSearchParameters + ): Promise; +} + +export interface BoundariesGetCascadeDeleteJobDetails { + /** + * Get details of cascade delete job for a specified boundary. + * + * + */ + get( + options?: BoundariesGetCascadeDeleteJobDetailsParameters + ): Promise< + | BoundariesGetCascadeDeleteJobDetails200Response + | BoundariesGetCascadeDeleteJobDetailsdefaultResponse + >; + /** + * Create a cascade delete job for a specified boundary. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ + put( + options: BoundariesCreateCascadeDeleteJobParameters + ): Promise< + BoundariesCreateCascadeDeleteJob202Response | BoundariesCreateCascadeDeleteJobdefaultResponse + >; +} + +export interface BoundariesGet { + /** + * Get a specified boundary resource for a given farmer. + * + * + */ + get( + options?: BoundariesGetParameters + ): Promise; + /** + * Create or update a boundary resource. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + patch( + options?: BoundariesCreateOrUpdateParameters + ): Promise< + | BoundariesCreateOrUpdate200Response + | BoundariesCreateOrUpdate201Response + | BoundariesCreateOrUpdatedefaultResponse + >; + /** + * Delete a specified boundary resource for a given farmer. It can only be deleted if it has no linked attachments, satellite or weather data. + * + * + */ + delete( + options?: BoundariesDeleteParameters + ): Promise; +} + +export interface BoundariesGetOverlap { + /** + * Get overlapping (intersecting) acreage between two boundaries. + * + * + */ + get( + options: BoundariesGetOverlapParameters + ): Promise; +} + +export interface CropsList { + /** + * Get a paginated list of crop resources. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get(options?: CropsListParameters): Promise; +} + +export interface CropsGet { + /** + * Get a specified crop resource. + * + * + */ + get(options?: CropsGetParameters): Promise; + /** + * Create or update a crop resource. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + patch( + options?: CropsCreateOrUpdateParameters + ): Promise< + | CropsCreateOrUpdate200Response + | CropsCreateOrUpdate201Response + | CropsCreateOrUpdatedefaultResponse + >; + /** + * Delete a specified crop resource. + * + * + */ + delete( + options?: CropsDeleteParameters + ): Promise; +} + +export interface CropVarietiesListByCropId { + /** + * Get a paginated list of crop variety resources for a given crop and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: CropVarietiesListByCropIdParameters + ): Promise; +} + +export interface CropVarietiesList { + /** + * Get a paginated list of crop variety resources across all the crops for a given search criteria. + * + * + * ###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the crop Id is available, it is strongly recommended to use **‘List by Crop Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: CropVarietiesListParameters + ): Promise; +} + +export interface CropVarietiesGet { + /** + * Get a specified crop variety resource for a given crop. + * + * + */ + get( + options?: CropVarietiesGetParameters + ): Promise; + /** + * Create or update a crop variety resource. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + patch( + options?: CropVarietiesCreateOrUpdateParameters + ): Promise< + | CropVarietiesCreateOrUpdate200Response + | CropVarietiesCreateOrUpdate201Response + | CropVarietiesCreateOrUpdatedefaultResponse + >; + /** + * Delete a specified crop variety resource for a given crop. + * + * + */ + delete( + options?: CropVarietiesDeleteParameters + ): Promise; +} + +export interface FarmersList { + /** + * Get a paginated list of farmer resources for a given search criteria. + * + * + */ + get( + options?: FarmersListParameters + ): Promise; +} + +export interface FarmersGet { + /** + * Get a specified farmer resource. + * + * + */ + get(options?: FarmersGetParameters): Promise; + /** + * Create or update a farmer resource. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + patch( + options?: FarmersCreateOrUpdateParameters + ): Promise< + | FarmersCreateOrUpdate200Response + | FarmersCreateOrUpdate201Response + | FarmersCreateOrUpdatedefaultResponse + >; + /** + * Delete a specified farmer resource. It can only be deleted if it has no linked attachments or farms. + * + * + */ + delete( + options?: FarmersDeleteParameters + ): Promise; +} + +export interface FarmersGetCascadeDeleteJobDetails { + /** + * Get details of a cascade delete job for a specified farmer. + * + * + */ + get( + options?: FarmersGetCascadeDeleteJobDetailsParameters + ): Promise< + FarmersGetCascadeDeleteJobDetails200Response | FarmersGetCascadeDeleteJobDetailsdefaultResponse + >; + /** + * Create a cascade delete job for a specified farmer. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ + put( + options: FarmersCreateCascadeDeleteJobParameters + ): Promise< + FarmersCreateCascadeDeleteJob202Response | FarmersCreateCascadeDeleteJobdefaultResponse + >; +} + +export interface FarmOperationsCreateDataIngestionJob { + /** + * Create a farm operation data ingestion job. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + put( + options?: FarmOperationsCreateDataIngestionJobParameters + ): Promise< + | FarmOperationsCreateDataIngestionJob202Response + | FarmOperationsCreateDataIngestionJobdefaultResponse + >; + /** + * Get details of a farm operation data ingestion job. + * + * + */ + get( + options?: FarmOperationsGetDataIngestionJobDetailsParameters + ): Promise< + | FarmOperationsGetDataIngestionJobDetails200Response + | FarmOperationsGetDataIngestionJobDetailsdefaultResponse + >; +} + +export interface FarmsListByFarmerId { + /** + * Get a paginated list of farm resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: FarmsListByFarmerIdParameters + ): Promise; +} + +export interface FarmsList { + /** + * Get a paginated list of farm resources across all the farmers for a given search criteria. + * + * + * ###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get(options?: FarmsListParameters): Promise; +} + +export interface FarmsGet { + /** + * Get a specified farm resource for a given farmer. + * + * + */ + get(options?: FarmsGetParameters): Promise; + /** + * Create or update a farm resource for a given farmer. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + patch( + options?: FarmsCreateOrUpdateParameters + ): Promise< + | FarmsCreateOrUpdate200Response + | FarmsCreateOrUpdate201Response + | FarmsCreateOrUpdatedefaultResponse + >; + /** + * Delete a specified farm resource for a given farmer. It can only be deleted if it has no linked attachments, fields or seasonal fields. + * + * + */ + delete( + options?: FarmsDeleteParameters + ): Promise; +} + +export interface FarmsGetCascadeDeleteJobDetails { + /** + * Get details of cascade delete job for a specified farm. + * + * + */ + get( + options?: FarmsGetCascadeDeleteJobDetailsParameters + ): Promise< + FarmsGetCascadeDeleteJobDetails200Response | FarmsGetCascadeDeleteJobDetailsdefaultResponse + >; + /** + * Create a cascade delete job for a specified farm. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ + put( + options: FarmsCreateCascadeDeleteJobParameters + ): Promise; +} + +export interface FieldsListByFarmerId { + /** + * Get a paginated list of field resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: FieldsListByFarmerIdParameters + ): Promise; +} + +export interface FieldsList { + /** + * Get a paginated list of field resources across all the farmers for a given search criteria. + * + * + * ###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get(options?: FieldsListParameters): Promise; +} + +export interface FieldsGet { + /** + * Get a specified field resource for a given farmer. + * + * + */ + get(options?: FieldsGetParameters): Promise; + /** + * Create or update a field resource for a given farmer. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + patch( + options?: FieldsCreateOrUpdateParameters + ): Promise< + | FieldsCreateOrUpdate200Response + | FieldsCreateOrUpdate201Response + | FieldsCreateOrUpdatedefaultResponse + >; + /** + * Delete a specified field resource for a given farmer. It can only be deleted if it has no linked attachments, boundaries or seasonal fields. + * + * + */ + delete( + options?: FieldsDeleteParameters + ): Promise; +} + +export interface FieldsGetCascadeDeleteJobDetails { + /** + * Get details of cascade delete job for a specified field. + * + * + */ + get( + options?: FieldsGetCascadeDeleteJobDetailsParameters + ): Promise< + FieldsGetCascadeDeleteJobDetails200Response | FieldsGetCascadeDeleteJobDetailsdefaultResponse + >; + /** + * Create a cascade delete job for specified field. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ + put( + options: FieldsCreateCascadeDeleteJobParameters + ): Promise; +} + +export interface HarvestDataListByFarmerId { + /** + * Get a paginated list of harvest data resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: HarvestDataListByFarmerIdParameters + ): Promise; +} + +export interface HarvestDataList { + /** + * Get a paginated list of harvest data resources across all the farmers for a given search criteria. + * + * + * ###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: HarvestDataListParameters + ): Promise; +} + +export interface HarvestDataGet { + /** + * Get a specified harvest data resource for a given farmer. + * + * + */ + get( + options?: HarvestDataGetParameters + ): Promise; + /** + * Create or update harvest data resource for a given farmer. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + patch( + options?: HarvestDataCreateOrUpdateParameters + ): Promise< + | HarvestDataCreateOrUpdate200Response + | HarvestDataCreateOrUpdate201Response + | HarvestDataCreateOrUpdatedefaultResponse + >; + /** + * Delete a specified harvest data resource for a given farmer. + * + * + */ + delete( + options?: HarvestDataDeleteParameters + ): Promise; +} + +export interface HarvestDataGetCascadeDeleteJobDetails { + /** + * Get details of a cascade delete job for harvest data resource. + * + * + */ + get( + options?: HarvestDataGetCascadeDeleteJobDetailsParameters + ): Promise< + | HarvestDataGetCascadeDeleteJobDetails200Response + | HarvestDataGetCascadeDeleteJobDetailsdefaultResponse + >; + /** + * Create cascade delete job for harvest data resource. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ + put( + options: HarvestDataCreateCascadeDeleteJobParameters + ): Promise< + HarvestDataCreateCascadeDeleteJob202Response | HarvestDataCreateCascadeDeleteJobdefaultResponse + >; +} + +export interface ImageProcessingCreateRasterizeJob { + /** + * Create a job which converts shape files into raster images. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + put( + options?: ImageProcessingCreateRasterizeJobParameters + ): Promise< + ImageProcessingCreateRasterizeJob202Response | ImageProcessingCreateRasterizeJobdefaultResponse + >; + /** + * Get details of rasterize job. Rasterize job converts shape files into raster images. + * + * + */ + get( + options?: ImageProcessingGetRasterizeJobParameters + ): Promise; +} + +export interface OAuthProvidersList { + /** + * Get a paginated list of OAuth provider resources for a given search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: OAuthProvidersListParameters + ): Promise; +} + +export interface OAuthProvidersGet { + /** + * Get a specified OAuth provider resource. + * + * + */ + get( + options?: OAuthProvidersGetParameters + ): Promise; + /** + * Create or update an OAuth provider resource. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + patch( + options?: OAuthProvidersCreateOrUpdateParameters + ): Promise< + | OAuthProvidersCreateOrUpdate200Response + | OAuthProvidersCreateOrUpdate201Response + | OAuthProvidersCreateOrUpdatedefaultResponse + >; + /** + * Delete a specified OAuth provider resource. + * + * + */ + delete( + options?: OAuthProvidersDeleteParameters + ): Promise; +} + +export interface OAuthProvidersGetCascadeDeleteJobDetails { + /** + * Get details of cascade delete job for an OAuth provider resource. + * + * + */ + get( + options?: OAuthProvidersGetCascadeDeleteJobDetailsParameters + ): Promise< + | OAuthProvidersGetCascadeDeleteJobDetails200Response + | OAuthProvidersGetCascadeDeleteJobDetailsdefaultResponse + >; + /** + * Create cascade delete job for an OAuth provider resource. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ + put( + options: OAuthProvidersCreateCascadeDeleteJobParameters + ): Promise< + | OAuthProvidersCreateCascadeDeleteJob202Response + | OAuthProvidersCreateCascadeDeleteJobdefaultResponse + >; +} + +export interface OAuthTokensList { + /** + * Get a list of OAuthToken documents for a given search criteria. + * + * + */ + get( + options?: OAuthTokensListParameters + ): Promise; +} + +export interface OAuthTokensGetOAuthConnectionLink { + /** + * Get connection link needed in the OAuth flow. + * + * + */ + post( + options?: OAuthTokensGetOAuthConnectionLinkParameters + ): Promise< + OAuthTokensGetOAuthConnectionLink200Response | OAuthTokensGetOAuthConnectionLinkdefaultResponse + >; +} + +export interface OAuthTokensGetCascadeDeleteJobDetails { + /** + * Get details of OAuth token remove job. + * + * + */ + get( + options?: OAuthTokensGetCascadeDeleteJobDetailsParameters + ): Promise< + | OAuthTokensGetCascadeDeleteJobDetails200Response + | OAuthTokensGetCascadeDeleteJobDetailsdefaultResponse + >; + /** + * Create job to remove OAuth token. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ + put( + options: OAuthTokensCreateCascadeDeleteJobParameters + ): Promise< + OAuthTokensCreateCascadeDeleteJob202Response | OAuthTokensCreateCascadeDeleteJobdefaultResponse + >; +} + +export interface PlantingDataListByFarmerId { + /** + * Get a paginated list of planting data resources for a given farm and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: PlantingDataListByFarmerIdParameters + ): Promise; +} + +export interface PlantingDataList { + /** + * Get a paginated list of planting data resources across all the farmers for a given search criteria. + * + * + * ###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: PlantingDataListParameters + ): Promise; +} + +export interface PlantingDataGet { + /** + * Get a specified planting data resource for a given farmer. + * + * + */ + get( + options?: PlantingDataGetParameters + ): Promise; + /** + * Create or update a planting data resource for a given farmer. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + patch( + options?: PlantingDataCreateOrUpdateParameters + ): Promise< + | PlantingDataCreateOrUpdate200Response + | PlantingDataCreateOrUpdate201Response + | PlantingDataCreateOrUpdatedefaultResponse + >; + /** + * Delete a specified planting data resource under a particular farmer. + * + * + */ + delete( + options?: PlantingDataDeleteParameters + ): Promise; +} + +export interface PlantingDataGetCascadeDeleteJobDetails { + /** + * Get details of a cascade delete job for planting data resource. + * + * + */ + get( + options?: PlantingDataGetCascadeDeleteJobDetailsParameters + ): Promise< + | PlantingDataGetCascadeDeleteJobDetails200Response + | PlantingDataGetCascadeDeleteJobDetailsdefaultResponse + >; + /** + * Create cascade delete job for planting data resource. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ + put( + options: PlantingDataCreateCascadeDeleteJobParameters + ): Promise< + | PlantingDataCreateCascadeDeleteJob202Response + | PlantingDataCreateCascadeDeleteJobdefaultResponse + >; +} + +export interface ScenesList { + /** + * Get a paginated list of scene resources for a given search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * 2. This API will retrieve scenes present in the FarmBeats datastore and does not ingest new data. Example: a user has ingested satellite data from 1st of Jan 2019 to 30th of June 2019. However, using the current API, the user has asked for data from 1st of Jan 2019 to 31st of December 2019. In such a case, only data for the first 6 months is returned to the user. + * + * + */ + get(options: ScenesListParameters): Promise; +} + +export interface ScenesCreateSatelliteDataIngestionJob { + /** + * Create a satellite data ingestion job. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + put( + options?: ScenesCreateSatelliteDataIngestionJobParameters + ): Promise< + | ScenesCreateSatelliteDataIngestionJob202Response + | ScenesCreateSatelliteDataIngestionJobdefaultResponse + >; + /** + * Get details of a satellite data ingestion job. + * + * + */ + get( + options?: ScenesGetSatelliteDataIngestionJobDetailsParameters + ): Promise< + | ScenesGetSatelliteDataIngestionJobDetails200Response + | ScenesGetSatelliteDataIngestionJobDetailsdefaultResponse + >; +} + +export interface ScenesDownload { + /** + * Return scenes as a file stream for a given input filePath. + * + * + */ + get( + options: ScenesDownloadParameters + ): Promise; +} + +export interface SeasonalFieldsListByFarmerId { + /** + * Get a paginated list of seasonal field resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: SeasonalFieldsListByFarmerIdParameters + ): Promise; +} + +export interface SeasonalFieldsList { + /** + * Get a paginated list of seasonal field resources across all the farmers for a given search criteria. + * + * + * ###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: SeasonalFieldsListParameters + ): Promise; +} + +export interface SeasonalFieldsGet { + /** + * Get a specified seasonal field resource for a given farmer. + * + * + */ + get( + options?: SeasonalFieldsGetParameters + ): Promise; + /** + * Create or update a seasonal field resource for a given farmer. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + patch( + options?: SeasonalFieldsCreateOrUpdateParameters + ): Promise< + | SeasonalFieldsCreateOrUpdate200Response + | SeasonalFieldsCreateOrUpdate201Response + | SeasonalFieldsCreateOrUpdatedefaultResponse + >; + /** + * Delete a specified seasonal field resource for a given farmer. It can only be deleted if it has no linked attachments or boundaries. + * + * + */ + delete( + options?: SeasonalFieldsDeleteParameters + ): Promise; +} + +export interface SeasonalFieldsGetCascadeDeleteJobDetails { + /** + * Get details of cascade delete job for a specified seasonal field. + * + * + */ + get( + options?: SeasonalFieldsGetCascadeDeleteJobDetailsParameters + ): Promise< + | SeasonalFieldsGetCascadeDeleteJobDetails200Response + | SeasonalFieldsGetCascadeDeleteJobDetailsdefaultResponse + >; + /** + * Create a cascade delete job for a specified seasonal field. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ + put( + options: SeasonalFieldsCreateCascadeDeleteJobParameters + ): Promise< + | SeasonalFieldsCreateCascadeDeleteJob202Response + | SeasonalFieldsCreateCascadeDeleteJobdefaultResponse + >; +} + +export interface SeasonsList { + /** + * Get a paginated list of season resources. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: SeasonsListParameters + ): Promise; +} + +export interface SeasonsGet { + /** + * Get a specified season resource. + * + * + */ + get(options?: SeasonsGetParameters): Promise; + /** + * Create or update a season resource. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + patch( + options?: SeasonsCreateOrUpdateParameters + ): Promise< + | SeasonsCreateOrUpdate200Response + | SeasonsCreateOrUpdate201Response + | SeasonsCreateOrUpdatedefaultResponse + >; + /** + * Delete a specified season resource. + * + * + */ + delete( + options?: SeasonsDeleteParameters + ): Promise; +} + +export interface TillageDataListByFarmerId { + /** + * Get a paginated list of tillage data resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: TillageDataListByFarmerIdParameters + ): Promise; +} + +export interface TillageDataList { + /** + * Get a paginated list of tillage data resources across all the farmers for a given search criteria. + * + * + * ###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ + get( + options?: TillageDataListParameters + ): Promise; +} + +export interface TillageDataGet { + /** + * Get a specified tillage data resource for a given farmer. + * + * + */ + get( + options?: TillageDataGetParameters + ): Promise; + /** + * Create or update a tillage data resource for a given farmer. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + patch( + options?: TillageDataCreateOrUpdateParameters + ): Promise< + | TillageDataCreateOrUpdate200Response + | TillageDataCreateOrUpdate201Response + | TillageDataCreateOrUpdatedefaultResponse + >; + /** + * Delete a specified tillage data resource for a given farmer. + * + * + */ + delete( + options?: TillageDataDeleteParameters + ): Promise; +} + +export interface TillageDataGetCascadeDeleteJobDetails { + /** + * Get details of a cascade delete job for tillage data resource. + * + * + */ + get( + options?: TillageDataGetCascadeDeleteJobDetailsParameters + ): Promise< + | TillageDataGetCascadeDeleteJobDetails200Response + | TillageDataGetCascadeDeleteJobDetailsdefaultResponse + >; + /** + * Create cascade delete job for tillage data resource. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ + put( + options: TillageDataCreateCascadeDeleteJobParameters + ): Promise< + TillageDataCreateCascadeDeleteJob202Response | TillageDataCreateCascadeDeleteJobdefaultResponse + >; +} + +export interface WeatherList { + /** + * Get a paginated list of weather data resources for a given search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * 2. This API will retrieve weather data present in the FarmBeats datastore and does not ingest new data. Example: a user has ingested historical weather data from 1st of Jan 2019 to 30th of June 2019. However, using the current API, the user has asked for historical data from 1st of Jan 2019 to 31st of December 2019. In such a case, only data for the first 6 months is returned to the user. + * + * + */ + get(options: WeatherListParameters): Promise; +} + +export interface WeatherGetDataIngestionJobDetails { + /** + * Get details of a weather data ingestion job. + * + * + */ + get( + options?: WeatherGetDataIngestionJobDetailsParameters + ): Promise< + WeatherGetDataIngestionJobDetails200Response | WeatherGetDataIngestionJobDetailsdefaultResponse + >; + /** + * Create a weather data ingestion job. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + put( + options?: WeatherCreateDataIngestionJobParameters + ): Promise< + WeatherCreateDataIngestionJob202Response | WeatherCreateDataIngestionJobdefaultResponse + >; +} + +export interface WeatherGetDataDeleteJobDetails { + /** + * Get details of a weather data delete job. + * + * + */ + get( + options?: WeatherGetDataDeleteJobDetailsParameters + ): Promise< + WeatherGetDataDeleteJobDetails200Response | WeatherGetDataDeleteJobDetailsdefaultResponse + >; + /** + * Create a weather data delete job. + * + * +* ###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ + put( + options?: WeatherCreateDataDeleteJobParameters + ): Promise; +} + +export interface Routes { + /** Resource for '/farmers/\{farmerId\}/application-data' has methods for the following verbs: get */ + (path: "/farmers/{farmerId}/application-data", farmerId: string): ApplicationDataListByFarmerId; + /** Resource for '/application-data' has methods for the following verbs: get */ + (path: "/application-data"): ApplicationDataList; + /** Resource for '/farmers/\{farmerId\}/application-data/\{applicationDataId\}' has methods for the following verbs: get, patch, delete */ + ( + path: "/farmers/{farmerId}/application-data/{applicationDataId}", + farmerId: string, + applicationDataId: string + ): ApplicationDataGet; + /** Resource for '/application-data/cascade-delete/\{jobId\}' has methods for the following verbs: get, put */ + ( + path: "/application-data/cascade-delete/{jobId}", + jobId: string + ): ApplicationDataGetCascadeDeleteJobDetails; + /** Resource for '/farmers/\{farmerId\}/attachments' has methods for the following verbs: get */ + (path: "/farmers/{farmerId}/attachments", farmerId: string): AttachmentsListByFarmerId; + /** Resource for '/farmers/\{farmerId\}/attachments/\{attachmentId\}' has methods for the following verbs: get, patch, delete */ + ( + path: "/farmers/{farmerId}/attachments/{attachmentId}", + farmerId: string, + attachmentId: string + ): AttachmentsGet; + /** Resource for '/farmers/\{farmerId\}/attachments/\{attachmentId\}/file' has methods for the following verbs: get */ + ( + path: "/farmers/{farmerId}/attachments/{attachmentId}/file", + farmerId: string, + attachmentId: string + ): AttachmentsDownload; + /** Resource for '/farmers/\{farmerId\}/boundaries' has methods for the following verbs: get, post */ + (path: "/farmers/{farmerId}/boundaries", farmerId: string): BoundariesListByFarmerId; + /** Resource for '/boundaries' has methods for the following verbs: get, post */ + (path: "/boundaries"): BoundariesList; + /** Resource for '/boundaries/cascade-delete/\{jobId\}' has methods for the following verbs: get, put */ + (path: "/boundaries/cascade-delete/{jobId}", jobId: string): BoundariesGetCascadeDeleteJobDetails; + /** Resource for '/farmers/\{farmerId\}/boundaries/\{boundaryId\}' has methods for the following verbs: get, patch, delete */ + ( + path: "/farmers/{farmerId}/boundaries/{boundaryId}", + farmerId: string, + boundaryId: string + ): BoundariesGet; + /** Resource for '/farmers/\{farmerId\}/boundaries/\{boundaryId\}/overlap' has methods for the following verbs: get */ + ( + path: "/farmers/{farmerId}/boundaries/{boundaryId}/overlap", + farmerId: string, + boundaryId: string + ): BoundariesGetOverlap; + /** Resource for '/crops' has methods for the following verbs: get */ + (path: "/crops"): CropsList; + /** Resource for '/crops/\{cropId\}' has methods for the following verbs: get, patch, delete */ + (path: "/crops/{cropId}", cropId: string): CropsGet; + /** Resource for '/crops/\{cropId\}/crop-varieties' has methods for the following verbs: get */ + (path: "/crops/{cropId}/crop-varieties", cropId: string): CropVarietiesListByCropId; + /** Resource for '/crop-varieties' has methods for the following verbs: get */ + (path: "/crop-varieties"): CropVarietiesList; + /** Resource for '/crops/\{cropId\}/crop-varieties/\{cropVarietyId\}' has methods for the following verbs: get, patch, delete */ + ( + path: "/crops/{cropId}/crop-varieties/{cropVarietyId}", + cropId: string, + cropVarietyId: string + ): CropVarietiesGet; + /** Resource for '/farmers' has methods for the following verbs: get */ + (path: "/farmers"): FarmersList; + /** Resource for '/farmers/\{farmerId\}' has methods for the following verbs: get, patch, delete */ + (path: "/farmers/{farmerId}", farmerId: string): FarmersGet; + /** Resource for '/farmers/cascade-delete/\{jobId\}' has methods for the following verbs: get, put */ + (path: "/farmers/cascade-delete/{jobId}", jobId: string): FarmersGetCascadeDeleteJobDetails; + /** Resource for '/farm-operations/ingest-data/\{jobId\}' has methods for the following verbs: put, get */ + ( + path: "/farm-operations/ingest-data/{jobId}", + jobId: string + ): FarmOperationsCreateDataIngestionJob; + /** Resource for '/farmers/\{farmerId\}/farms' has methods for the following verbs: get */ + (path: "/farmers/{farmerId}/farms", farmerId: string): FarmsListByFarmerId; + /** Resource for '/farms' has methods for the following verbs: get */ + (path: "/farms"): FarmsList; + /** Resource for '/farmers/\{farmerId\}/farms/\{farmId\}' has methods for the following verbs: get, patch, delete */ + (path: "/farmers/{farmerId}/farms/{farmId}", farmerId: string, farmId: string): FarmsGet; + /** Resource for '/farms/cascade-delete/\{jobId\}' has methods for the following verbs: get, put */ + (path: "/farms/cascade-delete/{jobId}", jobId: string): FarmsGetCascadeDeleteJobDetails; + /** Resource for '/farmers/\{farmerId\}/fields' has methods for the following verbs: get */ + (path: "/farmers/{farmerId}/fields", farmerId: string): FieldsListByFarmerId; + /** Resource for '/fields' has methods for the following verbs: get */ + (path: "/fields"): FieldsList; + /** Resource for '/farmers/\{farmerId\}/fields/\{fieldId\}' has methods for the following verbs: get, patch, delete */ + (path: "/farmers/{farmerId}/fields/{fieldId}", farmerId: string, fieldId: string): FieldsGet; + /** Resource for '/fields/cascade-delete/\{jobId\}' has methods for the following verbs: get, put */ + (path: "/fields/cascade-delete/{jobId}", jobId: string): FieldsGetCascadeDeleteJobDetails; + /** Resource for '/farmers/\{farmerId\}/harvest-data' has methods for the following verbs: get */ + (path: "/farmers/{farmerId}/harvest-data", farmerId: string): HarvestDataListByFarmerId; + /** Resource for '/harvest-data' has methods for the following verbs: get */ + (path: "/harvest-data"): HarvestDataList; + /** Resource for '/farmers/\{farmerId\}/harvest-data/\{harvestDataId\}' has methods for the following verbs: get, patch, delete */ + ( + path: "/farmers/{farmerId}/harvest-data/{harvestDataId}", + farmerId: string, + harvestDataId: string + ): HarvestDataGet; + /** Resource for '/harvest-data/cascade-delete/\{jobId\}' has methods for the following verbs: get, put */ + ( + path: "/harvest-data/cascade-delete/{jobId}", + jobId: string + ): HarvestDataGetCascadeDeleteJobDetails; + /** Resource for '/image-processing/rasterize/\{jobId\}' has methods for the following verbs: put, get */ + (path: "/image-processing/rasterize/{jobId}", jobId: string): ImageProcessingCreateRasterizeJob; + /** Resource for '/oauth/providers' has methods for the following verbs: get */ + (path: "/oauth/providers"): OAuthProvidersList; + /** Resource for '/oauth/providers/\{oauthProviderId\}' has methods for the following verbs: get, patch, delete */ + (path: "/oauth/providers/{oauthProviderId}", oauthProviderId: string): OAuthProvidersGet; + /** Resource for '/oauth/providers/cascade-delete/\{jobId\}' has methods for the following verbs: get, put */ + ( + path: "/oauth/providers/cascade-delete/{jobId}", + jobId: string + ): OAuthProvidersGetCascadeDeleteJobDetails; + /** Resource for '/oauth/tokens' has methods for the following verbs: get */ + (path: "/oauth/tokens"): OAuthTokensList; + /** Resource for '/oauth/tokens/:connect' has methods for the following verbs: post */ + (path: "/oauth/tokens/:connect"): OAuthTokensGetOAuthConnectionLink; + /** Resource for '/oauth/tokens/remove/\{jobId\}' has methods for the following verbs: get, put */ + (path: "/oauth/tokens/remove/{jobId}", jobId: string): OAuthTokensGetCascadeDeleteJobDetails; + /** Resource for '/farmers/\{farmerId\}/planting-data' has methods for the following verbs: get */ + (path: "/farmers/{farmerId}/planting-data", farmerId: string): PlantingDataListByFarmerId; + /** Resource for '/planting-data' has methods for the following verbs: get */ + (path: "/planting-data"): PlantingDataList; + /** Resource for '/farmers/\{farmerId\}/planting-data/\{plantingDataId\}' has methods for the following verbs: get, patch, delete */ + ( + path: "/farmers/{farmerId}/planting-data/{plantingDataId}", + farmerId: string, + plantingDataId: string + ): PlantingDataGet; + /** Resource for '/planting-data/cascade-delete/\{jobId\}' has methods for the following verbs: get, put */ + ( + path: "/planting-data/cascade-delete/{jobId}", + jobId: string + ): PlantingDataGetCascadeDeleteJobDetails; + /** Resource for '/scenes' has methods for the following verbs: get */ + (path: "/scenes"): ScenesList; + /** Resource for '/scenes/satellite/ingest-data/\{jobId\}' has methods for the following verbs: put, get */ + ( + path: "/scenes/satellite/ingest-data/{jobId}", + jobId: string + ): ScenesCreateSatelliteDataIngestionJob; + /** Resource for '/scenes/downloadFiles' has methods for the following verbs: get */ + (path: "/scenes/downloadFiles"): ScenesDownload; + /** Resource for '/farmers/\{farmerId\}/seasonal-fields' has methods for the following verbs: get */ + (path: "/farmers/{farmerId}/seasonal-fields", farmerId: string): SeasonalFieldsListByFarmerId; + /** Resource for '/seasonal-fields' has methods for the following verbs: get */ + (path: "/seasonal-fields"): SeasonalFieldsList; + /** Resource for '/farmers/\{farmerId\}/seasonal-fields/\{seasonalFieldId\}' has methods for the following verbs: get, patch, delete */ + ( + path: "/farmers/{farmerId}/seasonal-fields/{seasonalFieldId}", + farmerId: string, + seasonalFieldId: string + ): SeasonalFieldsGet; + /** Resource for '/seasonal-fields/cascade-delete/\{jobId\}' has methods for the following verbs: get, put */ + ( + path: "/seasonal-fields/cascade-delete/{jobId}", + jobId: string + ): SeasonalFieldsGetCascadeDeleteJobDetails; + /** Resource for '/seasons' has methods for the following verbs: get */ + (path: "/seasons"): SeasonsList; + /** Resource for '/seasons/\{seasonId\}' has methods for the following verbs: get, patch, delete */ + (path: "/seasons/{seasonId}", seasonId: string): SeasonsGet; + /** Resource for '/farmers/\{farmerId\}/tillage-data' has methods for the following verbs: get */ + (path: "/farmers/{farmerId}/tillage-data", farmerId: string): TillageDataListByFarmerId; + /** Resource for '/tillage-data' has methods for the following verbs: get */ + (path: "/tillage-data"): TillageDataList; + /** Resource for '/farmers/\{farmerId\}/tillage-data/\{tillageDataId\}' has methods for the following verbs: get, patch, delete */ + ( + path: "/farmers/{farmerId}/tillage-data/{tillageDataId}", + farmerId: string, + tillageDataId: string + ): TillageDataGet; + /** Resource for '/tillage-data/cascade-delete/\{jobId\}' has methods for the following verbs: get, put */ + ( + path: "/tillage-data/cascade-delete/{jobId}", + jobId: string + ): TillageDataGetCascadeDeleteJobDetails; + /** Resource for '/weather' has methods for the following verbs: get */ + (path: "/weather"): WeatherList; + /** Resource for '/weather/ingest-data/\{jobId\}' has methods for the following verbs: get, put */ + (path: "/weather/ingest-data/{jobId}", jobId: string): WeatherGetDataIngestionJobDetails; + /** Resource for '/weather/delete-data/\{jobId\}' has methods for the following verbs: get, put */ + (path: "/weather/delete-data/{jobId}", jobId: string): WeatherGetDataDeleteJobDetails; +} + +export type FarmBeatsRestClient = Client & { + path: Routes; +}; diff --git a/sdk/agrifood/agrifood-farming-rest/src/farmBeats.ts b/sdk/agrifood/agrifood-farming-rest/src/farmBeats.ts index 9e439797a8e2..e8734a627907 100644 --- a/sdk/agrifood/agrifood-farming-rest/src/farmBeats.ts +++ b/sdk/agrifood/agrifood-farming-rest/src/farmBeats.ts @@ -1,1121 +1,16 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT license. -import { - ApplicationDataListByFarmerIdParameters, - ApplicationDataListParameters, - ApplicationDataGetParameters, - ApplicationDataCreateOrUpdateParameters, - ApplicationDataDeleteParameters, - AttachmentsListByFarmerIdParameters, - AttachmentsGetParameters, - AttachmentsCreateOrUpdateParameters, - AttachmentsDeleteParameters, - AttachmentsDownloadParameters, - BoundariesListByFarmerIdParameters, - BoundariesSearchByFarmerIdParameters, - BoundariesListParameters, - BoundariesSearchParameters, - BoundariesGetCascadeDeleteJobDetailsParameters, - BoundariesCreateCascadeDeleteJobParameters, - BoundariesGetParameters, - BoundariesCreateOrUpdateParameters, - BoundariesDeleteParameters, - BoundariesGetOverlapParameters, - CropsListParameters, - CropsGetParameters, - CropsCreateOrUpdateParameters, - CropsDeleteParameters, - CropVarietiesListByCropIdParameters, - CropVarietiesListParameters, - CropVarietiesGetParameters, - CropVarietiesCreateOrUpdateParameters, - CropVarietiesDeleteParameters, - FarmersListParameters, - FarmersGetParameters, - FarmersCreateOrUpdateParameters, - FarmersDeleteParameters, - FarmersGetCascadeDeleteJobDetailsParameters, - FarmersCreateCascadeDeleteJobParameters, - FarmOperationsCreateDataIngestionJobParameters, - FarmOperationsGetDataIngestionJobDetailsParameters, - FarmsListByFarmerIdParameters, - FarmsListParameters, - FarmsGetParameters, - FarmsCreateOrUpdateParameters, - FarmsDeleteParameters, - FarmsGetCascadeDeleteJobDetailsParameters, - FarmsCreateCascadeDeleteJobParameters, - FieldsListByFarmerIdParameters, - FieldsListParameters, - FieldsGetParameters, - FieldsCreateOrUpdateParameters, - FieldsDeleteParameters, - FieldsGetCascadeDeleteJobDetailsParameters, - FieldsCreateCascadeDeleteJobParameters, - HarvestDataListByFarmerIdParameters, - HarvestDataListParameters, - HarvestDataGetParameters, - HarvestDataCreateOrUpdateParameters, - HarvestDataDeleteParameters, - ImageProcessingCreateRasterizeJobParameters, - ImageProcessingGetRasterizeJobParameters, - OAuthProvidersListParameters, - OAuthProvidersGetParameters, - OAuthProvidersCreateOrUpdateParameters, - OAuthProvidersDeleteParameters, - OAuthTokensListParameters, - OAuthTokensGetOAuthConnectionLinkParameters, - OAuthTokensGetCascadeDeleteJobDetailsParameters, - OAuthTokensCreateCascadeDeleteJobParameters, - PlantingDataListByFarmerIdParameters, - PlantingDataListParameters, - PlantingDataGetParameters, - PlantingDataCreateOrUpdateParameters, - PlantingDataDeleteParameters, - ScenesListParameters, - ScenesCreateSatelliteDataIngestionJobParameters, - ScenesGetSatelliteDataIngestionJobDetailsParameters, - ScenesDownloadParameters, - SeasonalFieldsListByFarmerIdParameters, - SeasonalFieldsListParameters, - SeasonalFieldsGetParameters, - SeasonalFieldsCreateOrUpdateParameters, - SeasonalFieldsDeleteParameters, - SeasonalFieldsGetCascadeDeleteJobDetailsParameters, - SeasonalFieldsCreateCascadeDeleteJobParameters, - SeasonsListParameters, - SeasonsGetParameters, - SeasonsCreateOrUpdateParameters, - SeasonsDeleteParameters, - TillageDataListByFarmerIdParameters, - TillageDataListParameters, - TillageDataGetParameters, - TillageDataCreateOrUpdateParameters, - TillageDataDeleteParameters, - WeatherListParameters, - WeatherGetDataIngestionJobDetailsParameters, - WeatherCreateDataIngestionJobParameters, - WeatherGetDataDeleteJobDetailsParameters, - WeatherCreateDataDeleteJobParameters, -} from "./parameters"; -import { - ApplicationDataListByFarmerId200Response, - ApplicationDataListByFarmerIddefaultResponse, - ApplicationDataList200Response, - ApplicationDataListdefaultResponse, - ApplicationDataGet200Response, - ApplicationDataGetdefaultResponse, - ApplicationDataCreateOrUpdate200Response, - ApplicationDataCreateOrUpdate201Response, - ApplicationDataCreateOrUpdatedefaultResponse, - ApplicationDataDelete204Response, - ApplicationDataDeletedefaultResponse, - AttachmentsListByFarmerId200Response, - AttachmentsListByFarmerIddefaultResponse, - AttachmentsGet200Response, - AttachmentsGetdefaultResponse, - AttachmentsCreateOrUpdate200Response, - AttachmentsCreateOrUpdate201Response, - AttachmentsCreateOrUpdatedefaultResponse, - AttachmentsDelete204Response, - AttachmentsDeletedefaultResponse, - AttachmentsDownload200Response, - AttachmentsDownloaddefaultResponse, - BoundariesListByFarmerId200Response, - BoundariesListByFarmerIddefaultResponse, - BoundariesSearchByFarmerId200Response, - BoundariesSearchByFarmerIddefaultResponse, - BoundariesList200Response, - BoundariesListdefaultResponse, - BoundariesSearch200Response, - BoundariesSearchdefaultResponse, - BoundariesGetCascadeDeleteJobDetails200Response, - BoundariesGetCascadeDeleteJobDetailsdefaultResponse, - BoundariesCreateCascadeDeleteJob202Response, - BoundariesCreateCascadeDeleteJobdefaultResponse, - BoundariesGet200Response, - BoundariesGetdefaultResponse, - BoundariesCreateOrUpdate200Response, - BoundariesCreateOrUpdate201Response, - BoundariesCreateOrUpdatedefaultResponse, - BoundariesDelete204Response, - BoundariesDeletedefaultResponse, - BoundariesGetOverlap200Response, - BoundariesGetOverlapdefaultResponse, - CropsList200Response, - CropsListdefaultResponse, - CropsGet200Response, - CropsGetdefaultResponse, - CropsCreateOrUpdate200Response, - CropsCreateOrUpdate201Response, - CropsCreateOrUpdatedefaultResponse, - CropsDelete204Response, - CropsDeletedefaultResponse, - CropVarietiesListByCropId200Response, - CropVarietiesListByCropIddefaultResponse, - CropVarietiesList200Response, - CropVarietiesListdefaultResponse, - CropVarietiesGet200Response, - CropVarietiesGetdefaultResponse, - CropVarietiesCreateOrUpdate200Response, - CropVarietiesCreateOrUpdate201Response, - CropVarietiesCreateOrUpdatedefaultResponse, - CropVarietiesDelete204Response, - CropVarietiesDeletedefaultResponse, - FarmersList200Response, - FarmersListdefaultResponse, - FarmersGet200Response, - FarmersGetdefaultResponse, - FarmersCreateOrUpdate200Response, - FarmersCreateOrUpdate201Response, - FarmersCreateOrUpdatedefaultResponse, - FarmersDelete204Response, - FarmersDeletedefaultResponse, - FarmersGetCascadeDeleteJobDetails200Response, - FarmersGetCascadeDeleteJobDetailsdefaultResponse, - FarmersCreateCascadeDeleteJob202Response, - FarmersCreateCascadeDeleteJobdefaultResponse, - FarmOperationsCreateDataIngestionJob202Response, - FarmOperationsCreateDataIngestionJobdefaultResponse, - FarmOperationsGetDataIngestionJobDetails200Response, - FarmOperationsGetDataIngestionJobDetailsdefaultResponse, - FarmsListByFarmerId200Response, - FarmsListByFarmerIddefaultResponse, - FarmsList200Response, - FarmsListdefaultResponse, - FarmsGet200Response, - FarmsGetdefaultResponse, - FarmsCreateOrUpdate200Response, - FarmsCreateOrUpdate201Response, - FarmsCreateOrUpdatedefaultResponse, - FarmsDelete204Response, - FarmsDeletedefaultResponse, - FarmsGetCascadeDeleteJobDetails200Response, - FarmsGetCascadeDeleteJobDetailsdefaultResponse, - FarmsCreateCascadeDeleteJob202Response, - FarmsCreateCascadeDeleteJobdefaultResponse, - FieldsListByFarmerId200Response, - FieldsListByFarmerIddefaultResponse, - FieldsList200Response, - FieldsListdefaultResponse, - FieldsGet200Response, - FieldsGetdefaultResponse, - FieldsCreateOrUpdate200Response, - FieldsCreateOrUpdate201Response, - FieldsCreateOrUpdatedefaultResponse, - FieldsDelete204Response, - FieldsDeletedefaultResponse, - FieldsGetCascadeDeleteJobDetails200Response, - FieldsGetCascadeDeleteJobDetailsdefaultResponse, - FieldsCreateCascadeDeleteJob202Response, - FieldsCreateCascadeDeleteJobdefaultResponse, - HarvestDataListByFarmerId200Response, - HarvestDataListByFarmerIddefaultResponse, - HarvestDataList200Response, - HarvestDataListdefaultResponse, - HarvestDataGet200Response, - HarvestDataGetdefaultResponse, - HarvestDataCreateOrUpdate200Response, - HarvestDataCreateOrUpdate201Response, - HarvestDataCreateOrUpdatedefaultResponse, - HarvestDataDelete204Response, - HarvestDataDeletedefaultResponse, - ImageProcessingCreateRasterizeJob202Response, - ImageProcessingCreateRasterizeJobdefaultResponse, - ImageProcessingGetRasterizeJob200Response, - OAuthProvidersList200Response, - OAuthProvidersListdefaultResponse, - OAuthProvidersGet200Response, - OAuthProvidersGetdefaultResponse, - OAuthProvidersCreateOrUpdate200Response, - OAuthProvidersCreateOrUpdate201Response, - OAuthProvidersCreateOrUpdatedefaultResponse, - OAuthProvidersDelete204Response, - OAuthProvidersDeletedefaultResponse, - OAuthTokensList200Response, - OAuthTokensListdefaultResponse, - OAuthTokensGetOAuthConnectionLink200Response, - OAuthTokensGetOAuthConnectionLinkdefaultResponse, - OAuthTokensGetCascadeDeleteJobDetails200Response, - OAuthTokensGetCascadeDeleteJobDetailsdefaultResponse, - OAuthTokensCreateCascadeDeleteJob202Response, - OAuthTokensCreateCascadeDeleteJobdefaultResponse, - PlantingDataListByFarmerId200Response, - PlantingDataListByFarmerIddefaultResponse, - PlantingDataList200Response, - PlantingDataListdefaultResponse, - PlantingDataGet200Response, - PlantingDataGetdefaultResponse, - PlantingDataCreateOrUpdate200Response, - PlantingDataCreateOrUpdate201Response, - PlantingDataCreateOrUpdatedefaultResponse, - PlantingDataDelete204Response, - PlantingDataDeletedefaultResponse, - ScenesList200Response, - ScenesListdefaultResponse, - ScenesCreateSatelliteDataIngestionJob202Response, - ScenesCreateSatelliteDataIngestionJobdefaultResponse, - ScenesGetSatelliteDataIngestionJobDetails200Response, - ScenesGetSatelliteDataIngestionJobDetailsdefaultResponse, - ScenesDownload200Response, - ScenesDownloaddefaultResponse, - SeasonalFieldsListByFarmerId200Response, - SeasonalFieldsListByFarmerIddefaultResponse, - SeasonalFieldsList200Response, - SeasonalFieldsListdefaultResponse, - SeasonalFieldsGet200Response, - SeasonalFieldsGetdefaultResponse, - SeasonalFieldsCreateOrUpdate200Response, - SeasonalFieldsCreateOrUpdate201Response, - SeasonalFieldsCreateOrUpdatedefaultResponse, - SeasonalFieldsDelete204Response, - SeasonalFieldsDeletedefaultResponse, - SeasonalFieldsGetCascadeDeleteJobDetails200Response, - SeasonalFieldsGetCascadeDeleteJobDetailsdefaultResponse, - SeasonalFieldsCreateCascadeDeleteJob202Response, - SeasonalFieldsCreateCascadeDeleteJobdefaultResponse, - SeasonsList200Response, - SeasonsListdefaultResponse, - SeasonsGet200Response, - SeasonsGetdefaultResponse, - SeasonsCreateOrUpdate200Response, - SeasonsCreateOrUpdate201Response, - SeasonsCreateOrUpdatedefaultResponse, - SeasonsDelete204Response, - SeasonsDeletedefaultResponse, - TillageDataListByFarmerId200Response, - TillageDataListByFarmerIddefaultResponse, - TillageDataList200Response, - TillageDataListdefaultResponse, - TillageDataGet200Response, - TillageDataGetdefaultResponse, - TillageDataCreateOrUpdate200Response, - TillageDataCreateOrUpdate201Response, - TillageDataCreateOrUpdatedefaultResponse, - TillageDataDelete204Response, - TillageDataDeletedefaultResponse, - WeatherList200Response, - WeatherListdefaultResponse, - WeatherGetDataIngestionJobDetails200Response, - WeatherGetDataIngestionJobDetailsdefaultResponse, - WeatherCreateDataIngestionJob202Response, - WeatherCreateDataIngestionJobdefaultResponse, - WeatherGetDataDeleteJobDetails200Response, - WeatherGetDataDeleteJobDetailsdefaultResponse, - WeatherCreateDataDeleteJob202Response, - WeatherCreateDataDeleteJobdefaultResponse, -} from "./responses"; -import { getClient, ClientOptions, Client } from "@azure-rest/core-client"; +import { ClientOptions, getClient } from "@azure-rest/core-client"; import { TokenCredential } from "@azure/core-auth"; - -export interface ApplicationDataListByFarmerId { - /** Returns a paginated list of application data resources under a particular farm. */ - get( - options?: ApplicationDataListByFarmerIdParameters - ): Promise< - ApplicationDataListByFarmerId200Response | ApplicationDataListByFarmerIddefaultResponse - >; -} - -export interface ApplicationDataList { - /** Returns a paginated list of application data resources across all farmers. */ - get( - options?: ApplicationDataListParameters - ): Promise; -} - -export interface ApplicationDataDelete { - /** Get a specified application data resource under a particular farmer. */ - get( - options?: ApplicationDataGetParameters - ): Promise; - /** Creates or updates an application data resource under a particular farmer. */ - patch( - options?: ApplicationDataCreateOrUpdateParameters - ): Promise< - | ApplicationDataCreateOrUpdate200Response - | ApplicationDataCreateOrUpdate201Response - | ApplicationDataCreateOrUpdatedefaultResponse - >; - /** Deletes a specified application data resource under a particular farmer. */ - delete( - options?: ApplicationDataDeleteParameters - ): Promise; -} - -export interface AttachmentsListByFarmerId { - /** Returns a paginated list of attachment resources under a particular farmer. */ - get( - options?: AttachmentsListByFarmerIdParameters - ): Promise; -} - -export interface AttachmentsDelete { - /** Gets a specified attachment resource under a particular farmer. */ - get( - options?: AttachmentsGetParameters - ): Promise; - /** Creates or updates an attachment resource under a particular farmer. */ - patch( - options?: AttachmentsCreateOrUpdateParameters - ): Promise< - | AttachmentsCreateOrUpdate200Response - | AttachmentsCreateOrUpdate201Response - | AttachmentsCreateOrUpdatedefaultResponse - >; - /** Deletes a specified attachment resource under a particular farmer. */ - delete( - options?: AttachmentsDeleteParameters - ): Promise; -} - -export interface AttachmentsDownload { - /** Downloads and returns attachment as response for the given input filePath. */ - get( - options?: AttachmentsDownloadParameters - ): Promise; -} - -export interface BoundariesSearchByFarmerId { - /** Returns a paginated list of boundary resources under a particular farmer. */ - get( - options?: BoundariesListByFarmerIdParameters - ): Promise; - /** Search for boundaries by fields and intersecting geometry. */ - post( - options?: BoundariesSearchByFarmerIdParameters - ): Promise; -} - -export interface BoundariesSearch { - /** Returns a paginated list of boundary resources across all farmers. */ - get( - options?: BoundariesListParameters - ): Promise; - /** Search for boundaries across all farmers by fields and intersecting geometry. */ - post( - options?: BoundariesSearchParameters - ): Promise; -} - -export interface BoundariesCreateCascadeDeleteJob { - /** Get cascade delete job for specified boundary. */ - get( - options?: BoundariesGetCascadeDeleteJobDetailsParameters - ): Promise< - | BoundariesGetCascadeDeleteJobDetails200Response - | BoundariesGetCascadeDeleteJobDetailsdefaultResponse - >; - /** Create a cascade delete job for specified boundary. */ - put( - options?: BoundariesCreateCascadeDeleteJobParameters - ): Promise< - BoundariesCreateCascadeDeleteJob202Response | BoundariesCreateCascadeDeleteJobdefaultResponse - >; -} - -export interface BoundariesDelete { - /** Gets a specified boundary resource under a particular farmer. */ - get( - options?: BoundariesGetParameters - ): Promise; - /** Creates or updates a boundary resource. */ - patch( - options?: BoundariesCreateOrUpdateParameters - ): Promise< - | BoundariesCreateOrUpdate200Response - | BoundariesCreateOrUpdate201Response - | BoundariesCreateOrUpdatedefaultResponse - >; - /** Deletes a specified boundary resource under a particular farmer. */ - delete( - options?: BoundariesDeleteParameters - ): Promise; -} - -export interface BoundariesGetOverlap { - /** Returns overlapping acreage between two boundary Ids. */ - get( - options?: BoundariesGetOverlapParameters - ): Promise; -} - -export interface CropsList { - /** Returns a paginated list of crop resources. */ - get(options?: CropsListParameters): Promise; -} - -export interface CropsDelete { - /** Gets a specified crop resource. */ - get(options?: CropsGetParameters): Promise; - /** Creates or updates a crop resource. */ - patch( - options?: CropsCreateOrUpdateParameters - ): Promise< - | CropsCreateOrUpdate200Response - | CropsCreateOrUpdate201Response - | CropsCreateOrUpdatedefaultResponse - >; - /** Deletes Crop for given crop id. */ - delete( - options?: CropsDeleteParameters - ): Promise; -} - -export interface CropVarietiesListByCropId { - /** Returns a paginated list of crop variety resources under a particular crop. */ - get( - options?: CropVarietiesListByCropIdParameters - ): Promise; -} - -export interface CropVarietiesList { - /** Returns a paginated list of crop variety resources across all crops. */ - get( - options?: CropVarietiesListParameters - ): Promise; -} - -export interface CropVarietiesDelete { - /** Gets a specified crop variety resource under a particular crop. */ - get( - options?: CropVarietiesGetParameters - ): Promise; - /** Creates or updates a crop variety resource. */ - patch( - options?: CropVarietiesCreateOrUpdateParameters - ): Promise< - | CropVarietiesCreateOrUpdate200Response - | CropVarietiesCreateOrUpdate201Response - | CropVarietiesCreateOrUpdatedefaultResponse - >; - /** Deletes a specified crop variety resource under a particular crop. */ - delete( - options?: CropVarietiesDeleteParameters - ): Promise; -} - -export interface FarmersList { - /** Returns a paginated list of farmer resources. */ - get( - options?: FarmersListParameters - ): Promise; -} - -export interface FarmersDelete { - /** Gets a specified farmer resource. */ - get(options?: FarmersGetParameters): Promise; - /** Creates or updates a farmer resource. */ - patch( - options?: FarmersCreateOrUpdateParameters - ): Promise< - | FarmersCreateOrUpdate200Response - | FarmersCreateOrUpdate201Response - | FarmersCreateOrUpdatedefaultResponse - >; - /** Deletes a specified farmer resource. */ - delete( - options?: FarmersDeleteParameters - ): Promise; -} - -export interface FarmersCreateCascadeDeleteJob { - /** Get a cascade delete job for specified farmer. */ - get( - options?: FarmersGetCascadeDeleteJobDetailsParameters - ): Promise< - FarmersGetCascadeDeleteJobDetails200Response | FarmersGetCascadeDeleteJobDetailsdefaultResponse - >; - /** Create a cascade delete job for specified farmer. */ - put( - options?: FarmersCreateCascadeDeleteJobParameters - ): Promise< - FarmersCreateCascadeDeleteJob202Response | FarmersCreateCascadeDeleteJobdefaultResponse - >; -} - -export interface FarmOperationsGetDataIngestionJobDetails { - /** Create a farm operation data ingestion job. */ - put( - options?: FarmOperationsCreateDataIngestionJobParameters - ): Promise< - | FarmOperationsCreateDataIngestionJob202Response - | FarmOperationsCreateDataIngestionJobdefaultResponse - >; - /** Get a farm operation data ingestion job. */ - get( - options?: FarmOperationsGetDataIngestionJobDetailsParameters - ): Promise< - | FarmOperationsGetDataIngestionJobDetails200Response - | FarmOperationsGetDataIngestionJobDetailsdefaultResponse - >; -} - -export interface FarmsListByFarmerId { - /** Returns a paginated list of farm resources under a particular farmer. */ - get( - options?: FarmsListByFarmerIdParameters - ): Promise; -} - -export interface FarmsList { - /** Returns a paginated list of farm resources across all farmers. */ - get(options?: FarmsListParameters): Promise; -} - -export interface FarmsDelete { - /** Gets a specified farm resource under a particular farmer. */ - get(options?: FarmsGetParameters): Promise; - /** Creates or updates a farm resource under a particular farmer. */ - patch( - options?: FarmsCreateOrUpdateParameters - ): Promise< - | FarmsCreateOrUpdate200Response - | FarmsCreateOrUpdate201Response - | FarmsCreateOrUpdatedefaultResponse - >; - /** Deletes a specified farm resource under a particular farmer. */ - delete( - options?: FarmsDeleteParameters - ): Promise; -} - -export interface FarmsCreateCascadeDeleteJob { - /** Get a cascade delete job for specified farm. */ - get( - options?: FarmsGetCascadeDeleteJobDetailsParameters - ): Promise< - FarmsGetCascadeDeleteJobDetails200Response | FarmsGetCascadeDeleteJobDetailsdefaultResponse - >; - /** Create a cascade delete job for specified farm. */ - put( - options?: FarmsCreateCascadeDeleteJobParameters - ): Promise; -} - -export interface FieldsListByFarmerId { - /** Returns a paginated list of field resources under a particular farmer. */ - get( - options?: FieldsListByFarmerIdParameters - ): Promise; -} - -export interface FieldsList { - /** Returns a paginated list of field resources across all farmers. */ - get(options?: FieldsListParameters): Promise; -} - -export interface FieldsDelete { - /** Gets a specified field resource under a particular farmer. */ - get(options?: FieldsGetParameters): Promise; - /** Creates or Updates a field resource under a particular farmer. */ - patch( - options?: FieldsCreateOrUpdateParameters - ): Promise< - | FieldsCreateOrUpdate200Response - | FieldsCreateOrUpdate201Response - | FieldsCreateOrUpdatedefaultResponse - >; - /** Deletes a specified field resource under a particular farmer. */ - delete( - options?: FieldsDeleteParameters - ): Promise; -} - -export interface FieldsCreateCascadeDeleteJob { - /** Get a cascade delete job for specified field. */ - get( - options?: FieldsGetCascadeDeleteJobDetailsParameters - ): Promise< - FieldsGetCascadeDeleteJobDetails200Response | FieldsGetCascadeDeleteJobDetailsdefaultResponse - >; - /** Create a cascade delete job for specified field. */ - put( - options?: FieldsCreateCascadeDeleteJobParameters - ): Promise; -} - -export interface HarvestDataListByFarmerId { - /** Returns a paginated list of harvest data resources under a particular farm. */ - get( - options?: HarvestDataListByFarmerIdParameters - ): Promise; -} - -export interface HarvestDataList { - /** Returns a paginated list of harvest data resources across all farmers. */ - get( - options?: HarvestDataListParameters - ): Promise; -} - -export interface HarvestDataDelete { - /** Get a specified harvest data resource under a particular farmer. */ - get( - options?: HarvestDataGetParameters - ): Promise; - /** Creates or updates harvest data resource under a particular farmer. */ - patch( - options?: HarvestDataCreateOrUpdateParameters - ): Promise< - | HarvestDataCreateOrUpdate200Response - | HarvestDataCreateOrUpdate201Response - | HarvestDataCreateOrUpdatedefaultResponse - >; - /** Deletes a specified harvest data resource under a particular farmer. */ - delete( - options?: HarvestDataDeleteParameters - ): Promise; -} - -export interface ImageProcessingGetRasterizeJob { - /** Create a ImageProcessing Rasterize job. */ - put( - options?: ImageProcessingCreateRasterizeJobParameters - ): Promise< - ImageProcessingCreateRasterizeJob202Response | ImageProcessingCreateRasterizeJobdefaultResponse - >; - /** Get ImageProcessing Rasterize job's details. */ - get( - options?: ImageProcessingGetRasterizeJobParameters - ): Promise; -} - -export interface OAuthProvidersList { - /** Returns a paginated list of oauthProvider resources. */ - get( - options?: OAuthProvidersListParameters - ): Promise; -} - -export interface OAuthProvidersDelete { - /** Get a specified oauthProvider resource. */ - get( - options?: OAuthProvidersGetParameters - ): Promise; - /** Creates or updates an oauthProvider resource. */ - patch( - options?: OAuthProvidersCreateOrUpdateParameters - ): Promise< - | OAuthProvidersCreateOrUpdate200Response - | OAuthProvidersCreateOrUpdate201Response - | OAuthProvidersCreateOrUpdatedefaultResponse - >; - /** Deletes an specified oauthProvider resource. */ - delete( - options?: OAuthProvidersDeleteParameters - ): Promise; -} - -export interface OAuthTokensList { - /** Returns a list of OAuthToken documents. */ - get( - options?: OAuthTokensListParameters - ): Promise; -} - -export interface OAuthTokensGetOAuthConnectionLink { - /** Returns Connection link needed in the OAuth flow. */ - post( - options?: OAuthTokensGetOAuthConnectionLinkParameters - ): Promise< - OAuthTokensGetOAuthConnectionLink200Response | OAuthTokensGetOAuthConnectionLinkdefaultResponse - >; -} - -export interface OAuthTokensCreateCascadeDeleteJob { - /** Get cascade delete job details for OAuth tokens for specified job ID. */ - get( - options?: OAuthTokensGetCascadeDeleteJobDetailsParameters - ): Promise< - | OAuthTokensGetCascadeDeleteJobDetails200Response - | OAuthTokensGetCascadeDeleteJobDetailsdefaultResponse - >; - /** Create a cascade delete job for OAuth tokens. */ - put( - options?: OAuthTokensCreateCascadeDeleteJobParameters - ): Promise< - OAuthTokensCreateCascadeDeleteJob202Response | OAuthTokensCreateCascadeDeleteJobdefaultResponse - >; -} - -export interface PlantingDataListByFarmerId { - /** Returns a paginated list of planting data resources under a particular farm. */ - get( - options?: PlantingDataListByFarmerIdParameters - ): Promise; -} - -export interface PlantingDataList { - /** Returns a paginated list of planting data resources across all farmers. */ - get( - options?: PlantingDataListParameters - ): Promise; -} - -export interface PlantingDataDelete { - /** Get a specified planting data resource under a particular farmer. */ - get( - options?: PlantingDataGetParameters - ): Promise; - /** Creates or updates an planting data resource under a particular farmer. */ - patch( - options?: PlantingDataCreateOrUpdateParameters - ): Promise< - | PlantingDataCreateOrUpdate200Response - | PlantingDataCreateOrUpdate201Response - | PlantingDataCreateOrUpdatedefaultResponse - >; - /** Deletes a specified planting data resource under a particular farmer. */ - delete( - options?: PlantingDataDeleteParameters - ): Promise; -} - -export interface ScenesList { - /** Returns a paginated list of scene resources. */ - get(options?: ScenesListParameters): Promise; -} - -export interface ScenesGetSatelliteDataIngestionJobDetails { - /** Create a satellite data ingestion job. */ - put( - options?: ScenesCreateSatelliteDataIngestionJobParameters - ): Promise< - | ScenesCreateSatelliteDataIngestionJob202Response - | ScenesCreateSatelliteDataIngestionJobdefaultResponse - >; - /** Get a satellite data ingestion job. */ - get( - options?: ScenesGetSatelliteDataIngestionJobDetailsParameters - ): Promise< - | ScenesGetSatelliteDataIngestionJobDetails200Response - | ScenesGetSatelliteDataIngestionJobDetailsdefaultResponse - >; -} - -export interface ScenesDownload { - /** Downloads and returns file stream as response for the given input filePath. */ - get( - options?: ScenesDownloadParameters - ): Promise; -} - -export interface SeasonalFieldsListByFarmerId { - /** Returns a paginated list of seasonal field resources under a particular farmer. */ - get( - options?: SeasonalFieldsListByFarmerIdParameters - ): Promise; -} - -export interface SeasonalFieldsList { - /** Returns a paginated list of seasonal field resources across all farmers. */ - get( - options?: SeasonalFieldsListParameters - ): Promise; -} - -export interface SeasonalFieldsDelete { - /** Gets a specified seasonal field resource under a particular farmer. */ - get( - options?: SeasonalFieldsGetParameters - ): Promise; - /** Creates or Updates a seasonal field resource under a particular farmer. */ - patch( - options?: SeasonalFieldsCreateOrUpdateParameters - ): Promise< - | SeasonalFieldsCreateOrUpdate200Response - | SeasonalFieldsCreateOrUpdate201Response - | SeasonalFieldsCreateOrUpdatedefaultResponse - >; - /** Deletes a specified seasonal-field resource under a particular farmer. */ - delete( - options?: SeasonalFieldsDeleteParameters - ): Promise; -} - -export interface SeasonalFieldsCreateCascadeDeleteJob { - /** Get cascade delete job for specified seasonal field. */ - get( - options?: SeasonalFieldsGetCascadeDeleteJobDetailsParameters - ): Promise< - | SeasonalFieldsGetCascadeDeleteJobDetails200Response - | SeasonalFieldsGetCascadeDeleteJobDetailsdefaultResponse - >; - /** Create a cascade delete job for specified seasonal field. */ - put( - options?: SeasonalFieldsCreateCascadeDeleteJobParameters - ): Promise< - | SeasonalFieldsCreateCascadeDeleteJob202Response - | SeasonalFieldsCreateCascadeDeleteJobdefaultResponse - >; -} - -export interface SeasonsList { - /** Returns a paginated list of season resources. */ - get( - options?: SeasonsListParameters - ): Promise; -} - -export interface SeasonsDelete { - /** Gets a specified season resource. */ - get(options?: SeasonsGetParameters): Promise; - /** Creates or updates a season resource. */ - patch( - options?: SeasonsCreateOrUpdateParameters - ): Promise< - | SeasonsCreateOrUpdate200Response - | SeasonsCreateOrUpdate201Response - | SeasonsCreateOrUpdatedefaultResponse - >; - /** Deletes a specified season resource. */ - delete( - options?: SeasonsDeleteParameters - ): Promise; -} - -export interface TillageDataListByFarmerId { - /** Returns a paginated list of tillage data resources under a particular farm. */ - get( - options?: TillageDataListByFarmerIdParameters - ): Promise; -} - -export interface TillageDataList { - /** Returns a paginated list of tillage data resources across all farmers. */ - get( - options?: TillageDataListParameters - ): Promise; -} - -export interface TillageDataDelete { - /** Get a specified tillage data resource under a particular farmer. */ - get( - options?: TillageDataGetParameters - ): Promise; - /** Creates or updates an tillage data resource under a particular farmer. */ - patch( - options?: TillageDataCreateOrUpdateParameters - ): Promise< - | TillageDataCreateOrUpdate200Response - | TillageDataCreateOrUpdate201Response - | TillageDataCreateOrUpdatedefaultResponse - >; - /** Deletes a specified tillage data resource under a particular farmer. */ - delete( - options?: TillageDataDeleteParameters - ): Promise; -} - -export interface WeatherList { - /** Returns a paginated list of weather data. */ - get( - options?: WeatherListParameters - ): Promise; -} - -export interface WeatherCreateDataIngestionJob { - /** Get weather ingestion job. */ - get( - options?: WeatherGetDataIngestionJobDetailsParameters - ): Promise< - WeatherGetDataIngestionJobDetails200Response | WeatherGetDataIngestionJobDetailsdefaultResponse - >; - /** Create a weather data ingestion job. */ - put( - options?: WeatherCreateDataIngestionJobParameters - ): Promise< - WeatherCreateDataIngestionJob202Response | WeatherCreateDataIngestionJobdefaultResponse - >; -} - -export interface WeatherCreateDataDeleteJob { - /** Get weather data delete job. */ - get( - options?: WeatherGetDataDeleteJobDetailsParameters - ): Promise< - WeatherGetDataDeleteJobDetails200Response | WeatherGetDataDeleteJobDetailsdefaultResponse - >; - /** Create a weather data delete job. */ - put( - options?: WeatherCreateDataDeleteJobParameters - ): Promise; -} - -export interface Routes { - /** Resource for '/farmers/\{farmerId\}/application-data' has methods for the following verbs: get */ - (path: "/farmers/{farmerId}/application-data", farmerId: string): ApplicationDataListByFarmerId; - /** Resource for '/application-data' has methods for the following verbs: get */ - (path: "/application-data"): ApplicationDataList; - /** Resource for '/farmers/\{farmerId\}/application-data/\{applicationDataId\}' has methods for the following verbs: get, patch, delete */ - ( - path: "/farmers/{farmerId}/application-data/{applicationDataId}", - farmerId: string, - applicationDataId: string - ): ApplicationDataDelete; - /** Resource for '/farmers/\{farmerId\}/attachments' has methods for the following verbs: get */ - (path: "/farmers/{farmerId}/attachments", farmerId: string): AttachmentsListByFarmerId; - /** Resource for '/farmers/\{farmerId\}/attachments/\{attachmentId\}' has methods for the following verbs: get, patch, delete */ - ( - path: "/farmers/{farmerId}/attachments/{attachmentId}", - farmerId: string, - attachmentId: string - ): AttachmentsDelete; - /** Resource for '/farmers/\{farmerId\}/attachments/\{attachmentId\}/file' has methods for the following verbs: get */ - ( - path: "/farmers/{farmerId}/attachments/{attachmentId}/file", - farmerId: string, - attachmentId: string - ): AttachmentsDownload; - /** Resource for '/farmers/\{farmerId\}/boundaries' has methods for the following verbs: get, post */ - (path: "/farmers/{farmerId}/boundaries", farmerId: string): BoundariesSearchByFarmerId; - /** Resource for '/boundaries' has methods for the following verbs: get, post */ - (path: "/boundaries"): BoundariesSearch; - /** Resource for '/boundaries/cascade-delete/\{jobId\}' has methods for the following verbs: get, put */ - (path: "/boundaries/cascade-delete/{jobId}", jobId: string): BoundariesCreateCascadeDeleteJob; - /** Resource for '/farmers/\{farmerId\}/boundaries/\{boundaryId\}' has methods for the following verbs: get, patch, delete */ - ( - path: "/farmers/{farmerId}/boundaries/{boundaryId}", - farmerId: string, - boundaryId: string - ): BoundariesDelete; - /** Resource for '/farmers/\{farmerId\}/boundaries/\{boundaryId\}/overlap' has methods for the following verbs: get */ - ( - path: "/farmers/{farmerId}/boundaries/{boundaryId}/overlap", - farmerId: string, - boundaryId: string - ): BoundariesGetOverlap; - /** Resource for '/crops' has methods for the following verbs: get */ - (path: "/crops"): CropsList; - /** Resource for '/crops/\{cropId\}' has methods for the following verbs: get, patch, delete */ - (path: "/crops/{cropId}", cropId: string): CropsDelete; - /** Resource for '/crops/\{cropId\}/crop-varieties' has methods for the following verbs: get */ - (path: "/crops/{cropId}/crop-varieties", cropId: string): CropVarietiesListByCropId; - /** Resource for '/crop-varieties' has methods for the following verbs: get */ - (path: "/crop-varieties"): CropVarietiesList; - /** Resource for '/crops/\{cropId\}/crop-varieties/\{cropVarietyId\}' has methods for the following verbs: get, patch, delete */ - ( - path: "/crops/{cropId}/crop-varieties/{cropVarietyId}", - cropId: string, - cropVarietyId: string - ): CropVarietiesDelete; - /** Resource for '/farmers' has methods for the following verbs: get */ - (path: "/farmers"): FarmersList; - /** Resource for '/farmers/\{farmerId\}' has methods for the following verbs: get, patch, delete */ - (path: "/farmers/{farmerId}", farmerId: string): FarmersDelete; - /** Resource for '/farmers/cascade-delete/\{jobId\}' has methods for the following verbs: get, put */ - (path: "/farmers/cascade-delete/{jobId}", jobId: string): FarmersCreateCascadeDeleteJob; - /** Resource for '/farm-operations/ingest-data/\{jobId\}' has methods for the following verbs: put, get */ - ( - path: "/farm-operations/ingest-data/{jobId}", - jobId: string - ): FarmOperationsGetDataIngestionJobDetails; - /** Resource for '/farmers/\{farmerId\}/farms' has methods for the following verbs: get */ - (path: "/farmers/{farmerId}/farms", farmerId: string): FarmsListByFarmerId; - /** Resource for '/farms' has methods for the following verbs: get */ - (path: "/farms"): FarmsList; - /** Resource for '/farmers/\{farmerId\}/farms/\{farmId\}' has methods for the following verbs: get, patch, delete */ - (path: "/farmers/{farmerId}/farms/{farmId}", farmerId: string, farmId: string): FarmsDelete; - /** Resource for '/farms/cascade-delete/\{jobId\}' has methods for the following verbs: get, put */ - (path: "/farms/cascade-delete/{jobId}", jobId: string): FarmsCreateCascadeDeleteJob; - /** Resource for '/farmers/\{farmerId\}/fields' has methods for the following verbs: get */ - (path: "/farmers/{farmerId}/fields", farmerId: string): FieldsListByFarmerId; - /** Resource for '/fields' has methods for the following verbs: get */ - (path: "/fields"): FieldsList; - /** Resource for '/farmers/\{farmerId\}/fields/\{fieldId\}' has methods for the following verbs: get, patch, delete */ - (path: "/farmers/{farmerId}/fields/{fieldId}", farmerId: string, fieldId: string): FieldsDelete; - /** Resource for '/fields/cascade-delete/\{jobId\}' has methods for the following verbs: get, put */ - (path: "/fields/cascade-delete/{jobId}", jobId: string): FieldsCreateCascadeDeleteJob; - /** Resource for '/farmers/\{farmerId\}/harvest-data' has methods for the following verbs: get */ - (path: "/farmers/{farmerId}/harvest-data", farmerId: string): HarvestDataListByFarmerId; - /** Resource for '/harvest-data' has methods for the following verbs: get */ - (path: "/harvest-data"): HarvestDataList; - /** Resource for '/farmers/\{farmerId\}/harvest-data/\{harvestDataId\}' has methods for the following verbs: get, patch, delete */ - ( - path: "/farmers/{farmerId}/harvest-data/{harvestDataId}", - farmerId: string, - harvestDataId: string - ): HarvestDataDelete; - /** Resource for '/image-processing/rasterize/\{jobId\}' has methods for the following verbs: put, get */ - (path: "/image-processing/rasterize/{jobId}", jobId: string): ImageProcessingGetRasterizeJob; - /** Resource for '/oauth/providers' has methods for the following verbs: get */ - (path: "/oauth/providers"): OAuthProvidersList; - /** Resource for '/oauth/providers/\{oauthProviderId\}' has methods for the following verbs: get, patch, delete */ - (path: "/oauth/providers/{oauthProviderId}", oauthProviderId: string): OAuthProvidersDelete; - /** Resource for '/oauth/tokens' has methods for the following verbs: get */ - (path: "/oauth/tokens"): OAuthTokensList; - /** Resource for '/oauth/tokens/:connect' has methods for the following verbs: post */ - (path: "/oauth/tokens/:connect"): OAuthTokensGetOAuthConnectionLink; - /** Resource for '/oauth/tokens/remove/\{jobId\}' has methods for the following verbs: get, put */ - (path: "/oauth/tokens/remove/{jobId}", jobId: string): OAuthTokensCreateCascadeDeleteJob; - /** Resource for '/farmers/\{farmerId\}/planting-data' has methods for the following verbs: get */ - (path: "/farmers/{farmerId}/planting-data", farmerId: string): PlantingDataListByFarmerId; - /** Resource for '/planting-data' has methods for the following verbs: get */ - (path: "/planting-data"): PlantingDataList; - /** Resource for '/farmers/\{farmerId\}/planting-data/\{plantingDataId\}' has methods for the following verbs: get, patch, delete */ - ( - path: "/farmers/{farmerId}/planting-data/{plantingDataId}", - farmerId: string, - plantingDataId: string - ): PlantingDataDelete; - /** Resource for '/scenes' has methods for the following verbs: get */ - (path: "/scenes"): ScenesList; - /** Resource for '/scenes/satellite/ingest-data/\{jobId\}' has methods for the following verbs: put, get */ - ( - path: "/scenes/satellite/ingest-data/{jobId}", - jobId: string - ): ScenesGetSatelliteDataIngestionJobDetails; - /** Resource for '/scenes/downloadFiles' has methods for the following verbs: get */ - (path: "/scenes/downloadFiles"): ScenesDownload; - /** Resource for '/farmers/\{farmerId\}/seasonal-fields' has methods for the following verbs: get */ - (path: "/farmers/{farmerId}/seasonal-fields", farmerId: string): SeasonalFieldsListByFarmerId; - /** Resource for '/seasonal-fields' has methods for the following verbs: get */ - (path: "/seasonal-fields"): SeasonalFieldsList; - /** Resource for '/farmers/\{farmerId\}/seasonal-fields/\{seasonalFieldId\}' has methods for the following verbs: get, patch, delete */ - ( - path: "/farmers/{farmerId}/seasonal-fields/{seasonalFieldId}", - farmerId: string, - seasonalFieldId: string - ): SeasonalFieldsDelete; - /** Resource for '/seasonal-fields/cascade-delete/\{jobId\}' has methods for the following verbs: get, put */ - ( - path: "/seasonal-fields/cascade-delete/{jobId}", - jobId: string - ): SeasonalFieldsCreateCascadeDeleteJob; - /** Resource for '/seasons' has methods for the following verbs: get */ - (path: "/seasons"): SeasonsList; - /** Resource for '/seasons/\{seasonId\}' has methods for the following verbs: get, patch, delete */ - (path: "/seasons/{seasonId}", seasonId: string): SeasonsDelete; - /** Resource for '/farmers/\{farmerId\}/tillage-data' has methods for the following verbs: get */ - (path: "/farmers/{farmerId}/tillage-data", farmerId: string): TillageDataListByFarmerId; - /** Resource for '/tillage-data' has methods for the following verbs: get */ - (path: "/tillage-data"): TillageDataList; - /** Resource for '/farmers/\{farmerId\}/tillage-data/\{tillageDataId\}' has methods for the following verbs: get, patch, delete */ - ( - path: "/farmers/{farmerId}/tillage-data/{tillageDataId}", - farmerId: string, - tillageDataId: string - ): TillageDataDelete; - /** Resource for '/weather' has methods for the following verbs: get */ - (path: "/weather"): WeatherList; - /** Resource for '/weather/ingest-data/\{jobId\}' has methods for the following verbs: get, put */ - (path: "/weather/ingest-data/{jobId}", jobId: string): WeatherCreateDataIngestionJob; - /** Resource for '/weather/delete-data/\{jobId\}' has methods for the following verbs: get, put */ - (path: "/weather/delete-data/{jobId}", jobId: string): WeatherCreateDataDeleteJob; -} - -export type FarmBeatsRestClient = Client & { - path: Routes; -}; +import { FarmBeatsRestClient } from "./clientDefinitions"; export default function FarmBeats( - Endpoint: string, + $host: string, credentials: TokenCredential, options: ClientOptions = {} ): FarmBeatsRestClient { - const baseUrl = options.baseUrl ?? `${Endpoint}`; + const baseUrl = options.baseUrl ?? `${$host}`; options.apiVersion = options.apiVersion ?? "2021-03-31-preview"; options = { ...options, @@ -1124,5 +19,7 @@ export default function FarmBeats( }, }; - return getClient(baseUrl, credentials, options) as FarmBeatsRestClient; + const client = getClient(baseUrl, credentials, options) as FarmBeatsRestClient; + + return client; } diff --git a/sdk/agrifood/agrifood-farming-rest/src/getPoller.ts b/sdk/agrifood/agrifood-farming-rest/src/getPoller.ts deleted file mode 100644 index f97b32861956..000000000000 --- a/sdk/agrifood/agrifood-farming-rest/src/getPoller.ts +++ /dev/null @@ -1,26 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -import { - getLongRunningPoller, - PollerLike, - PollOperationState, - PollerOptions, -} from "@azure-rest/core-client-lro"; -import { HttpResponse } from "@azure-rest/core-client"; -import { FarmBeatsRestClient } from "./farmBeats"; - -/** - * Gets a poller object to help polling for a long running operation status. - * @param client - FarmBeats Rest Client. - * @param initialResponse - Initial response for the operation that needs to be polled. - * @param options - Polling options - * @returns - Gets a poller that can be run on demand or automatically awaited until the operation is completed. - */ -export function getPoller( - client: FarmBeatsRestClient, - initialResponse: TResult, - options: PollerOptions = {} -): PollerLike, TResult> { - return getLongRunningPoller(client, initialResponse, options); -} diff --git a/sdk/agrifood/agrifood-farming-rest/src/index.ts b/sdk/agrifood/agrifood-farming-rest/src/index.ts index a9474b016c30..8951165a251c 100644 --- a/sdk/agrifood/agrifood-farming-rest/src/index.ts +++ b/sdk/agrifood/agrifood-farming-rest/src/index.ts @@ -4,11 +4,12 @@ import FarmBeats from "./farmBeats"; export * from "./farmBeats"; -export * from "./models"; export * from "./parameters"; export * from "./responses"; - -export { paginate, PaginateReturn, GetArrayType } from "./paging"; -export { getPoller } from "./getPoller"; +export * from "./clientDefinitions"; +export * from "./models"; +export * from "./outputModels"; +export * from "./paginateHelper"; +export * from "./pollingHelper"; export default FarmBeats; diff --git a/sdk/agrifood/agrifood-farming-rest/src/models.ts b/sdk/agrifood/agrifood-farming-rest/src/models.ts index e3e8813a2ee4..3f7f4dee7101 100644 --- a/sdk/agrifood/agrifood-farming-rest/src/models.ts +++ b/sdk/agrifood/agrifood-farming-rest/src/models.ts @@ -1,70 +1,53 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT license. -export interface ApplicationDataListResponse { - /** List of requested objects. */ - value?: ApplicationData[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; -} - export interface ApplicationData { /** Application product details. */ - applicationProductDetails?: ApplicationProductDetail[]; + applicationProductDetails?: Array; /** Schema for storing measurement reading and unit. */ avgMaterial?: Measure; /** Schema for storing measurement reading and unit. */ totalMaterial?: Measure; /** Schema for storing measurement reading and unit. */ area?: Measure; - /** Source of the operation data. */ + /** Represents the source from which the application data was obtained. */ source?: string; - /** - * Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. - * Note: this will be specified by the source provider itself. - */ - operationModifiedDateTime?: Date; - /** Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - operationStartDateTime?: Date; - /** End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - operationEndDateTime?: Date; - /** Link for attachments. */ + /** UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. */ + operationModifiedDateTime?: Date | string; + /** UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationStartDateTime?: Date | string; + /** UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationEndDateTime?: Date | string; + /** Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. */ attachmentsLink?: string; - /** Optional boundary ID of the field for which operation was applied. */ + /** Id of the boundary of the field/seasonal field on which the application operation was done. */ associatedBoundaryId?: string; - /** Optional boundary ID of the actual area for which operation was applied inside the specified field. */ + /** Id of the boundary that is created using the geographical area on which the application operation was carried out. */ operationBoundaryId?: string; - /** Farmer ID which belongs to the operation data. */ + /** Id of the associated farmer. */ farmerId?: string; - /** Unique resource ID. */ + /** Unique Id of the operation (application). This Id is unique for a given farmer. */ id?: string; - /** The ETag value to implement optimistic concurrency. */ + /** ETag value can be used to implement optimistic concurrency. */ eTag?: string; - /** Status of the resource. */ + /** User determined status of the resource. */ status?: string; - /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - modifiedDateTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: Date | string; + /** Name of the application operation. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the application operation. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: ApplicationDataPropertiesDictionary; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } export interface ApplicationProductDetail { - /** Name of the product applied. */ + /** Name of a product applied. */ productName?: string; - /** A flag indicating whether product is a carrier for a tank mix. */ + /** Indicates if the product is a carrier for a tank mix. */ isCarrier?: boolean; /** Schema for storing measurement reading and unit. */ avgMaterial?: Measure; @@ -79,161 +62,71 @@ export interface Measure { value?: number; } -export interface ErrorResponse { - /** An error from the Azure AgPlatform service. */ - error?: Error; - /** Unique trace ID. */ - traceId?: string; -} - -export interface Error { - /** Server-defined set of error codes. */ - code?: string; - /** Human-readable representation of the error. */ - message?: string; - /** Target of the error. */ - target?: string; - /** Array of details about specific errors that led to this reported error. */ - details?: Error[]; - /** - * Inner error containing list of errors. - * InnerError reference document. - */ - innererror?: InnerError; -} - -export type InnerError = InnerErrorBase & InnerErrorDictionary; - -export interface InnerErrorBase { - /** - * Specific error code than was provided by the - * containing error. - */ - code?: string; - /** - * Inner error containing list of errors. - * InnerError reference document. - */ - innererror?: InnerError; -} - -export interface AttachmentListResponse { - /** List of requested objects. */ - value?: Attachment[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; -} - -export interface Attachment { - /** Farmer id for this attachment. */ - farmerId?: string; - /** Associated Resource id for this attachment. */ - resourceId?: string; - /** - * Associated Resource type for this attachment - * i.e. Farmer, Farm, Field, SeasonalField, Boundary, FarmOperationApplicationData, HarvestData, TillageData, PlantingData. - */ - resourceType?: string; - /** Original File Name for this attachment. */ - originalFileName?: string; - /** Unique id. */ - id?: string; - /** Status of the resource. */ - status?: string; - /** Date when resource was created. */ - createdDateTime?: Date; - /** Date when resource was last modified. */ - modifiedDateTime?: Date; - /** Name to identify resource. */ - name?: string; - /** Textual description of resource. */ - description?: string; - /** The ETag value to implement optimistic concurrency. */ - eTag?: string; -} - -export interface BoundaryListResponse { - /** List of requested objects. */ - value?: Boundary[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; -} - export interface Boundary { - /** Farmer ID. */ + /** Id of the associated farmer. */ farmerId?: string; - /** ID of the parent(field or seasonalField) it belongs to. */ + /** If the boundary is associated with a field or a seasonal field then the parent id refers to the id of the field/seasonal field. */ parentId?: string; /** GeoJSON abstract class. */ geometry?: GeoJsonObject; - /** Is the boundary primary. */ + /** Indicates if the boundary is a primary boundary for the associated parent (if any). */ isPrimary?: boolean; - /** Boundary area in acres. */ + /** Area of the boundary in acres. */ acreage?: number; - /** Type of the parent it belongs to. */ + /** Indicates if the parent is a field or a seasonal field. Permissible values are 'Field' and 'SeasonalField'. */ parentType?: string; - /** Unique resource ID. */ + /** Unique Id of the boundary. This Id is unique for a given farmer. */ id?: string; - /** The ETag value to implement optimistic concurrency. */ + /** ETag value can be used to implement optimistic concurrency. */ eTag?: string; - /** Status of the resource. */ + /** User determined status of the resource. */ status?: string; - /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - modifiedDateTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: Date | string; + /** Name of the boundary. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the boundary. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: BoundaryPropertiesDictionary; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } -export type GeoJsonObject = Polygon | MultiPolygon | Point; +export interface GeoJsonObjectBase { + type: "MultiPolygon" | "Point" | "Polygon"; +} export interface SearchBoundaryQuery { - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; + /** List of boundary Ids to be searched. */ + ids?: Array; + /** List of names of boundaries to be searched. */ + names?: Array; /** - * Filters on key-value pairs within the Properties object. + * Filters on key-value pairs within 'Properties'. * eg. "{testKey} eq {testValue}". */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; - /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. - */ - maxPageSize?: number; - /** Skip token for getting next set of results. */ - skipToken?: string; - /** Is the boundary primary. */ + propertyFilters?: Array; + /** List of statuses of boundaries to be searched. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ + $maxPageSize?: number; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** If set, search result will contain only primary boundaries. */ isPrimary?: boolean; - /** Type of the parent it belongs to. */ + /** Used to search based on the parent type (Field/ SeasonalField). */ parentType?: string; - /** Parent Ids of the resource. */ - parentIds?: string[]; + /** List of parent Ids whose boundaries are to be retrieved. */ + parentIds?: Array; /** Minimum acreage of the boundary (inclusive). */ minAcreage?: number; /** Maximum acreage of the boundary (inclusive). */ @@ -242,285 +135,153 @@ export interface SearchBoundaryQuery { intersectsWithGeometry?: GeoJsonObject; } -export interface CascadeDeleteJob { - /** Farmer ID. */ - farmerId: string; - /** The id of the resource. */ - resourceId: string; - /** The type of the resource. */ - resourceType: string; - /** Unique job id. */ - id?: string; - /** - * Status of the job. - * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. - */ - status?: string; - /** Duration of the job in seconds. */ - durationInSeconds?: number; - /** Status message to capture more details of the job. */ - message?: string; - /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - lastActionDateTime?: Date; - /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - startTime?: Date; - /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - endTime?: Date; - /** Name to identify resource. */ - name?: string; - /** Textual description of the resource. */ - description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: CascadeDeleteJobPropertiesDictionary; -} - -export interface BoundaryOverlapResponse { - /** Acreage of Main boundary. */ - boundaryAcreage?: number; - /** Acreage of other boundary. */ - otherBoundaryAcreage?: number; - /** Acreage of intersecting boundary. */ - intersectingAcreage?: number; -} - -export interface CropListResponse { - /** List of requested objects. */ - value?: Crop[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; -} - export interface Crop { - /** Crop phenotype. */ + /** Phenotype of the crop. */ phenotype?: string; - /** Unique resource ID. */ + /** Unique Id of the crop. */ id?: string; - /** The ETag value to implement optimistic concurrency. */ + /** ETag value can be used to implement optimistic concurrency. */ eTag?: string; - /** Status of the resource. */ + /** User determined status of the resource. */ status?: string; - /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - modifiedDateTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: Date | string; + /** Name of the crop. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the crop. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: CropPropertiesDictionary; -} - -export interface CropVarietyListResponse { - /** List of requested objects. */ - value?: CropVariety[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } export interface CropVariety { - /** ID of the crop it belongs to. */ + /** Id of the associated crop. */ cropId?: string; - /** CropVariety Brand. */ + /** Brand of the crop variety. */ brand?: string; - /** CropVariety product. */ + /** Commercial name of the crop variety. */ product?: string; - /** Unique resource ID. */ + /** Unique Id of the crop variety. This Id is unique for a given crop. */ id?: string; - /** The ETag value to implement optimistic concurrency. */ + /** ETag value can be used to implement optimistic concurrency. */ eTag?: string; - /** Status of the resource. */ + /** User determined status of the resource. */ status?: string; - /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - modifiedDateTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: Date | string; + /** Name of the crop variety. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the crop variety. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: CropVarietyPropertiesDictionary; -} - -export interface FarmerListResponse { - /** List of requested objects. */ - value?: Farmer[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } export interface Farmer { - /** Unique resource ID. */ + /** Unique Id of the farmer. */ id?: string; - /** The ETag value to implement optimistic concurrency. */ + /** ETag value can be used to implement optimistic concurrency. */ eTag?: string; - /** Status of the resource. */ + /** User determined status of the resource. */ status?: string; - /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - modifiedDateTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: Date | string; + /** Name of the farmer. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the farmer. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: FarmerPropertiesDictionary; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record; } export interface FarmOperationDataIngestionJob { - /** Farmer ID. */ + /** Id of the farmer whose farm operations are to be fetched. */ farmerId: string; - /** Authentication provider ID. */ + /** Id of the farm operations data provider. Use 'JOHNDEERE' to fetch data from John Deere. */ authProviderId: string; - /** List of operation types for which data needs to be downloaded. Available values: AllOperations, Application, Planting, Harvest, Tillage. */ - operations?: string[]; - /** Start Year (Minimum = 2000, Maximum = CurrentYear). */ + /** List of types of farm operations for which data needs to be fetched. Valid values are AllOperations, Application, Planting, Harvest and Tillage. */ + operations?: Array; + /** The beginning year from when the farm operations data needs to be fetched (minimum = 2000, maximum = current year). */ startYear: number; - /** Unique job id. */ + /** Unique Id of the farm operations data ingestion job. This Id must be unique for a given tenant. */ id?: string; /** * Status of the job. * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. */ status?: string; - /** Duration of the job in seconds. */ + /** Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. */ durationInSeconds?: number; - /** Status message to capture more details of the job. */ + /** Brief description of the result of the job. */ message?: string; - /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - lastActionDateTime?: Date; - /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - startTime?: Date; - /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - endTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). */ + lastActionDateTime?: Date | string; + /** UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). */ + startTime?: Date | string; + /** UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + endTime?: Date | string; + /** Name of the farm operations data ingestion job. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the farm operations data ingestion job. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: FarmOperationDataIngestionJobPropertiesDictionary; -} - -export interface FarmListResponse { - /** List of requested objects. */ - value?: Farm[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } export interface Farm { - /** Farmer ID. */ + /** Id of the associated farmer. */ farmerId?: string; - /** Unique resource ID. */ + /** Unique Id of the farm. This Id is unique for a given farmer. */ id?: string; - /** The ETag value to implement optimistic concurrency. */ + /** ETag value can be used to implement optimistic concurrency. */ eTag?: string; - /** Status of the resource. */ + /** User determined status of the resource. */ status?: string; - /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - modifiedDateTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: Date | string; + /** Name of the farm. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the farm. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: FarmPropertiesDictionary; -} - -export interface FieldListResponse { - /** List of requested objects. */ - value?: Field[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } export interface Field { - /** ID of the associated Farm. */ + /** Id of the associated farm. */ farmId?: string; - /** Farmer ID. */ + /** Id of the associated farmer. */ farmerId?: string; - /** Primary boundary id. */ + /** Id of the primary boundary associated with the field. At any point in time, a field can contain a maximum of one primary boundary. */ primaryBoundaryId?: string; - /** Boundary Ids. */ - boundaryIds?: string[]; - /** Unique resource ID. */ + /** List of Ids of boundaries associated with the field. */ + boundaryIds?: Array; + /** Unique Id of the field. This Id is unique for a given farmer. */ id?: string; - /** The ETag value to implement optimistic concurrency. */ + /** ETag value can be used to implement optimistic concurrency. */ eTag?: string; - /** Status of the resource. */ + /** User determined status of the resource. */ status?: string; - /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - modifiedDateTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: Date | string; + /** Name of the field. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the field. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: FieldPropertiesDictionary; -} - -export interface HarvestDataListResponse { - /** List of requested objects. */ - value?: HarvestData[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } export interface HarvestData { @@ -536,54 +297,46 @@ export interface HarvestData { avgMoisture?: Measure; /** Schema for storing measurement reading and unit. */ avgSpeed?: Measure; - /** Harvest product details. */ - harvestProductDetails?: HarvestProductDetail[]; + /** Details of harvested products. */ + harvestProductDetails?: Array; /** Schema for storing measurement reading and unit. */ area?: Measure; - /** Source of the operation data. */ + /** Represents the source from which the harvest data was obtained. */ source?: string; - /** - * Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. - * Note: this will be specified by the source provider itself. - */ - operationModifiedDateTime?: Date; - /** Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - operationStartDateTime?: Date; - /** End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - operationEndDateTime?: Date; - /** Link for attachments. */ + /** UTC date-time at which the harvest data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. */ + operationModifiedDateTime?: Date | string; + /** UTC date-time at which the harvest operation started (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationStartDateTime?: Date | string; + /** UTC date-time at which the harvest operation ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationEndDateTime?: Date | string; + /** Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. */ attachmentsLink?: string; - /** Optional boundary ID of the field for which operation was applied. */ + /** Id of the boundary of the field/seasonal field on which the harvest operation was done. */ associatedBoundaryId?: string; - /** Optional boundary ID of the actual area for which operation was applied inside the specified field. */ + /** Id of the boundary that is created using the geographical area on which the harvest operation was carried out. */ operationBoundaryId?: string; - /** Farmer ID which belongs to the operation data. */ + /** Id of the associated farmer. */ farmerId?: string; - /** Unique resource ID. */ + /** Unique Id of the operation (harvest). This Id is unique for a given farmer. */ id?: string; - /** The ETag value to implement optimistic concurrency. */ + /** ETag value can be used to implement optimistic concurrency. */ eTag?: string; - /** Status of the resource. */ + /** User determined status of the resource. */ status?: string; - /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - modifiedDateTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: Date | string; + /** Name of the harvest operation. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the harvest operation. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: HarvestDataPropertiesDictionary; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } export interface HarvestProductDetail { - /** Name of the product. */ + /** Name of a harvested product. */ productName?: string; /** Schema for storing measurement reading and unit. */ area?: Measure; @@ -600,136 +353,84 @@ export interface HarvestProductDetail { } export interface ImageProcessingRasterizeJob { - /** Farmer ID. */ + /** Id of the associated farmer. */ farmerId: string; - /** Shapefile attachment ID. */ + /** Attachment id of the input shapefile which must be rasterized. */ shapefileAttachmentId: string; - /** List of shapefile column names to create raster attachments. */ - shapefileColumnNames: string[]; - /** Unique job id. */ + /** List of shapefile column names that must be rasterized. */ + shapefileColumnNames: Array; + /** Unique Id of the image processing (rasterize) job. This Id must be unique for a given tenant. */ id?: string; /** * Status of the job. * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. */ status?: string; - /** Duration of the job in seconds. */ + /** Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. */ durationInSeconds?: number; - /** Status message to capture more details of the job. */ + /** Brief description of the result of the job. */ message?: string; - /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - lastActionDateTime?: Date; - /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - startTime?: Date; - /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - endTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). */ + lastActionDateTime?: Date | string; + /** UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). */ + startTime?: Date | string; + /** UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + endTime?: Date | string; + /** Name of the image processing (rasterize) job. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the image processing (rasterize) job. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: ImageProcessingRasterizeJobPropertiesDictionary; -} - -export interface OAuthProviderListResponse { - /** List of requested objects. */ - value?: OAuthProvider[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } export interface OAuthProvider { - /** OAuth App ID for given OAuth Provider. */ + /** OAuth App Id for a given OAuth Provider. */ appId?: string; /** - * OAuth App secret for given Provider. - * Note: Won't be sent in response. + * OAuth App secret for a given OAuth Provider. + * Note: The app secret will not be part of the response. */ appSecret?: string; /** - * OAuth Api key for given Provider. - * Note: currently Applicable to Climate provider. Won't be sent in response. + * OAuth Api key for a given Provider. + * Note: The Api key will not be part of the response. This is applicable only for authenticating to Climate Corp. */ apiKey?: string; /** - * 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) - * Note: Currently applicable for JohnDeere. + * An optional flag to determine if the OAuth App is ready to be used for production scenarios. + * Note: This is applicable only for John Deere. */ isProductionApp?: boolean; - /** Unique OAuth provider ID. */ + /** FarmBeats recognized unique Id for the OAuth provider. Valid value: 'JOHNDEERE. */ id?: string; - /** The ETag value to implement optimistic concurrency. */ + /** ETag value can be used to implement optimistic concurrency. */ eTag?: string; - /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - modifiedDateTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: Date | string; + /** Name of the OAuth provider. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the OAuth provider. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: OAuthProviderPropertiesDictionary; -} - -export interface OAuthTokenListResponse { - /** List of requested objects. */ - value?: OAuthToken[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; -} - -export interface OAuthToken { - /** Farmer ID for this OAuth config. */ - farmerId: string; - /** ID of the OAuth provider resource containing app information. */ - authProviderId: string; - /** An optional flag indicating whether the token is a valid or expired (Default value: true). */ - isValid?: boolean; - /** The ETag value to implement optimistic concurrency. */ - eTag?: string; - /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - modifiedDateTime?: Date; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } export interface OAuthConnectRequest { - /** ID of the farmer. */ + /** Id of the farmer for whom the OAuth flow is being configured. */ farmerId: string; - /** ID of the OAuthProvider. */ + /** Id of the OAuth provider. */ oAuthProviderId: string; - /** Link to redirect the user to, at the end of the oauth flow. */ + /** Link to redirect the user to, at the end of the OAuth flow. */ userRedirectLink: string; - /** State to provide back when redirecting the user, at the end of the oauth flow. */ + /** State to be returned when redirecting the user at the end of the oauth flow. */ userRedirectState?: string; } -export interface PlantingDataListResponse { - /** List of requested objects. */ - value?: PlantingData[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; -} - export interface PlantingData { /** Schema for storing measurement reading and unit. */ avgPlantingRate?: Measure; @@ -737,54 +438,46 @@ export interface PlantingData { totalMaterial?: Measure; /** Schema for storing measurement reading and unit. */ avgMaterial?: Measure; - /** Planting product details. */ - plantingProductDetails?: PlantingProductDetail[]; + /** Details of products planted. */ + plantingProductDetails?: Array; /** Schema for storing measurement reading and unit. */ area?: Measure; - /** Source of the operation data. */ + /** Represents the source from which the planting data was obtained. */ source?: string; - /** - * Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. - * Note: this will be specified by the source provider itself. - */ - operationModifiedDateTime?: Date; - /** Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - operationStartDateTime?: Date; - /** End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - operationEndDateTime?: Date; - /** Link for attachments. */ + /** UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. */ + operationModifiedDateTime?: Date | string; + /** UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationStartDateTime?: Date | string; + /** UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationEndDateTime?: Date | string; + /** Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. */ attachmentsLink?: string; - /** Optional boundary ID of the field for which operation was applied. */ + /** Id of the boundary of the field/seasonal field on which the planting operation was done. */ associatedBoundaryId?: string; - /** Optional boundary ID of the actual area for which operation was applied inside the specified field. */ + /** Id of the boundary that is created using the geographical area on which the planting operation was carried out. */ operationBoundaryId?: string; - /** Farmer ID which belongs to the operation data. */ + /** Id of the associated farmer. */ farmerId?: string; - /** Unique resource ID. */ + /** Unique Id of the operation (planting). This Id is unique for a given farmer. */ id?: string; - /** The ETag value to implement optimistic concurrency. */ + /** ETag value can be used to implement optimistic concurrency. */ eTag?: string; - /** Status of the resource. */ + /** User determined status of the resource. */ status?: string; - /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - modifiedDateTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: Date | string; + /** Name of the planting operation. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the planting operation. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: PlantingDataPropertiesDictionary; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } export interface PlantingProductDetail { - /** Name of the product. */ + /** Name of the planted product. */ productName?: string; /** Schema for storing measurement reading and unit. */ area?: Measure; @@ -794,214 +487,128 @@ export interface PlantingProductDetail { avgMaterial?: Measure; } -export interface SceneListResponse { - /** List of requested objects. */ - value?: Scene[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; -} - -export interface Scene { - /** Date-time of the scene, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - sceneDateTime?: Date; - /** Data provider of the scene. */ - provider?: string; - /** Data source of the scene. */ - source?: string; - /** Collection of image files. */ - imageFiles?: ImageFile[]; - /** Supported image formats for scene resource. */ - imageFormat?: ImageFormat; - /** Cloud cover percentage of the scene. */ - cloudCoverPercentage?: number; - /** Dark pixel percentage of the scene. */ - darkPixelPercentage?: number; - /** Median of NDVI of the scene. */ - ndviMedianValue?: number; - /** Boundary ID which belongs to the scene. */ - boundaryId?: string; - /** Farmer ID which belongs to the scene. */ - farmerId?: string; - /** Unique scene resource ID. */ - id?: string; - /** The ETag value to implement optimistic concurrency. */ - eTag?: string; -} - -export interface ImageFile { - /** Link of the image file. */ - fileLink?: string; - /** Name of the image file. */ - name: string; - /** Supported image formats for scene resource. */ - imageFormat?: ImageFormat; - /** Resolution of image file in meters. */ - resolution?: number; -} - export interface SatelliteDataIngestionJob { - /** Farmer ID. */ + /** Id of the associated farmer. */ farmerId: string; - /** The id of the boundary object for which satellite data is being fetched. */ + /** The id of the boundary for which satellite data is being fetched. */ boundaryId: string; - /** Start Date. */ - startDateTime: Date; - /** End Date. */ - endDateTime: Date; + /** UTC Date-time from when the satellite data has to be fetched (format: yyyy-MM-ddTHH:mm:ssZ). */ + startDateTime: Date | string; + /** UTC Date-time till when the satellite data has to be fetched (format: yyyy-MM-ddTHH:mm:ssZ). */ + endDateTime: Date | string; /** Provider of satellite data. */ - provider?: DataProvider; + provider?: "Microsoft"; /** Source of satellite data. */ - source?: Source; + source?: "Sentinel_2_L2A"; /** Data Model for SatelliteIngestionJobRequest. */ data?: SatelliteData; - /** Unique job id. */ + /** Unique Id of the satellite data ingestion job. This Id must be unique for a given tenant. */ id?: string; /** * Status of the job. * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. */ status?: string; - /** Duration of the job in seconds. */ + /** DProcessing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. */ durationInSeconds?: number; - /** Status message to capture more details of the job. */ + /** Brief description of the result of the job. */ message?: string; - /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - lastActionDateTime?: Date; - /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - startTime?: Date; - /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - endTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). */ + lastActionDateTime?: Date | string; + /** UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). */ + startTime?: Date | string; + /** UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + endTime?: Date | string; + /** Name of the satellite data ingestion job. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the satellite data ingestion job. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: SatelliteDataIngestionJobPropertiesDictionary; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } export interface SatelliteData { - /** List of ImageNames. */ - imageNames?: string[]; - /** List of ImageFormats. Available value: TIF. */ - imageFormats?: string[]; - /** List of ImageResolutions in meters. Available values: 10, 20, 60. */ - imageResolutions?: number[]; -} - -export interface SeasonalFieldListResponse { - /** List of requested objects. */ - value?: SeasonalField[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; + /** + * List of names of images to be fetched. + * For Sentinel-2, allowed values are: 'B01', 'B02', 'B03', 'B04', 'B05', 'B06', 'B07', 'B08', 'B8A', 'B09', 'B11', 'B12', 'AOT', 'SCL', 'SNW', 'CLD', 'NDVI', 'NDWI', 'EVI', 'LAI', 'LAIMask', 'CLP', 'CLM', and 'dataMask'. + */ + imageNames?: Array; + /** List of formats in which images can be fetched. Available value: TIF. */ + imageFormats?: Array; + /** List of image resolutions in meters. For Sentinel-2, available values are: 10, 20, 60. */ + imageResolutions?: Array; } export interface SeasonalField { - /** Farmer ID. */ + /** Id of the associated farmer. */ farmerId?: string; - /** Primary boundary id. */ + /** Id of the primary boundary associated with the seasonal field. At any point in time, a seasonal field can contain a maximum of one primary boundary. */ primaryBoundaryId?: string; - /** Boundary Ids. */ - boundaryIds?: string[]; - /** ID of the associated Farm. */ + /** List of Ids of boundaries associated with the seasonal field. */ + boundaryIds?: Array; + /** Id of the associated farm. */ farmId?: string; - /** ID of the associated Field. */ + /** Id of the associated field. */ fieldId?: string; - /** ID of the season it belongs to. */ + /** Id of the season associated with the seasonal field. */ seasonId?: string; - /** CropVariety ids. */ - cropVarietyIds?: string[]; - /** ID of the crop it belongs to. */ + /** List of Ids of crop varieties associated with the seasonal field. All the crop varieties must belong to the same crop. */ + cropVarietyIds?: Array; + /** Id of the crop associated with the seasonal field. Seasonal fields are mono crop entities. */ cropId?: string; - /** Average yield value of the seasonal field. */ + /** Average yield generated from the seasonal field. */ avgYieldValue?: number; - /** Unit of the average yield value attribute. */ + /** Unit to measure average yield. */ avgYieldUnit?: string; - /** Average seed population value of the seasonal field. */ + /** Average seed population planted in the seasonal field. */ avgSeedPopulationValue?: number; - /** Unit of average seed population value attribute. */ + /** Unit to measure average seed population. */ avgSeedPopulationUnit?: string; - /** Planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - plantingDateTime?: Date; - /** Unique resource ID. */ + /** UTC Date-time at which crops were planted (format: yyyy-MM-ddTHH:mm:ssZ). */ + plantingDateTime?: Date | string; + /** Unique Id of the seasonal field. This Id is unique for a given farmer. */ id?: string; - /** The ETag value to implement optimistic concurrency. */ + /** ETag value can be used to implement optimistic concurrency. */ eTag?: string; - /** Status of the resource. */ + /** User determined status of the resource. */ status?: string; - /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - modifiedDateTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: Date | string; + /** Name of the seasonal field. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the seasonal field. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: SeasonalFieldPropertiesDictionary; -} - -export interface SeasonListResponse { - /** List of requested objects. */ - value?: Season[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } export interface Season { - /** Season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - startDateTime?: Date; - /** Season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - endDateTime?: Date; - /** Season year. */ + /** UTC date-time signifying the start of the season (format: yyyy-MM-ddTHH:mm:ssZ). */ + startDateTime?: Date | string; + /** UTC date-time signifying the end of the season (format: yyyy-MM-ddTHH:mm:ssZ). */ + endDateTime?: Date | string; + /** Year associated with the harvest i.e. year of season end date-time. */ year?: number; - /** Unique resource ID. */ + /** Unique Id of the season. */ id?: string; - /** The ETag value to implement optimistic concurrency. */ + /** ETag value can be used to implement optimistic concurrency. */ eTag?: string; - /** Status of the resource. */ + /** User determined status of the resource. */ status?: string; - /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - modifiedDateTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: Date | string; + /** Name of the season. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the season. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: SeasonPropertiesDictionary; -} - -export interface TillageDataListResponse { - /** List of requested objects. */ - value?: TillageData[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } export interface TillageData { @@ -1011,255 +618,153 @@ export interface TillageData { tillagePressure?: Measure; /** Schema for storing measurement reading and unit. */ area?: Measure; - /** Source of the operation data. */ + /** Represents the source from which the tillage data was obtained. */ source?: string; - /** - * Modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. - * Note: this will be specified by the source provider itself. - */ - operationModifiedDateTime?: Date; - /** Start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - operationStartDateTime?: Date; - /** End date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - operationEndDateTime?: Date; - /** Link for attachments. */ + /** UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. */ + operationModifiedDateTime?: Date | string; + /** UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationStartDateTime?: Date | string; + /** UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationEndDateTime?: Date | string; + /** Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. */ attachmentsLink?: string; - /** Optional boundary ID of the field for which operation was applied. */ + /** Id of the boundary of the field/seasonal field on which the tillage operation was done. */ associatedBoundaryId?: string; - /** Optional boundary ID of the actual area for which operation was applied inside the specified field. */ + /** Id of the boundary that is created using the geographical area on which the tillage operation was carried out. */ operationBoundaryId?: string; - /** Farmer ID which belongs to the operation data. */ + /** Id of the associated farmer. */ farmerId?: string; - /** Unique resource ID. */ + /** Unique Id of the operation (tillage). This Id is unique for a given farmer. */ id?: string; - /** The ETag value to implement optimistic concurrency. */ + /** ETag value can be used to implement optimistic concurrency. */ eTag?: string; - /** Status of the resource. */ + /** User determined status of the resource. */ status?: string; - /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - modifiedDateTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: Date | string; + /** Name of the tillage operation. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the tillage operation. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: TillageDataPropertiesDictionary; -} - -export interface WeatherDataListResponse { - /** List of requested objects. */ - value?: WeatherData[]; - /** Token used in retrieving the next page. If null, there are no additional pages. */ - skipToken?: string; - /** Continuation link (absolute URI) to the next page of results in the list. */ - nextLink?: string; -} - -export interface WeatherData { - /** Farmer ID. */ - farmerId: string; - /** Boundary ID. */ - boundaryId: string; - /** ID of the weather extension. */ - extensionId: string; - /** Location model class. */ - location: Location; - /** Date-time of the weather data, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - dateTime: Date; - /** Unit System like US/SI etc. */ - unitSystemCode?: string; - /** Version of the weather data extension. */ - extensionVersion: string; - /** Type of weather data (forecast/historical). */ - weatherDataType: string; - /** Granularity of weather data (daily/hourly). */ - granularity: string; - /** Schema for storing measurement reading and unit. */ - cloudCover?: Measure; - /** Schema for storing measurement reading and unit. */ - dewPoint?: Measure; - /** Schema for storing measurement reading and unit. */ - growingDegreeDay?: Measure; - /** Schema for storing measurement reading and unit. */ - precipitation?: Measure; - /** Schema for storing measurement reading and unit. */ - pressure?: Measure; - /** Schema for storing measurement reading and unit. */ - relativeHumidity?: Measure; - /** Schema for storing measurement reading and unit. */ - soilMoisture?: Measure; - /** Schema for storing measurement reading and unit. */ - soilTemperature?: Measure; - /** Schema for storing measurement reading and unit. */ - temperature?: Measure; - /** Schema for storing measurement reading and unit. */ - visibility?: Measure; - /** Schema for storing measurement reading and unit. */ - wetBulbTemperature?: Measure; - /** Schema for storing measurement reading and unit. */ - windChill?: Measure; - /** Schema for storing measurement reading and unit. */ - windDirection?: Measure; - /** Schema for storing measurement reading and unit. */ - windGust?: Measure; - /** Schema for storing measurement reading and unit. */ - windSpeed?: Measure; - /** Weather data ID. */ - id?: string; - /** The ETag value to implement optimistic concurrency. */ - eTag?: string; - /** Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - modifiedDateTime?: Date; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: WeatherDataPropertiesDictionary; -} - -export interface Location { - /** Latitude of the location. */ - latitude: number; - /** Longitude of the location. */ - longitude: number; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } export interface WeatherDataIngestionJob { - /** The id of the boundary object for which weather data is being fetched. */ + /** Id of the associated boundary. */ boundaryId: string; - /** The id of the farmer object for which weather data is being fetched. */ + /** Id of the associated farmer. */ farmerId: string; - /** ID of the extension to be used for the providerInput. eg. DTN.ClearAg. */ + /** Id of the weather extension. This signifies the source from where the weather data is fetched (eg. DTN.ClearAg). */ extensionId: string; - /** Extension api name to which request is to be made. */ + /** Extension api name to which the request is to be made. */ extensionApiName: string; - /** Extension api input dictionary which would be used to feed request query/body/parameter information. */ - extensionApiInput: WeatherDataIngestionJobExtensionApiInputDictionary; + /** Dictionary of inputs for extension api. This would be passed as part fo request to weather data provider. */ + extensionApiInput: Record>; /** App id of the weather data provider. */ extensionDataProviderAppId?: string; /** Api key of the weather data provider. */ extensionDataProviderApiKey?: string; - /** Unique job id. */ + /** Unique Id of the weather data ingestion job. This Id must be unique for a given tenant. */ id?: string; /** * Status of the job. * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. */ status?: string; - /** Duration of the job in seconds. */ + /** Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. */ durationInSeconds?: number; - /** Status message to capture more details of the job. */ + /** Brief description of the result of the job. */ message?: string; - /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - lastActionDateTime?: Date; - /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - startTime?: Date; - /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - endTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). */ + lastActionDateTime?: Date | string; + /** UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). */ + startTime?: Date | string; + /** UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + endTime?: Date | string; + /** Name to weather data ingestion job. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the weather data ingestion job. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: WeatherDataIngestionJobPropertiesDictionary; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; } export interface WeatherDataDeleteJob { - /** ID of the extension to be used for the providerInput. eg. DTN.ClearAg. */ + /** Id of the weather extension. This signifies the source from where the weather data was fetched (eg. DTN.ClearAg). */ extensionId: string; - /** The id of the farmer object for which weather data is being fetched. */ + /** The Id of the associated farmer. */ farmerId: string; - /** The id of the boundary object for which weather data is being fetched. */ + /** The id of the associated boundary. */ boundaryId: string; - /** Type of weather data. Possible values include: 'forecast' , 'historical'. */ + /** Type of weather data (forecast/historical). */ weatherDataType?: string; - /** Granularity of weather data. Possible values include: 'daily' , 'hourly'. */ + /** Granularity of weather data (daily/hourly). */ granularity?: string; - /** Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. */ - startDateTime?: Date; - /** Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. */ - endDateTime?: Date; - /** Unique job id. */ + /** UTC Date-time from when the weather data has to be deleted (format: yyyy-MM-ddTHH:mm:ssZ). */ + startDateTime?: Date | string; + /** UTC Date-time till when the weather data has to be deleted (format: yyyy-MM-ddTHH:mm:ssZ). */ + endDateTime?: Date | string; + /** Unique Id of the weather data delete job. This Id must be unique for a given tenant. */ id?: string; /** * Status of the job. * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. */ status?: string; - /** Duration of the job in seconds. */ + /** Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. */ durationInSeconds?: number; - /** Status message to capture more details of the job. */ + /** Brief description of the result of the job. */ message?: string; - /** Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - createdDateTime?: Date; - /** Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - lastActionDateTime?: Date; - /** Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - startTime?: Date; - /** Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ. */ - endTime?: Date; - /** Name to identify resource. */ + /** UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: Date | string; + /** UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). */ + lastActionDateTime?: Date | string; + /** UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). */ + startTime?: Date | string; + /** UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + endTime?: Date | string; + /** Name of the weather data deletion job. */ name?: string; - /** Textual description of the resource. */ + /** Brief description of the weather data deletion job. */ description?: string; - /** - * 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 150 characters. - * Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported. - */ - properties?: WeatherDataDeleteJobPropertiesDictionary; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface MultiPolygon extends GeoJsonObjectBase, MultiPolygonCoordinates { + type: "MultiPolygon"; } export interface MultiPolygonCoordinates { /** - * Gets or sets Coordinates of GeoJSON Object. + * Gets or sets coordinates of GeoJSON Object. * It must be an array of polygons, each polygon contains list of linear rings. * For Polygons with more than one of these rings, the first MUST be the exterior ring, * and any others MUST be interior rings. */ - coordinates: number[][][][]; + coordinates: Array>>>; } -export type MultiPolygon = MultiPolygonBase & - MultiPolygonCoordinates & { - type: "MultiPolygon"; - }; - -export interface MultiPolygonBase {} +export interface Point extends GeoJsonObjectBase, PointCoordinates { + type: "Point"; +} export interface PointCoordinates { /** * Gets or sets the coordinate of this point. - * It must be an array of 2 or 3 elements for a 2D or 3D system. + * It must be an array of 2 or 3 elements for a 2D or 3D system respectively. */ - coordinates: number[]; + coordinates: Array; } -export type Point = PointBase & - PointCoordinates & { - type: "Point"; - }; - -export interface PointBase {} +export interface Polygon extends GeoJsonObjectBase, PolygonCoordinates { + type: "Polygon"; +} export interface PolygonCoordinates { /** @@ -1268,69 +773,7 @@ export interface PolygonCoordinates { * For Polygons with more than one of these rings, the first MUST be the exterior ring, * and any others MUST be interior rings. */ - coordinates: number[][][]; -} - -export type Polygon = PolygonBase & - PolygonCoordinates & { - type: "Polygon"; - }; - -export interface PolygonBase {} - -export interface Paths1LxjoxzFarmersFarmeridAttachmentsAttachmentidPatchRequestbodyContentMultipartFormDataSchema { - /** File to be uploaded. */ - file?: string; - /** Farmer id for this attachment. */ - farmerId?: string; - /** Associated Resource id for this attachment. */ - resourceId?: string; - /** - * Associated Resource type for this attachment - * i.e. Farmer, Farm, Field, SeasonalField, Boundary, FarmOperationApplicationData, HarvestData, TillageData, PlantingData. - */ - resourceType?: string; - /** Original File Name for this attachment. */ - originalFileName?: string; - /** Unique id. */ - id?: string; - /** Status of the resource. */ - status?: string; - /** Date when resource was created. */ - createdDateTime?: string; - /** Date when resource was last modified. */ - modifiedDateTime?: string; - /** Name to identify resource. */ - name?: string; - /** Textual description of resource. */ - description?: string; - /** The ETag value to implement optimistic concurrency. */ - eTag?: string; + coordinates: Array>>; } -export type GeoJsonObjectType = "Point" | "Polygon" | "MultiPolygon"; -export type ImageFormat = "TIF"; -export type DataProvider = "Microsoft"; -export type Source = "Sentinel_2_L2A"; -export type ApplicationDataPropertiesDictionary = Record; -export type InnerErrorDictionary = Record; -export type BoundaryPropertiesDictionary = Record; -export type CascadeDeleteJobPropertiesDictionary = Record; -export type CropPropertiesDictionary = Record; -export type CropVarietyPropertiesDictionary = Record; -export type FarmerPropertiesDictionary = Record; -export type FarmOperationDataIngestionJobPropertiesDictionary = Record; -export type FarmPropertiesDictionary = Record; -export type FieldPropertiesDictionary = Record; -export type HarvestDataPropertiesDictionary = Record; -export type ImageProcessingRasterizeJobPropertiesDictionary = Record; -export type OAuthProviderPropertiesDictionary = Record; -export type PlantingDataPropertiesDictionary = Record; -export type SatelliteDataIngestionJobPropertiesDictionary = Record; -export type SeasonalFieldPropertiesDictionary = Record; -export type SeasonPropertiesDictionary = Record; -export type TillageDataPropertiesDictionary = Record; -export type WeatherDataPropertiesDictionary = Record; -export type WeatherDataIngestionJobExtensionApiInputDictionary = Record; -export type WeatherDataIngestionJobPropertiesDictionary = Record; -export type WeatherDataDeleteJobPropertiesDictionary = Record; +export type GeoJsonObject = MultiPolygon | Point | Polygon; diff --git a/sdk/agrifood/agrifood-farming-rest/src/outputModels.ts b/sdk/agrifood/agrifood-farming-rest/src/outputModels.ts new file mode 100644 index 000000000000..d8ddcd9e7d48 --- /dev/null +++ b/sdk/agrifood/agrifood-farming-rest/src/outputModels.ts @@ -0,0 +1,1129 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + +export interface ApplicationDataListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface ApplicationDataOutput { + /** Application product details. */ + applicationProductDetails?: Array; + /** Schema for storing measurement reading and unit. */ + avgMaterial?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + totalMaterial?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + area?: MeasureOutput; + /** Represents the source from which the application data was obtained. */ + source?: string; + /** UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. */ + operationModifiedDateTime?: string; + /** UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationStartDateTime?: string; + /** UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationEndDateTime?: string; + /** Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. */ + attachmentsLink?: string; + /** Id of the boundary of the field/seasonal field on which the application operation was done. */ + associatedBoundaryId?: string; + /** Id of the boundary that is created using the geographical area on which the application operation was carried out. */ + operationBoundaryId?: string; + /** Id of the associated farmer. */ + farmerId?: string; + /** Unique Id of the operation (application). This Id is unique for a given farmer. */ + id?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; + /** User determined status of the resource. */ + status?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; + /** Name of the application operation. */ + name?: string; + /** Brief description of the application operation. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface ApplicationProductDetailOutput { + /** Name of a product applied. */ + productName?: string; + /** Indicates if the product is a carrier for a tank mix. */ + isCarrier?: boolean; + /** Schema for storing measurement reading and unit. */ + avgMaterial?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + totalMaterial?: MeasureOutput; +} + +export interface MeasureOutput { + /** Data unit. */ + unit?: string; + /** Data value. */ + value?: number; +} + +export interface ErrorResponseOutput { + /** An error from Azure FarmBeats service. */ + error?: ErrorModelOutput; + /** Unique trace Id. */ + traceId?: string; +} + +export interface ErrorModelOutput { + /** Server-defined set of error codes. */ + code?: string; + /** Human-readable representation of the error. */ + message?: string; + /** Target of the error. */ + target?: string; + /** Array of details about specific errors that led to this reported error. */ + details?: Array; + /** + * Inner error containing list of errors. + * InnerError reference document. + */ + innererror?: InnerErrorOutput; +} + +export interface InnerErrorOutput extends Record { + /** Specific error code than was provided by the containing error. */ + code?: string; + /** + * Inner error containing list of errors. + * InnerError reference document. + */ + innererror?: InnerErrorOutput; +} + +export interface CascadeDeleteJobOutput { + /** Farmer Id. */ + farmerId: string; + /** The id of the resource which is to be deleted (along with the subtree & associated data). */ + resourceId: string; + /** Signifies the type of the resource that is being deleted (along with the subtree & associated data). */ + resourceType: string; + /** Unique Id of the cascade delete job. This Id is unique for a given tenant. */ + id?: string; + /** + * Status of the job. + * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. + */ + status?: "Waiting" | "Running" | "Succeeded" | "Failed" | "Cancelled"; + /** Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. */ + durationInSeconds?: number; + /** Brief description of the result of the job. */ + message?: string; + /** UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). */ + lastActionDateTime?: string; + /** UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). */ + startTime?: string; + /** UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + endTime?: string; +} + +export interface AttachmentListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface AttachmentOutput { + /** Id of the associated farmer. */ + farmerId?: string; + /** This is the Id of the resource to which the attachment belongs. Ids of following entities are valid: Farmer, Farm, Field, Seasonal field, Boundary, Application data, Harvest data, Tillage data and Planting data. */ + resourceId?: string; + /** Indicates the type of resource to which this attachment belongs. Valid values are Farmer, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageDat and PlantingData. */ + resourceType?: string; + /** Original file name of the attachment. */ + originalFileName?: string; + /** Unique Id of the attachment. This Id is unique for a given farmer. */ + id?: string; + /** User determined status of the resource. */ + status?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; + /** Name of the attachment. */ + name?: string; + /** Brief description of the attachment. */ + description?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; +} + +export interface BoundaryListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface BoundaryOutput { + /** Id of the associated farmer. */ + farmerId?: string; + /** If the boundary is associated with a field or a seasonal field then the parent id refers to the id of the field/seasonal field. */ + parentId?: string; + /** GeoJSON abstract class. */ + geometry?: GeoJsonObjectOutput; + /** Indicates if the boundary is a primary boundary for the associated parent (if any). */ + isPrimary?: boolean; + /** Area of the boundary in acres. */ + acreage?: number; + /** Indicates if the parent is a field or a seasonal field. Permissible values are 'Field' and 'SeasonalField'. */ + parentType?: string; + /** Unique Id of the boundary. This Id is unique for a given farmer. */ + id?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; + /** User determined status of the resource. */ + status?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; + /** Name of the boundary. */ + name?: string; + /** Brief description of the boundary. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface GeoJsonObjectOutputBase { + type: "MultiPolygon" | "Point" | "Polygon"; +} + +export interface BoundaryOverlapResponseOutput { + /** Acreage of the main boundary. */ + boundaryAcreage?: number; + /** Acreage of the other boundary. */ + otherBoundaryAcreage?: number; + /** Acreage of the intersecting area between the given boundaries. */ + intersectingAcreage?: number; +} + +export interface CropListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface CropOutput { + /** Phenotype of the crop. */ + phenotype?: string; + /** Unique Id of the crop. */ + id?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; + /** User determined status of the resource. */ + status?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; + /** Name of the crop. */ + name?: string; + /** Brief description of the crop. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface CropVarietyListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface CropVarietyOutput { + /** Id of the associated crop. */ + cropId?: string; + /** Brand of the crop variety. */ + brand?: string; + /** Commercial name of the crop variety. */ + product?: string; + /** Unique Id of the crop variety. This Id is unique for a given crop. */ + id?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; + /** User determined status of the resource. */ + status?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; + /** Name of the crop variety. */ + name?: string; + /** Brief description of the crop variety. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface FarmerListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface FarmerOutput { + /** Unique Id of the farmer. */ + id?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; + /** User determined status of the resource. */ + status?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; + /** Name of the farmer. */ + name?: string; + /** Brief description of the farmer. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record; +} + +export interface FarmOperationDataIngestionJobOutput { + /** Id of the farmer whose farm operations are to be fetched. */ + farmerId: string; + /** Id of the farm operations data provider. Use 'JOHNDEERE' to fetch data from John Deere. */ + authProviderId: string; + /** List of types of farm operations for which data needs to be fetched. Valid values are AllOperations, Application, Planting, Harvest and Tillage. */ + operations?: Array; + /** The beginning year from when the farm operations data needs to be fetched (minimum = 2000, maximum = current year). */ + startYear: number; + /** Unique Id of the farm operations data ingestion job. This Id must be unique for a given tenant. */ + id?: string; + /** + * Status of the job. + * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. + */ + status?: string; + /** Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. */ + durationInSeconds?: number; + /** Brief description of the result of the job. */ + message?: string; + /** UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). */ + lastActionDateTime?: string; + /** UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). */ + startTime?: string; + /** UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + endTime?: string; + /** Name of the farm operations data ingestion job. */ + name?: string; + /** Brief description of the farm operations data ingestion job. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface FarmListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface FarmOutput { + /** Id of the associated farmer. */ + farmerId?: string; + /** Unique Id of the farm. This Id is unique for a given farmer. */ + id?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; + /** User determined status of the resource. */ + status?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; + /** Name of the farm. */ + name?: string; + /** Brief description of the farm. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface FieldListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface FieldOutput { + /** Id of the associated farm. */ + farmId?: string; + /** Id of the associated farmer. */ + farmerId?: string; + /** Id of the primary boundary associated with the field. At any point in time, a field can contain a maximum of one primary boundary. */ + primaryBoundaryId?: string; + /** List of Ids of boundaries associated with the field. */ + boundaryIds?: Array; + /** Unique Id of the field. This Id is unique for a given farmer. */ + id?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; + /** User determined status of the resource. */ + status?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; + /** Name of the field. */ + name?: string; + /** Brief description of the field. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface HarvestDataListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface HarvestDataOutput { + /** Schema for storing measurement reading and unit. */ + totalYield?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + avgYield?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + totalWetMass?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + avgWetMass?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + avgMoisture?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + avgSpeed?: MeasureOutput; + /** Details of harvested products. */ + harvestProductDetails?: Array; + /** Schema for storing measurement reading and unit. */ + area?: MeasureOutput; + /** Represents the source from which the harvest data was obtained. */ + source?: string; + /** UTC date-time at which the harvest data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. */ + operationModifiedDateTime?: string; + /** UTC date-time at which the harvest operation started (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationStartDateTime?: string; + /** UTC date-time at which the harvest operation ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationEndDateTime?: string; + /** Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. */ + attachmentsLink?: string; + /** Id of the boundary of the field/seasonal field on which the harvest operation was done. */ + associatedBoundaryId?: string; + /** Id of the boundary that is created using the geographical area on which the harvest operation was carried out. */ + operationBoundaryId?: string; + /** Id of the associated farmer. */ + farmerId?: string; + /** Unique Id of the operation (harvest). This Id is unique for a given farmer. */ + id?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; + /** User determined status of the resource. */ + status?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; + /** Name of the harvest operation. */ + name?: string; + /** Brief description of the harvest operation. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface HarvestProductDetailOutput { + /** Name of a harvested product. */ + productName?: string; + /** Schema for storing measurement reading and unit. */ + area?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + totalYield?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + avgYield?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + avgMoisture?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + totalWetMass?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + avgWetMass?: MeasureOutput; +} + +export interface ImageProcessingRasterizeJobOutput { + /** Id of the associated farmer. */ + farmerId: string; + /** Attachment id of the input shapefile which must be rasterized. */ + shapefileAttachmentId: string; + /** List of shapefile column names that must be rasterized. */ + shapefileColumnNames: Array; + /** Unique Id of the image processing (rasterize) job. This Id must be unique for a given tenant. */ + id?: string; + /** + * Status of the job. + * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. + */ + status?: string; + /** Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. */ + durationInSeconds?: number; + /** Brief description of the result of the job. */ + message?: string; + /** UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). */ + lastActionDateTime?: string; + /** UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). */ + startTime?: string; + /** UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + endTime?: string; + /** Name of the image processing (rasterize) job. */ + name?: string; + /** Brief description of the image processing (rasterize) job. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface OAuthProviderListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface OAuthProviderOutput { + /** OAuth App Id for a given OAuth Provider. */ + appId?: string; + /** + * OAuth App secret for a given OAuth Provider. + * Note: The app secret will not be part of the response. + */ + appSecret?: string; + /** + * OAuth Api key for a given Provider. + * Note: The Api key will not be part of the response. This is applicable only for authenticating to Climate Corp. + */ + apiKey?: string; + /** + * An optional flag to determine if the OAuth App is ready to be used for production scenarios. + * Note: This is applicable only for John Deere. + */ + isProductionApp?: boolean; + /** FarmBeats recognized unique Id for the OAuth provider. Valid value: 'JOHNDEERE. */ + id?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; + /** Name of the OAuth provider. */ + name?: string; + /** Brief description of the OAuth provider. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface OAuthProviderCascadeDeleteJobOutput { + /** FarmBeats recognized unique Id for the OAuth provider. Valid value: 'JOHNDEERE'. */ + oauthProviderId: string; + /** Unique Id of the OAuth provider delete job. This Id must be unique for a given tenant. */ + id?: string; + /** + * Status of the job. + * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. + */ + status?: string; + /** Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. */ + durationInSeconds?: number; + /** Brief description of the result of the job. */ + message?: string; + /** UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). */ + lastActionDateTime?: string; + /** UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). */ + startTime?: string; + /** UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + endTime?: string; + /** Name of the OAuth provider cascade delete job. */ + name?: string; + /** Brief description of the OAuth provider cascade delete job.. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface OAuthTokenListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface OAuthTokenOutput { + /** Id of the farmer for whom the OAuth flow is being configured. */ + farmerId: string; + /** Id of the OAuth provider resource containing the app information. */ + authProviderId: string; + /** An optional flag indicating whether the token is valid or expired. */ + isValid?: boolean; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; +} + +export interface PlantingDataListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface PlantingDataOutput { + /** Schema for storing measurement reading and unit. */ + avgPlantingRate?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + totalMaterial?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + avgMaterial?: MeasureOutput; + /** Details of products planted. */ + plantingProductDetails?: Array; + /** Schema for storing measurement reading and unit. */ + area?: MeasureOutput; + /** Represents the source from which the planting data was obtained. */ + source?: string; + /** UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. */ + operationModifiedDateTime?: string; + /** UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationStartDateTime?: string; + /** UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationEndDateTime?: string; + /** Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. */ + attachmentsLink?: string; + /** Id of the boundary of the field/seasonal field on which the planting operation was done. */ + associatedBoundaryId?: string; + /** Id of the boundary that is created using the geographical area on which the planting operation was carried out. */ + operationBoundaryId?: string; + /** Id of the associated farmer. */ + farmerId?: string; + /** Unique Id of the operation (planting). This Id is unique for a given farmer. */ + id?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; + /** User determined status of the resource. */ + status?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; + /** Name of the planting operation. */ + name?: string; + /** Brief description of the planting operation. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface PlantingProductDetailOutput { + /** Name of the planted product. */ + productName?: string; + /** Schema for storing measurement reading and unit. */ + area?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + totalMaterial?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + avgMaterial?: MeasureOutput; +} + +export interface SceneListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface SceneOutput { + /** UTC Date-time at which the image was captured/made available at source (format: yyyy-MM-ddTHH:mm:ssZ). */ + sceneDateTime?: string; + /** Name of the data provider for the scene. For satellite imagery, this refers to the name of the satellite data provider. */ + provider?: string; + /** Source from where the scene was procured/generated. For satellite imagery, this refers to the name of the satellite constellation. */ + source?: string; + /** Collection of image files. */ + imageFiles?: Array; + /** Supported image formats for scene resource. */ + imageFormat?: "TIF"; + /** Signifies the percentage of the scene covered by clouds. */ + cloudCoverPercentage?: number; + /** Signifies the percentage of the scene covered by dark pixels. */ + darkPixelPercentage?: number; + /** Median of NDVI values of the scene. */ + ndviMedianValue?: number; + /** Id of the associated boundary. */ + boundaryId?: string; + /** Id of the associated farmer. */ + farmerId?: string; + /** Unique Id of the scene */ + id?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; +} + +export interface ImageFileOutput { + /** Link to the image file. */ + fileLink?: string; + /** Name of the image file. */ + name: string; + /** Supported image formats for scene resource. */ + imageFormat?: "TIF"; + /** Resolution of image in meters. */ + resolution?: number; +} + +export interface SatelliteDataIngestionJobOutput { + /** Id of the associated farmer. */ + farmerId: string; + /** The id of the boundary for which satellite data is being fetched. */ + boundaryId: string; + /** UTC Date-time from when the satellite data has to be fetched (format: yyyy-MM-ddTHH:mm:ssZ). */ + startDateTime: string; + /** UTC Date-time till when the satellite data has to be fetched (format: yyyy-MM-ddTHH:mm:ssZ). */ + endDateTime: string; + /** Provider of satellite data. */ + provider?: "Microsoft"; + /** Source of satellite data. */ + source?: "Sentinel_2_L2A"; + /** Data Model for SatelliteIngestionJobRequest. */ + data?: SatelliteDataOutput; + /** Unique Id of the satellite data ingestion job. This Id must be unique for a given tenant. */ + id?: string; + /** + * Status of the job. + * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. + */ + status?: string; + /** DProcessing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. */ + durationInSeconds?: number; + /** Brief description of the result of the job. */ + message?: string; + /** UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). */ + lastActionDateTime?: string; + /** UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). */ + startTime?: string; + /** UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + endTime?: string; + /** Name of the satellite data ingestion job. */ + name?: string; + /** Brief description of the satellite data ingestion job. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface SatelliteDataOutput { + /** + * List of names of images to be fetched. + * For Sentinel-2, allowed values are: 'B01', 'B02', 'B03', 'B04', 'B05', 'B06', 'B07', 'B08', 'B8A', 'B09', 'B11', 'B12', 'AOT', 'SCL', 'SNW', 'CLD', 'NDVI', 'NDWI', 'EVI', 'LAI', 'LAIMask', 'CLP', 'CLM', and 'dataMask'. + */ + imageNames?: Array; + /** List of formats in which images can be fetched. Available value: TIF. */ + imageFormats?: Array; + /** List of image resolutions in meters. For Sentinel-2, available values are: 10, 20, 60. */ + imageResolutions?: Array; +} + +export interface SeasonalFieldListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface SeasonalFieldOutput { + /** Id of the associated farmer. */ + farmerId?: string; + /** Id of the primary boundary associated with the seasonal field. At any point in time, a seasonal field can contain a maximum of one primary boundary. */ + primaryBoundaryId?: string; + /** List of Ids of boundaries associated with the seasonal field. */ + boundaryIds?: Array; + /** Id of the associated farm. */ + farmId?: string; + /** Id of the associated field. */ + fieldId?: string; + /** Id of the season associated with the seasonal field. */ + seasonId?: string; + /** List of Ids of crop varieties associated with the seasonal field. All the crop varieties must belong to the same crop. */ + cropVarietyIds?: Array; + /** Id of the crop associated with the seasonal field. Seasonal fields are mono crop entities. */ + cropId?: string; + /** Average yield generated from the seasonal field. */ + avgYieldValue?: number; + /** Unit to measure average yield. */ + avgYieldUnit?: string; + /** Average seed population planted in the seasonal field. */ + avgSeedPopulationValue?: number; + /** Unit to measure average seed population. */ + avgSeedPopulationUnit?: string; + /** UTC Date-time at which crops were planted (format: yyyy-MM-ddTHH:mm:ssZ). */ + plantingDateTime?: string; + /** Unique Id of the seasonal field. This Id is unique for a given farmer. */ + id?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; + /** User determined status of the resource. */ + status?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; + /** Name of the seasonal field. */ + name?: string; + /** Brief description of the seasonal field. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface SeasonListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface SeasonOutput { + /** UTC date-time signifying the start of the season (format: yyyy-MM-ddTHH:mm:ssZ). */ + startDateTime?: string; + /** UTC date-time signifying the end of the season (format: yyyy-MM-ddTHH:mm:ssZ). */ + endDateTime?: string; + /** Year associated with the harvest i.e. year of season end date-time. */ + year?: number; + /** Unique Id of the season. */ + id?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; + /** User determined status of the resource. */ + status?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; + /** Name of the season. */ + name?: string; + /** Brief description of the season. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface TillageDataListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface TillageDataOutput { + /** Schema for storing measurement reading and unit. */ + tillageDepth?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + tillagePressure?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + area?: MeasureOutput; + /** Represents the source from which the tillage data was obtained. */ + source?: string; + /** UTC date-time at which the operation data was modified at the source (format: yyyy-MM-ddTHH:mm:ssZ). This will be specified by the source. */ + operationModifiedDateTime?: string; + /** UTC date-time at which the operation started (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationStartDateTime?: string; + /** UTC date-time at which the operation ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + operationEndDateTime?: string; + /** Link to 'Attachments API' that can be used to find shapefiles, raster files or any other attachments associated with this operation. */ + attachmentsLink?: string; + /** Id of the boundary of the field/seasonal field on which the tillage operation was done. */ + associatedBoundaryId?: string; + /** Id of the boundary that is created using the geographical area on which the tillage operation was carried out. */ + operationBoundaryId?: string; + /** Id of the associated farmer. */ + farmerId?: string; + /** Unique Id of the operation (tillage). This Id is unique for a given farmer. */ + id?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; + /** User determined status of the resource. */ + status?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; + /** Name of the tillage operation. */ + name?: string; + /** Brief description of the tillage operation. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface WeatherDataListResponseOutput { + /** List of requested objects. */ + value?: Array; + /** Token used in retrieving the next page. If null, there are no additional pages. */ + $skipToken?: string; + /** Continuation link (absolute URI) to the next page of results in the list. If null, there are no additional pages. */ + nextLink?: string; +} + +export interface WeatherDataOutput { + /** Id of the associated farmer. */ + farmerId: string; + /** Id of the associated boundary. */ + boundaryId: string; + /** Id of the weather extension. This signifies the source from where the weather data is fetched (eg. DTN.ClearAg). */ + extensionId: string; + /** Location model class. */ + location: LocationOutput; + /** UTC Date-time of the weather data (format: yyyy-MM-ddTHH:mm:ssZ). */ + dateTime: string; + /** Unit system like US/SI etc. */ + unitSystemCode?: string; + /** Version of the weather data extension. */ + extensionVersion: string; + /** Type of weather data (forecast/historical). */ + weatherDataType: string; + /** Granularity of weather data (daily/hourly). */ + granularity: string; + /** Schema for storing measurement reading and unit. */ + cloudCover?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + dewPoint?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + growingDegreeDay?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + precipitation?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + pressure?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + relativeHumidity?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + soilMoisture?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + soilTemperature?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + temperature?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + visibility?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + wetBulbTemperature?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + windChill?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + windDirection?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + windGust?: MeasureOutput; + /** Schema for storing measurement reading and unit. */ + windSpeed?: MeasureOutput; + /** Unique id of weather data. */ + id?: string; + /** ETag value can be used to implement optimistic concurrency. */ + eTag?: string; + /** UTC Date-time at which the resource was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the resource was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + modifiedDateTime?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface LocationOutput { + /** Latitude of the location. */ + latitude: number; + /** Longitude of the location. */ + longitude: number; +} + +export interface WeatherDataIngestionJobOutput { + /** Id of the associated boundary. */ + boundaryId: string; + /** Id of the associated farmer. */ + farmerId: string; + /** Id of the weather extension. This signifies the source from where the weather data is fetched (eg. DTN.ClearAg). */ + extensionId: string; + /** Extension api name to which the request is to be made. */ + extensionApiName: string; + /** Dictionary of inputs for extension api. This would be passed as part fo request to weather data provider. */ + extensionApiInput: Record>; + /** App id of the weather data provider. */ + extensionDataProviderAppId?: string; + /** Api key of the weather data provider. */ + extensionDataProviderApiKey?: string; + /** Unique Id of the weather data ingestion job. This Id must be unique for a given tenant. */ + id?: string; + /** + * Status of the job. + * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. + */ + status?: string; + /** Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. */ + durationInSeconds?: number; + /** Brief description of the result of the job. */ + message?: string; + /** UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). */ + lastActionDateTime?: string; + /** UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). */ + startTime?: string; + /** UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + endTime?: string; + /** Name to weather data ingestion job. */ + name?: string; + /** Brief description of the weather data ingestion job. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface WeatherDataDeleteJobOutput { + /** Id of the weather extension. This signifies the source from where the weather data was fetched (eg. DTN.ClearAg). */ + extensionId: string; + /** The Id of the associated farmer. */ + farmerId: string; + /** The id of the associated boundary. */ + boundaryId: string; + /** Type of weather data (forecast/historical). */ + weatherDataType?: string; + /** Granularity of weather data (daily/hourly). */ + granularity?: string; + /** UTC Date-time from when the weather data has to be deleted (format: yyyy-MM-ddTHH:mm:ssZ). */ + startDateTime?: string; + /** UTC Date-time till when the weather data has to be deleted (format: yyyy-MM-ddTHH:mm:ssZ). */ + endDateTime?: string; + /** Unique Id of the weather data delete job. This Id must be unique for a given tenant. */ + id?: string; + /** + * Status of the job. + * Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'. + */ + status?: string; + /** Processing duration of the job. Can be calculated as min(current time, job succeeded/failed/cancelled time) - job execution start time. This does not include the time spent waiting in the queue for the job to be picked up for processing. */ + durationInSeconds?: number; + /** Brief description of the result of the job. */ + message?: string; + /** UTC Date-time at which the job was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + createdDateTime?: string; + /** UTC Date-time at which the job was last acted upon (format: yyyy-MM-ddTHH:mm:ssZ). */ + lastActionDateTime?: string; + /** UTC Date-time at which the processing of the job started (format: yyyy-MM-ddTHH:mm:ssZ). */ + startTime?: string; + /** UTC Date-time at which the processing of the job ended (format: yyyy-MM-ddTHH:mm:ssZ). */ + endTime?: string; + /** Name of the weather data deletion job. */ + name?: string; + /** Brief description of the weather data deletion job. */ + description?: string; + /** A collection of key value pairs associated with the resource. A key is a string and a value can be a numeric or a string. A maximum of 25 key value pairs can be associated with a resource. */ + properties?: Record>; +} + +export interface MultiPolygonOutput extends GeoJsonObjectOutputBase, MultiPolygonCoordinatesOutput { + type: "MultiPolygon"; +} + +export interface MultiPolygonCoordinatesOutput { + /** + * Gets or sets coordinates of GeoJSON Object. + * It must be an array of polygons, each polygon contains list of linear rings. + * For Polygons with more than one of these rings, the first MUST be the exterior ring, + * and any others MUST be interior rings. + */ + coordinates: Array>>>; +} + +export interface PointOutput extends GeoJsonObjectOutputBase, PointCoordinatesOutput { + type: "Point"; +} + +export interface PointCoordinatesOutput { + /** + * Gets or sets the coordinate of this point. + * It must be an array of 2 or 3 elements for a 2D or 3D system respectively. + */ + coordinates: Array; +} + +export interface PolygonOutput extends GeoJsonObjectOutputBase, PolygonCoordinatesOutput { + type: "Polygon"; +} + +export interface PolygonCoordinatesOutput { + /** + * Gets or sets type of the GeoJSON Object. + * It must be an array of linear ring coordinate arrays. + * For Polygons with more than one of these rings, the first MUST be the exterior ring, + * and any others MUST be interior rings. + */ + coordinates: Array>>; +} + +export type GeoJsonObjectOutput = MultiPolygonOutput | PointOutput | PolygonOutput; diff --git a/sdk/agrifood/agrifood-farming-rest/src/paginateHelper.ts b/sdk/agrifood/agrifood-farming-rest/src/paginateHelper.ts new file mode 100644 index 000000000000..532e2603f724 --- /dev/null +++ b/sdk/agrifood/agrifood-farming-rest/src/paginateHelper.ts @@ -0,0 +1,131 @@ +// Copyright (c) Microsoft Corporation. +// Licensed under the MIT license. + +import { PagedAsyncIterableIterator, PagedResult, getPagedAsyncIterator } from "@azure/core-paging"; +import { Client, PathUncheckedResponse, createRestError } from "@azure-rest/core-client"; + +/** + * Helper type to extract the type of an array + */ +export type GetArrayType = T extends Array ? TData : never; + +/** + * The type of a custom function that defines how to get a page and a link to the next one if any. + */ +export type GetPage = ( + pageLink: string, + maxPageSize?: number +) => Promise<{ + page: TPage; + nextPageLink?: string; +}>; + +/** + * Options for the paging helper + */ +export interface PagingOptions { + /** + * Custom function to extract pagination details for crating the PagedAsyncIterableIterator + */ + customGetPage?: GetPage[]>; +} + +/** + * Helper type to infer the Type of the paged elements from the response type + * This type is generated based on the swagger information for x-ms-pageable + * specifically on the itemName property which indicates the property of the response + * where the page items are found. The default value is `value`. + * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter + */ +export type PaginateReturn = TResult extends { + body: { value?: infer TPage }; +} + ? GetArrayType + : Array; + +/** + * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension + * @param client - Client to use for sending the next page requests + * @param initialResponse - Initial response containing the nextLink and current page of elements + * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results + * @returns - PagedAsyncIterableIterator to iterate the elements + */ +export function paginate( + client: Client, + initialResponse: TResponse, + options: PagingOptions = {} +): PagedAsyncIterableIterator> { + // Extract element type from initial response + type TElement = PaginateReturn; + let firstRun = true; + const itemName = "value"; + const nextLinkName = "nextLink"; + const { customGetPage } = options; + const pagedResult: PagedResult = { + firstPageLink: "", + getPage: + typeof customGetPage === "function" + ? customGetPage + : async (pageLink: string) => { + const result = firstRun ? initialResponse : await client.pathUnchecked(pageLink).get(); + firstRun = false; + checkPagingRequest(result); + const nextLink = getNextLink(result.body, nextLinkName); + const values = getElements(result.body, itemName); + return { + page: values, + nextPageLink: nextLink, + }; + }, + }; + + return getPagedAsyncIterator(pagedResult); +} + +/** + * Gets for the value of nextLink in the body + */ +function getNextLink(body: unknown, nextLinkName?: string): string | undefined { + if (!nextLinkName) { + return undefined; + } + + const nextLink = (body as Record)[nextLinkName]; + + if (typeof nextLink !== "string" && typeof nextLink !== "undefined") { + throw new Error(`Body Property ${nextLinkName} should be a string or undefined`); + } + + return nextLink; +} + +/** + * Gets the elements of the current request in the body. + */ +function getElements(body: unknown, itemName: string): T[] { + const value = (body as Record)[itemName] as T[]; + + // value has to be an array according to the x-ms-pageable extension. + // The fact that this must be an array is used above to calculate the + // type of elements in the page in PaginateReturn + if (!Array.isArray(value)) { + throw new Error( + `Couldn't paginate response\n Body doesn't contain an array property with name: ${itemName}` + ); + } + + return value ?? []; +} + +/** + * Checks if a request failed + */ +function checkPagingRequest(response: PathUncheckedResponse): void { + const Http2xxStatusCodes = ["200", "201", "202", "203", "204", "205", "206", "207", "208", "226"]; + if (!Http2xxStatusCodes.includes(response.status)) { + throw createRestError( + `Pagination failed with unexpected statusCode ${response.status}`, + response + ); + } +} diff --git a/sdk/agrifood/agrifood-farming-rest/src/paging.ts b/sdk/agrifood/agrifood-farming-rest/src/paging.ts deleted file mode 100644 index 2dabe2eeb0d0..000000000000 --- a/sdk/agrifood/agrifood-farming-rest/src/paging.ts +++ /dev/null @@ -1,37 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -import { paginateResponse, PagedAsyncIterableIterator } from "@azure-rest/core-client-paging"; -import { Client, PathUncheckedResponse } from "@azure-rest/core-client"; - -/** - * Helper type to extract the type of an array - */ -export type GetArrayType = T extends Array ? TData : never; - -/** - * Helper type to infer the Type of the paged elements from the response type - * This type is generated based on the swagger information for x-ms-pageable - * specifically on the itemName property which indicates the property of the response - * where the page items are found. The default value is `value`. - * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter - */ -export type PaginateReturn = TResult extends { - body: { value?: infer TPage }; -} - ? GetArrayType - : Array; - -/** - * This is the wrapper function that would be exposed. It is hiding the Pagination Options because it can be - * obtained from the swagger - * @param client - Client to use for sending the next page requests - * @param initialResponse - Initial response containing the nextLink and current page of elements - * @returns - PagedAsyncIterableIterator to iterate the elements - */ -export function paginate( - client: Client, - initialResponse: TReturn -): PagedAsyncIterableIterator, PaginateReturn[]> { - return paginateResponse>(client, initialResponse); -} diff --git a/sdk/agrifood/agrifood-farming-rest/src/parameters.ts b/sdk/agrifood/agrifood-farming-rest/src/parameters.ts index b8f5d0030548..a8f558b9f9ba 100644 --- a/sdk/agrifood/agrifood-farming-rest/src/parameters.ts +++ b/sdk/agrifood/agrifood-farming-rest/src/parameters.ts @@ -4,81 +4,78 @@ import { RequestParameters } from "@azure-rest/core-client"; import { ApplicationData, - SearchBoundaryQuery, Boundary, Crop, CropVariety, - Farmer, - FarmOperationDataIngestionJob, Farm, + FarmOperationDataIngestionJob, + Farmer, Field, HarvestData, ImageProcessingRasterizeJob, - OAuthProvider, OAuthConnectRequest, + OAuthProvider, PlantingData, SatelliteDataIngestionJob, - SeasonalField, + SearchBoundaryQuery, Season, + SeasonalField, TillageData, - WeatherDataIngestionJob, WeatherDataDeleteJob, + WeatherDataIngestionJob, } from "./models"; export interface ApplicationDataListByFarmerIdQueryParamProperties { - /** Minimum average amount of material applied during the application (inclusive). */ + /** Application data with average material greater than or equal to the value specified will be returned. */ minAvgMaterial?: number; - /** Maximum average amount of material applied during the application (inclusive). */ + /** Application data with average material lesser than or equal to the value specified will be returned. */ maxAvgMaterial?: number; - /** Minimum total amount of material applied during the application (inclusive). */ + /** Application data with total material greater than or equal to the value specified will be returned. */ minTotalMaterial?: number; - /** Maximum total amount of material applied during the application (inclusive). */ + /** Application data with total material lesser than or equal to the value specified will be returned. */ maxTotalMaterial?: number; - /** Sources of the operation data. */ - sources?: string[]; - /** Boundary IDs associated with operation data. */ - associatedBoundaryIds?: string[]; - /** Operation boundary IDs associated with operation data. */ - operationBoundaryIds?: string[]; - /** Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationStartDateTime?: Date; - /** Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationStartDateTime?: Date; - /** Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationEndDateTime?: Date; - /** Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationEndDateTime?: Date; - /** Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationModifiedDateTime?: Date; - /** Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationModifiedDateTime?: Date; - /** Minimum area for which operation was applied (inclusive). */ + /** Application data obtained from the given list of sources will be returned. */ + sources?: Array; + /** List of boundary Ids of the field/seasonal field on which the application operation was done. */ + associatedBoundaryIds?: Array; + /** List of the boundary Ids that were created using the geographical area on which the application operation was carried out. */ + operationBoundaryIds?: Array; + /** Application operations that began at or after the given UTC date-time is returned. */ + minOperationStartDateTime?: Date | string; + /** Application operations that began at or before the given UTC date-time is returned. */ + maxOperationStartDateTime?: Date | string; + /** Application operations that ended at or after the given UTC date-time is returned. */ + minOperationEndDateTime?: Date | string; + /** Application operations that ended at or before the given UTC date-time is returned. */ + maxOperationEndDateTime?: Date | string; + /** Application operations that were modified (at source) at or after the given UTC date-time is returned. */ + minOperationModifiedDateTime?: Date | string; + /** Application operations that were modified (at source) at or before the given UTC date-time is returned. */ + maxOperationModifiedDateTime?: Date | string; + /** Application operations carried over area greater than or equal to the given value is returned. */ minArea?: number; - /** Maximum area for which operation was applied (inclusive). */ + /** Application operations carried over area lesser than or equal to the given value is returned. */ maxArea?: number; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; - /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; + /** List of Ids of application operations to be returned. */ + ids?: Array; + /** List of names of application operations to be returned. */ + names?: Array; /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Application data with only given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned. */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned. */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned. */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned. */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -88,63 +85,60 @@ export interface ApplicationDataListByFarmerIdQueryParam { queryParameters?: ApplicationDataListByFarmerIdQueryParamProperties; } -export type ApplicationDataListByFarmerIdParameters = RequestParameters & - ApplicationDataListByFarmerIdQueryParam; +export type ApplicationDataListByFarmerIdParameters = ApplicationDataListByFarmerIdQueryParam & + RequestParameters; export interface ApplicationDataListQueryParamProperties { - /** Minimum average amount of material applied during the application (inclusive). */ + /** Application data with average material greater than or equal to the value specified will be returned. */ minAvgMaterial?: number; - /** Maximum average amount of material applied during the application (inclusive). */ + /** Application data with average material lesser than or equal to the value specified will be returned. */ maxAvgMaterial?: number; - /** Minimum total amount of material applied during the application (inclusive). */ + /** Application data with total material greater than or equal to the value specified will be returned. */ minTotalMaterial?: number; - /** Maximum total amount of material applied during the application (inclusive). */ + /** Application data with total material lesser than or equal to the value specified will be returned. */ maxTotalMaterial?: number; - /** Sources of the operation data. */ - sources?: string[]; - /** Boundary IDs associated with operation data. */ - associatedBoundaryIds?: string[]; - /** Operation boundary IDs associated with operation data. */ - operationBoundaryIds?: string[]; - /** Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationStartDateTime?: Date; - /** Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationStartDateTime?: Date; - /** Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationEndDateTime?: Date; - /** Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationEndDateTime?: Date; - /** Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationModifiedDateTime?: Date; - /** Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationModifiedDateTime?: Date; - /** Minimum area for which operation was applied (inclusive). */ + /** Application data obtained from the given list of sources will be returned. */ + sources?: Array; + /** List of boundary Ids of the field/seasonal field on which the application operation was done. */ + associatedBoundaryIds?: Array; + /** List of the boundary Ids that were created using the geographical area on which the application operation was carried out. */ + operationBoundaryIds?: Array; + /** Application operations that began at or after the given UTC date-time is returned. */ + minOperationStartDateTime?: Date | string; + /** Application operations that began at or before the given UTC date-time is returned. */ + maxOperationStartDateTime?: Date | string; + /** Application operations that ended at or after the given UTC date-time is returned. */ + minOperationEndDateTime?: Date | string; + /** Application operations that ended at or before the given UTC date-time is returned. */ + maxOperationEndDateTime?: Date | string; + /** Application operations that were modified (at source) at or after the given UTC date-time is returned. */ + minOperationModifiedDateTime?: Date | string; + /** Application operations that were modified (at source) at or before the given UTC date-time is returned. */ + maxOperationModifiedDateTime?: Date | string; + /** Application operations carried over area greater than or equal to the given value is returned. */ minArea?: number; - /** Maximum area for which operation was applied (inclusive). */ + /** Application operations carried over area lesser than or equal to the given value is returned. */ maxArea?: number; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; + /** List of Ids of application operations to be returned. */ + ids?: Array; + /** List of names of application operations to be returned. */ + names?: Array; /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; - /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Application data with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -154,45 +148,64 @@ export interface ApplicationDataListQueryParam { queryParameters?: ApplicationDataListQueryParamProperties; } -export type ApplicationDataListParameters = RequestParameters & ApplicationDataListQueryParam; +export type ApplicationDataListParameters = ApplicationDataListQueryParam & RequestParameters; export type ApplicationDataGetParameters = RequestParameters; export interface ApplicationDataCreateOrUpdateBodyParam { + /** Application data resource payload to Create or update. */ body?: ApplicationData; } -export type ApplicationDataCreateOrUpdateParameters = RequestParameters & - ApplicationDataCreateOrUpdateBodyParam; +export interface ApplicationDataCreateOrUpdateMediaTypesParam { + /** Request content type */ + contentType?: "application/merge-patch+json"; +} + +export type ApplicationDataCreateOrUpdateParameters = ApplicationDataCreateOrUpdateMediaTypesParam & + ApplicationDataCreateOrUpdateBodyParam & + RequestParameters; export type ApplicationDataDeleteParameters = RequestParameters; +export type ApplicationDataGetCascadeDeleteJobDetailsParameters = RequestParameters; + +export interface ApplicationDataCreateCascadeDeleteJobQueryParamProperties { + /** Id of the associated farmer. */ + farmerId: string; + /** Id of the application data resource. */ + applicationDataId: string; +} + +export interface ApplicationDataCreateCascadeDeleteJobQueryParam { + queryParameters: ApplicationDataCreateCascadeDeleteJobQueryParamProperties; +} + +export type ApplicationDataCreateCascadeDeleteJobParameters = + ApplicationDataCreateCascadeDeleteJobQueryParam & RequestParameters; export interface AttachmentsListByFarmerIdQueryParamProperties { - /** Resource Ids of the resource. */ - resourceIds?: string[]; - /** Resource Types of the resource. */ - resourceTypes?: string[]; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; - /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; + /** Attachments belonging to the given list of resources will be returned. */ + resourceIds?: Array; + /** Attachments belonging to the resources of the given resource types will be returned. Valid values are Farmer, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageDat and PlantingData. */ + resourceTypes?: Array; + /** Ids of the attachments to be returned. */ + ids?: Array; + /** List of names of attachments to be returned. */ + names?: Array; /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Attachments with only the given statuses are returned. */ + statuses?: Array; + /** Attachments created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Attachments created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Attachments last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Attachments last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -202,53 +215,87 @@ export interface AttachmentsListByFarmerIdQueryParam { queryParameters?: AttachmentsListByFarmerIdQueryParamProperties; } -export type AttachmentsListByFarmerIdParameters = RequestParameters & - AttachmentsListByFarmerIdQueryParam; +export type AttachmentsListByFarmerIdParameters = AttachmentsListByFarmerIdQueryParam & + RequestParameters; export type AttachmentsGetParameters = RequestParameters; export interface AttachmentsCreateOrUpdateBodyParam { - body?: string; + body?: AttachmentsCreateOrUpdateFormBody; } -export type AttachmentsCreateOrUpdateParameters = RequestParameters & - AttachmentsCreateOrUpdateBodyParam; +export interface AttachmentsCreateOrUpdateFormBody { + /** + * File to be uploaded. + * + * Value may contain any sequence of octets + */ + file?: string | Uint8Array; + /** Id of the associated farmer. */ + FarmerId?: string; + /** This is the Id of the resource to which the attachment belongs. Ids of following entities are valid: Farmer, Farm, Field, Seasonal field, Boundary, Application data, Harvest data, Tillage data and Planting data. */ + ResourceId?: string; + /** Indicates the type of resource to which this attachment belongs. Valid values are Farmer, Farm, Field, SeasonalField, Boundary, ApplicationData, HarvestData, TillageDat and PlantingData. */ + ResourceType?: string; + /** Original file name of the attachment. */ + OriginalFileName?: string; + /** Unique Id of the attachment. This Id is unique for a given farmer. */ + Id?: string; + /** User provided status of the attachment. */ + Status?: string; + /** UTC Date-time at which the attachment was created (format: yyyy-MM-ddTHH:mm:ssZ). */ + CreatedDateTime?: string; + /** UTC Date-time at which the attachment was last modified (format: yyyy-MM-ddTHH:mm:ssZ). */ + ModifiedDateTime?: string; + /** Name of the attachment. */ + Name?: string; + /** Brief description of the attachment. */ + Description?: string; + /** ETag value can be used to implement optimistic concurrency. */ + ETag?: string; +} + +export interface AttachmentsCreateOrUpdateMediaTypesParam { + /** Request content type */ + contentType?: "multipart/form-data"; +} + +export type AttachmentsCreateOrUpdateParameters = AttachmentsCreateOrUpdateMediaTypesParam & + AttachmentsCreateOrUpdateBodyParam & + RequestParameters; export type AttachmentsDeleteParameters = RequestParameters; export type AttachmentsDownloadParameters = RequestParameters; export interface BoundariesListByFarmerIdQueryParamProperties { - /** Is the boundary primary. */ + /** If set, only primary boundaries are returned. */ isPrimary?: boolean; - /** Type of the parent it belongs to. */ + /** Boundaries with given parent types are returned. VAlid values are 'Field' and 'SeasonalField'. */ parentType?: string; - /** Parent Ids of the resource. */ - parentIds?: string[]; - /** Minimum acreage of the boundary (inclusive). */ + /** Boundaries associated with the given parent Ids are returned. */ + parentIds?: Array; + /** Boundaries with acreage equal to or greater than the given value are returned. */ minAcreage?: number; - /** Maximum acreage of the boundary (inclusive). */ + /** Boundaries with acreage equal to or lesser than the given value are returned. */ maxAcreage?: number; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; - /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; + /** List of Ids of boundaries to be returned. */ + ids?: Array; + /** List of names of boundaries to be returned. */ + names?: Array; /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Boundaries with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -258,50 +305,54 @@ export interface BoundariesListByFarmerIdQueryParam { queryParameters?: BoundariesListByFarmerIdQueryParamProperties; } -export type BoundariesListByFarmerIdParameters = RequestParameters & - BoundariesListByFarmerIdQueryParam; +export type BoundariesListByFarmerIdParameters = BoundariesListByFarmerIdQueryParam & + RequestParameters; export interface BoundariesSearchByFarmerIdBodyParam { + /** Query filters. */ body?: SearchBoundaryQuery; } -export type BoundariesSearchByFarmerIdParameters = RequestParameters & - BoundariesSearchByFarmerIdBodyParam; +export interface BoundariesSearchByFarmerIdMediaTypesParam { + /** Request content type */ + contentType?: "application/json"; +} + +export type BoundariesSearchByFarmerIdParameters = BoundariesSearchByFarmerIdMediaTypesParam & + BoundariesSearchByFarmerIdBodyParam & + RequestParameters; export interface BoundariesListQueryParamProperties { - /** Is the boundary primary. */ + /** If set, only primary boundaries are returned. */ isPrimary?: boolean; - /** Type of the parent it belongs to. */ + /** Boundaries with given parent types are returned. VAlid values are 'Field' and 'SeasonalField'. */ parentType?: string; - /** Parent Ids of the resource. */ - parentIds?: string[]; - /** Minimum acreage of the boundary (inclusive). */ + /** Boundaries associated with the given parent Ids are returned. */ + parentIds?: Array; + /** Boundaries with acreage equal to or greater than the given value are returned. */ minAcreage?: number; - /** Maximum acreage of the boundary (inclusive). */ + /** Boundaries with acreage equal to or lesser than the given value are returned. */ maxAcreage?: number; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; - /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; + /** List of Ids of boundaries to be returned. */ + ids?: Array; + /** List of names of boundaries to be returned. */ + names?: Array; /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Boundaries with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -311,19 +362,27 @@ export interface BoundariesListQueryParam { queryParameters?: BoundariesListQueryParamProperties; } -export type BoundariesListParameters = RequestParameters & BoundariesListQueryParam; +export type BoundariesListParameters = BoundariesListQueryParam & RequestParameters; export interface BoundariesSearchBodyParam { + /** Query filters. */ body?: SearchBoundaryQuery; } -export type BoundariesSearchParameters = RequestParameters & BoundariesSearchBodyParam; +export interface BoundariesSearchMediaTypesParam { + /** Request content type */ + contentType?: "application/json"; +} + +export type BoundariesSearchParameters = BoundariesSearchMediaTypesParam & + BoundariesSearchBodyParam & + RequestParameters; export type BoundariesGetCascadeDeleteJobDetailsParameters = RequestParameters; export interface BoundariesCreateCascadeDeleteJobQueryParamProperties { - /** ID of the associated farmer. */ + /** Id of the associated farmer. */ farmerId: string; - /** ID of the boundary to be deleted. */ + /** Id of the boundary to be deleted. */ boundaryId: string; } @@ -331,22 +390,29 @@ export interface BoundariesCreateCascadeDeleteJobQueryParam { queryParameters: BoundariesCreateCascadeDeleteJobQueryParamProperties; } -export type BoundariesCreateCascadeDeleteJobParameters = RequestParameters & - BoundariesCreateCascadeDeleteJobQueryParam; +export type BoundariesCreateCascadeDeleteJobParameters = + BoundariesCreateCascadeDeleteJobQueryParam & RequestParameters; export type BoundariesGetParameters = RequestParameters; export interface BoundariesCreateOrUpdateBodyParam { + /** Boundary resource payload to Create or update. */ body?: Boundary; } -export type BoundariesCreateOrUpdateParameters = RequestParameters & - BoundariesCreateOrUpdateBodyParam; +export interface BoundariesCreateOrUpdateMediaTypesParam { + /** Request content type */ + contentType?: "application/merge-patch+json"; +} + +export type BoundariesCreateOrUpdateParameters = BoundariesCreateOrUpdateMediaTypesParam & + BoundariesCreateOrUpdateBodyParam & + RequestParameters; export type BoundariesDeleteParameters = RequestParameters; export interface BoundariesGetOverlapQueryParamProperties { - /** FarmerId of the other field. */ + /** Id of the farmer associated with the other boundary. */ otherFarmerId: string; - /** ID of the other boundary. */ + /** Id of the other boundary. */ otherBoundaryId: string; } @@ -354,34 +420,31 @@ export interface BoundariesGetOverlapQueryParam { queryParameters: BoundariesGetOverlapQueryParamProperties; } -export type BoundariesGetOverlapParameters = RequestParameters & BoundariesGetOverlapQueryParam; +export type BoundariesGetOverlapParameters = BoundariesGetOverlapQueryParam & RequestParameters; export interface CropsListQueryParamProperties { - /** Crop phenotypes of the resource. */ - phenotypes?: string[]; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; + /** Crops with the given list of phenotypes are returned. */ + phenotypes?: Array; + /** List of Ids of crops to be returned. */ + ids?: Array; + /** List of names of crops to be returned. */ + names?: Array; /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; - /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Crops with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -391,46 +454,51 @@ export interface CropsListQueryParam { queryParameters?: CropsListQueryParamProperties; } -export type CropsListParameters = RequestParameters & CropsListQueryParam; +export type CropsListParameters = CropsListQueryParam & RequestParameters; export type CropsGetParameters = RequestParameters; export interface CropsCreateOrUpdateBodyParam { + /** Crop resource payload to create or update. */ body?: Crop; } -export type CropsCreateOrUpdateParameters = RequestParameters & CropsCreateOrUpdateBodyParam; +export interface CropsCreateOrUpdateMediaTypesParam { + /** Request content type */ + contentType?: "application/merge-patch+json"; +} + +export type CropsCreateOrUpdateParameters = CropsCreateOrUpdateMediaTypesParam & + CropsCreateOrUpdateBodyParam & + RequestParameters; export type CropsDeleteParameters = RequestParameters; export interface CropVarietiesListByCropIdQueryParamProperties { - /** CropIds of the resource. */ - cropIds?: string[]; - /** Brands of the resource. */ - brands?: string[]; - /** Products of the resource. */ - products?: string[]; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; - /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; + /** Crop varieties associated with the given list of crop ids are returned. */ + cropIds?: Array; + /** Crop varieties associated with the given list of brands are returned. */ + brands?: Array; + /** Crop varieties associated with the given list of products are returned. */ + products?: Array; + /** List of Ids of crop varieties to be returned. */ + ids?: Array; + /** List of names of crop varieties to be returned. */ + names?: Array; /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Crop varieties with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -440,39 +508,36 @@ export interface CropVarietiesListByCropIdQueryParam { queryParameters?: CropVarietiesListByCropIdQueryParamProperties; } -export type CropVarietiesListByCropIdParameters = RequestParameters & - CropVarietiesListByCropIdQueryParam; +export type CropVarietiesListByCropIdParameters = CropVarietiesListByCropIdQueryParam & + RequestParameters; export interface CropVarietiesListQueryParamProperties { - /** CropIds of the resource. */ - cropIds?: string[]; - /** Brands of the resource. */ - brands?: string[]; - /** Products of the resource. */ - products?: string[]; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; - /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; + /** Crop varieties associated with the given list of crop ids are returned. */ + cropIds?: Array; + /** Crop varieties associated with the given list of brands are returned. */ + brands?: Array; + /** Crop varieties associated with the given list of products are returned. */ + products?: Array; + /** List of Ids of crop varieties to be returned. */ + ids?: Array; + /** List of names of crop varieties to be returned. */ + names?: Array; /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Crop varieties with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -482,41 +547,45 @@ export interface CropVarietiesListQueryParam { queryParameters?: CropVarietiesListQueryParamProperties; } -export type CropVarietiesListParameters = RequestParameters & CropVarietiesListQueryParam; +export type CropVarietiesListParameters = CropVarietiesListQueryParam & RequestParameters; export type CropVarietiesGetParameters = RequestParameters; export interface CropVarietiesCreateOrUpdateBodyParam { + /** Crop variety resource payload to create or update. */ body?: CropVariety; } -export type CropVarietiesCreateOrUpdateParameters = RequestParameters & - CropVarietiesCreateOrUpdateBodyParam; +export interface CropVarietiesCreateOrUpdateMediaTypesParam { + /** Request content type */ + contentType?: "application/merge-patch+json"; +} + +export type CropVarietiesCreateOrUpdateParameters = CropVarietiesCreateOrUpdateMediaTypesParam & + CropVarietiesCreateOrUpdateBodyParam & + RequestParameters; export type CropVarietiesDeleteParameters = RequestParameters; export interface FarmersListQueryParamProperties { - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; + /** List of Ids of farmers to be returned. */ + ids?: Array; + /** List of names of farmers to be returned. */ + names?: Array; /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; - /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Farmers with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -526,19 +595,27 @@ export interface FarmersListQueryParam { queryParameters?: FarmersListQueryParamProperties; } -export type FarmersListParameters = RequestParameters & FarmersListQueryParam; +export type FarmersListParameters = FarmersListQueryParam & RequestParameters; export type FarmersGetParameters = RequestParameters; export interface FarmersCreateOrUpdateBodyParam { + /** Farmer resource payload to create or update. */ body?: Farmer; } -export type FarmersCreateOrUpdateParameters = RequestParameters & FarmersCreateOrUpdateBodyParam; +export interface FarmersCreateOrUpdateMediaTypesParam { + /** Request content type */ + contentType?: "application/merge-patch+json"; +} + +export type FarmersCreateOrUpdateParameters = FarmersCreateOrUpdateMediaTypesParam & + FarmersCreateOrUpdateBodyParam & + RequestParameters; export type FarmersDeleteParameters = RequestParameters; export type FarmersGetCascadeDeleteJobDetailsParameters = RequestParameters; export interface FarmersCreateCascadeDeleteJobQueryParamProperties { - /** ID of the farmer to be deleted. */ + /** Id of the farmer to be deleted. */ farmerId: string; } @@ -546,41 +623,46 @@ export interface FarmersCreateCascadeDeleteJobQueryParam { queryParameters: FarmersCreateCascadeDeleteJobQueryParamProperties; } -export type FarmersCreateCascadeDeleteJobParameters = RequestParameters & - FarmersCreateCascadeDeleteJobQueryParam; +export type FarmersCreateCascadeDeleteJobParameters = FarmersCreateCascadeDeleteJobQueryParam & + RequestParameters; export interface FarmOperationsCreateDataIngestionJobBodyParam { + /** Job parameters supplied by the user. */ body?: FarmOperationDataIngestionJob; } -export type FarmOperationsCreateDataIngestionJobParameters = RequestParameters & - FarmOperationsCreateDataIngestionJobBodyParam; +export interface FarmOperationsCreateDataIngestionJobMediaTypesParam { + /** Request content type */ + contentType?: "application/json"; +} + +export type FarmOperationsCreateDataIngestionJobParameters = + FarmOperationsCreateDataIngestionJobMediaTypesParam & + FarmOperationsCreateDataIngestionJobBodyParam & + RequestParameters; export type FarmOperationsGetDataIngestionJobDetailsParameters = RequestParameters; export interface FarmsListByFarmerIdQueryParamProperties { - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; + /** List of Ids of farms to be returned. */ + ids?: Array; + /** List of names of farms to be returned. */ + names?: Array; /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; - /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Farms with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -590,32 +672,29 @@ export interface FarmsListByFarmerIdQueryParam { queryParameters?: FarmsListByFarmerIdQueryParamProperties; } -export type FarmsListByFarmerIdParameters = RequestParameters & FarmsListByFarmerIdQueryParam; +export type FarmsListByFarmerIdParameters = FarmsListByFarmerIdQueryParam & RequestParameters; export interface FarmsListQueryParamProperties { - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; + /** List of Ids of farms to be returned. */ + ids?: Array; + /** List of names of farms to be returned. */ + names?: Array; /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; - /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Farms with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -625,14 +704,22 @@ export interface FarmsListQueryParam { queryParameters?: FarmsListQueryParamProperties; } -export type FarmsListParameters = RequestParameters & FarmsListQueryParam; +export type FarmsListParameters = FarmsListQueryParam & RequestParameters; export type FarmsGetParameters = RequestParameters; export interface FarmsCreateOrUpdateBodyParam { + /** Farm resource payload to create or update. */ body?: Farm; } -export type FarmsCreateOrUpdateParameters = RequestParameters & FarmsCreateOrUpdateBodyParam; +export interface FarmsCreateOrUpdateMediaTypesParam { + /** Request content type */ + contentType?: "application/merge-patch+json"; +} + +export type FarmsCreateOrUpdateParameters = FarmsCreateOrUpdateMediaTypesParam & + FarmsCreateOrUpdateBodyParam & + RequestParameters; export type FarmsDeleteParameters = RequestParameters; export type FarmsGetCascadeDeleteJobDetailsParameters = RequestParameters; @@ -647,35 +734,32 @@ export interface FarmsCreateCascadeDeleteJobQueryParam { queryParameters: FarmsCreateCascadeDeleteJobQueryParamProperties; } -export type FarmsCreateCascadeDeleteJobParameters = RequestParameters & - FarmsCreateCascadeDeleteJobQueryParam; +export type FarmsCreateCascadeDeleteJobParameters = FarmsCreateCascadeDeleteJobQueryParam & + RequestParameters; export interface FieldsListByFarmerIdQueryParamProperties { - /** Farm Ids of the resource. */ - farmIds?: string[]; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; + /** Fields associated with the given list of farms are returned. */ + farmIds?: Array; + /** List of Ids of fields to be returned. */ + ids?: Array; + /** List of names of fields to be returned. */ + names?: Array; /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; - /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Fields with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -685,34 +769,31 @@ export interface FieldsListByFarmerIdQueryParam { queryParameters?: FieldsListByFarmerIdQueryParamProperties; } -export type FieldsListByFarmerIdParameters = RequestParameters & FieldsListByFarmerIdQueryParam; +export type FieldsListByFarmerIdParameters = FieldsListByFarmerIdQueryParam & RequestParameters; export interface FieldsListQueryParamProperties { - /** Farm Ids of the resource. */ - farmIds?: string[]; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; - /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; + /** Fields associated with the given list of farms are returned. */ + farmIds?: Array; + /** List of Ids of fields to be returned. */ + ids?: Array; + /** List of names of fields to be returned. */ + names?: Array; /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Fields with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -722,19 +803,27 @@ export interface FieldsListQueryParam { queryParameters?: FieldsListQueryParamProperties; } -export type FieldsListParameters = RequestParameters & FieldsListQueryParam; +export type FieldsListParameters = FieldsListQueryParam & RequestParameters; export type FieldsGetParameters = RequestParameters; export interface FieldsCreateOrUpdateBodyParam { + /** Field resource payload to Create or update. */ body?: Field; } -export type FieldsCreateOrUpdateParameters = RequestParameters & FieldsCreateOrUpdateBodyParam; +export interface FieldsCreateOrUpdateMediaTypesParam { + /** Request content type */ + contentType?: "application/merge-patch+json"; +} + +export type FieldsCreateOrUpdateParameters = FieldsCreateOrUpdateMediaTypesParam & + FieldsCreateOrUpdateBodyParam & + RequestParameters; export type FieldsDeleteParameters = RequestParameters; export type FieldsGetCascadeDeleteJobDetailsParameters = RequestParameters; export interface FieldsCreateCascadeDeleteJobQueryParamProperties { - /** ID of the associated farmer. */ + /** Id of the associated farmer. */ farmerId: string; /** ID of the field to be deleted. */ fieldId: string; @@ -744,79 +833,76 @@ export interface FieldsCreateCascadeDeleteJobQueryParam { queryParameters: FieldsCreateCascadeDeleteJobQueryParamProperties; } -export type FieldsCreateCascadeDeleteJobParameters = RequestParameters & - FieldsCreateCascadeDeleteJobQueryParam; +export type FieldsCreateCascadeDeleteJobParameters = FieldsCreateCascadeDeleteJobQueryParam & + RequestParameters; export interface HarvestDataListByFarmerIdQueryParamProperties { - /** Minimum Yield value(inclusive). */ + /** Harvest data with total yield greater than or equal to the value specified will be returned. */ minTotalYield?: number; - /** Maximum Yield value (inclusive). */ + /** Harvest data with total yield lesser than or equal to the value specified will be returned. */ maxTotalYield?: number; - /** Minimum AvgYield value(inclusive). */ + /** Harvest data with average yield greater than or equal to the value specified will be returned. */ minAvgYield?: number; - /** Maximum AvgYield value (inclusive). */ + /** Harvest data with average yield lesser than or equal to the value specified will be returned. */ maxAvgYield?: number; - /** Minimum Total WetMass value(inclusive). */ + /** Harvest data with total wet mass greater than or equal to the value specified will be returned. */ minTotalWetMass?: number; - /** Maximum Total WetMass value (inclusive). */ + /** Harvest data with total wet mass lesser than or equal to the value specified will be returned. */ maxTotalWetMass?: number; - /** Minimum AvgWetMass value(inclusive). */ + /** Harvest data with average wet mass greater than or equal to the value specified will be returned. */ minAvgWetMass?: number; - /** Maximum AvgWetMass value (inclusive). */ + /** Harvest data with average wet mass lesser than or equal to the value specified will be returned. */ maxAvgWetMass?: number; - /** Minimum AvgMoisture value(inclusive). */ + /** Harvest data with average moisture greater than or equal to the value specified will be returned. */ minAvgMoisture?: number; - /** Maximum AvgMoisture value (inclusive). */ + /** Harvest data with average moisture lesser than or equal to the value specified will be returned. */ maxAvgMoisture?: number; - /** Minimum AvgSpeed value(inclusive). */ + /** Harvest data with average speed greater than or equal to the value specified will be returned. */ minAvgSpeed?: number; - /** Maximum AvgSpeed value (inclusive). */ + /** Harvest data with average speed lesser than or equal to the value specified will be returned. */ maxAvgSpeed?: number; - /** Sources of the operation data. */ - sources?: string[]; - /** Boundary IDs associated with operation data. */ - associatedBoundaryIds?: string[]; - /** Operation boundary IDs associated with operation data. */ - operationBoundaryIds?: string[]; - /** Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationStartDateTime?: Date; - /** Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationStartDateTime?: Date; - /** Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationEndDateTime?: Date; - /** Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationEndDateTime?: Date; - /** Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationModifiedDateTime?: Date; - /** Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationModifiedDateTime?: Date; - /** Minimum area for which operation was applied (inclusive). */ + /** Harvest data obtained from the given list of sources will be returned. */ + sources?: Array; + /** List of boundary Ids of the field/seasonal field on which the harvest operation was done. */ + associatedBoundaryIds?: Array; + /** List of the boundary Ids that were created using the geographical area on which the harvest operation was carried out. */ + operationBoundaryIds?: Array; + /** Harvest operations that began at or after the given UTC date-time is returned. */ + minOperationStartDateTime?: Date | string; + /** Harvest operations that began at or before the given UTC date-time is returned. */ + maxOperationStartDateTime?: Date | string; + /** Harvest operations that ended at or after the given UTC date-time is returned. */ + minOperationEndDateTime?: Date | string; + /** Harvest operations that ended at or before the given UTC date-time is returned. */ + maxOperationEndDateTime?: Date | string; + /** Harvest operations that were modified (at source) at or after the given UTC date-time is returned. */ + minOperationModifiedDateTime?: Date | string; + /** Harvest operations that were modified (at source) at or before the given UTC date-time is returned. */ + maxOperationModifiedDateTime?: Date | string; + /** Harvest operations carried over area greater than or equal to the given value is returned. */ minArea?: number; - /** Maximum area for which operation was applied (inclusive). */ + /** Harvest operations carried over area lesser than or equal to the given value is returned. */ maxArea?: number; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; - /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; + /** List of Ids of harvest operations to be returned. */ + ids?: Array; + /** List of names of harvest operations to be returned. */ + names?: Array; /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Harvest data with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -826,79 +912,76 @@ export interface HarvestDataListByFarmerIdQueryParam { queryParameters?: HarvestDataListByFarmerIdQueryParamProperties; } -export type HarvestDataListByFarmerIdParameters = RequestParameters & - HarvestDataListByFarmerIdQueryParam; +export type HarvestDataListByFarmerIdParameters = HarvestDataListByFarmerIdQueryParam & + RequestParameters; export interface HarvestDataListQueryParamProperties { - /** Minimum Yield value(inclusive). */ + /** Harvest data with total yield greater than or equal to the value specified will be returned. */ minTotalYield?: number; - /** Maximum Yield value (inclusive). */ + /** Harvest data with total yield lesser than or equal to the value specified will be returned. */ maxTotalYield?: number; - /** Minimum AvgYield value(inclusive). */ + /** Harvest data with average yield greater than or equal to the value specified will be returned. */ minAvgYield?: number; - /** Maximum AvgYield value (inclusive). */ + /** Harvest data with average yield lesser than or equal to the value specified will be returned. */ maxAvgYield?: number; - /** Minimum Total WetMass value(inclusive). */ + /** Harvest data with total wet mass greater than or equal to the value specified will be returned. */ minTotalWetMass?: number; - /** Maximum Total WetMass value (inclusive). */ + /** Harvest data with total wet mass lesser than or equal to the value specified will be returned. */ maxTotalWetMass?: number; - /** Minimum AvgWetMass value(inclusive). */ + /** Harvest data with average wet mass greater than or equal to the value specified will be returned. */ minAvgWetMass?: number; - /** Maximum AvgWetMass value (inclusive). */ + /** Harvest data with average wet mass lesser than or equal to the value specified will be returned. */ maxAvgWetMass?: number; - /** Minimum AvgMoisture value(inclusive). */ + /** Harvest data with average moisture greater than or equal to the value specified will be returned. */ minAvgMoisture?: number; - /** Maximum AvgMoisture value (inclusive). */ + /** Harvest data with average moisture lesser than or equal to the value specified will be returned. */ maxAvgMoisture?: number; - /** Minimum AvgSpeed value(inclusive). */ + /** Harvest data with average speed greater than or equal to the value specified will be returned. */ minAvgSpeed?: number; - /** Maximum AvgSpeed value (inclusive). */ + /** Harvest data with average speed lesser than or equal to the value specified will be returned. */ maxAvgSpeed?: number; - /** Sources of the operation data. */ - sources?: string[]; - /** Boundary IDs associated with operation data. */ - associatedBoundaryIds?: string[]; - /** Operation boundary IDs associated with operation data. */ - operationBoundaryIds?: string[]; - /** Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationStartDateTime?: Date; - /** Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationStartDateTime?: Date; - /** Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationEndDateTime?: Date; - /** Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationEndDateTime?: Date; - /** Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationModifiedDateTime?: Date; - /** Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationModifiedDateTime?: Date; - /** Minimum area for which operation was applied (inclusive). */ + /** Harvest data obtained from the given list of sources will be returned. */ + sources?: Array; + /** List of boundary Ids of the field/seasonal field on which the harvest operation was done. */ + associatedBoundaryIds?: Array; + /** List of the boundary Ids that were created using the geographical area on which the harvest operation was carried out. */ + operationBoundaryIds?: Array; + /** Harvest operations that began at or after the given UTC date-time is returned. */ + minOperationStartDateTime?: Date | string; + /** Harvest operations that began at or before the given UTC date-time is returned. */ + maxOperationStartDateTime?: Date | string; + /** Harvest operations that ended at or after the given UTC date-time is returned. */ + minOperationEndDateTime?: Date | string; + /** Harvest operations that ended at or before the given UTC date-time is returned. */ + maxOperationEndDateTime?: Date | string; + /** Harvest operations that were modified (at source) at or after the given UTC date-time is returned. */ + minOperationModifiedDateTime?: Date | string; + /** Harvest operations that were modified (at source) at or before the given UTC date-time is returned. */ + maxOperationModifiedDateTime?: Date | string; + /** Harvest operations carried over area greater than or equal to the given value is returned. */ minArea?: number; - /** Maximum area for which operation was applied (inclusive). */ + /** Harvest operations carried over area lesser than or equal to the given value is returned. */ maxArea?: number; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; + /** List of Ids of harvest operations to be returned. */ + ids?: Array; + /** List of names of harvest operations to be returned. */ + names?: Array; /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; - /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Harvest data with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -908,49 +991,76 @@ export interface HarvestDataListQueryParam { queryParameters?: HarvestDataListQueryParamProperties; } -export type HarvestDataListParameters = RequestParameters & HarvestDataListQueryParam; +export type HarvestDataListParameters = HarvestDataListQueryParam & RequestParameters; export type HarvestDataGetParameters = RequestParameters; export interface HarvestDataCreateOrUpdateBodyParam { + /** Harvest data resource payload to Create or update. */ body?: HarvestData; } -export type HarvestDataCreateOrUpdateParameters = RequestParameters & - HarvestDataCreateOrUpdateBodyParam; +export interface HarvestDataCreateOrUpdateMediaTypesParam { + /** Request content type */ + contentType?: "application/merge-patch+json"; +} + +export type HarvestDataCreateOrUpdateParameters = HarvestDataCreateOrUpdateMediaTypesParam & + HarvestDataCreateOrUpdateBodyParam & + RequestParameters; export type HarvestDataDeleteParameters = RequestParameters; +export type HarvestDataGetCascadeDeleteJobDetailsParameters = RequestParameters; + +export interface HarvestDataCreateCascadeDeleteJobQueryParamProperties { + /** Id of the associated farmer. */ + farmerId: string; + /** Id of the harvest data resource. */ + harvestDataId: string; +} + +export interface HarvestDataCreateCascadeDeleteJobQueryParam { + queryParameters: HarvestDataCreateCascadeDeleteJobQueryParamProperties; +} + +export type HarvestDataCreateCascadeDeleteJobParameters = + HarvestDataCreateCascadeDeleteJobQueryParam & RequestParameters; export interface ImageProcessingCreateRasterizeJobBodyParam { + /** Job parameters supplied by the user. */ body?: ImageProcessingRasterizeJob; } -export type ImageProcessingCreateRasterizeJobParameters = RequestParameters & - ImageProcessingCreateRasterizeJobBodyParam; +export interface ImageProcessingCreateRasterizeJobMediaTypesParam { + /** Request content type */ + contentType?: "application/json"; +} + +export type ImageProcessingCreateRasterizeJobParameters = + ImageProcessingCreateRasterizeJobMediaTypesParam & + ImageProcessingCreateRasterizeJobBodyParam & + RequestParameters; export type ImageProcessingGetRasterizeJobParameters = RequestParameters; export interface OAuthProvidersListQueryParamProperties { - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; - /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; + /** List of Ids of OAuth providers to be returned. */ + ids?: Array; + /** List of names of OAuth providers to be returned. */ + names?: Array; /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** OAuth providers with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -960,36 +1070,53 @@ export interface OAuthProvidersListQueryParam { queryParameters?: OAuthProvidersListQueryParamProperties; } -export type OAuthProvidersListParameters = RequestParameters & OAuthProvidersListQueryParam; +export type OAuthProvidersListParameters = OAuthProvidersListQueryParam & RequestParameters; export type OAuthProvidersGetParameters = RequestParameters; export interface OAuthProvidersCreateOrUpdateBodyParam { + /** OauthProvider resource payload to Create or update. */ body?: OAuthProvider; } -export type OAuthProvidersCreateOrUpdateParameters = RequestParameters & - OAuthProvidersCreateOrUpdateBodyParam; +export interface OAuthProvidersCreateOrUpdateMediaTypesParam { + /** Request content type */ + contentType?: "application/merge-patch+json"; +} + +export type OAuthProvidersCreateOrUpdateParameters = OAuthProvidersCreateOrUpdateMediaTypesParam & + OAuthProvidersCreateOrUpdateBodyParam & + RequestParameters; export type OAuthProvidersDeleteParameters = RequestParameters; +export type OAuthProvidersGetCascadeDeleteJobDetailsParameters = RequestParameters; + +export interface OAuthProvidersCreateCascadeDeleteJobQueryParamProperties { + /** Id of the OAuth provider resource. */ + oauthProviderId: string; +} + +export interface OAuthProvidersCreateCascadeDeleteJobQueryParam { + queryParameters: OAuthProvidersCreateCascadeDeleteJobQueryParamProperties; +} + +export type OAuthProvidersCreateCascadeDeleteJobParameters = + OAuthProvidersCreateCascadeDeleteJobQueryParam & RequestParameters; export interface OAuthTokensListQueryParamProperties { - /** Name of AuthProvider. */ - authProviderIds?: string[]; - /** List of farmers. */ - farmerIds?: string[]; - /** If the token object is valid. */ + /** List of Ids of OAuth providers to be returned. */ + authProviderIds?: Array; + /** List of Ids of associated farmers. */ + farmerIds?: Array; + /** If set, only valid (non expired) OAuth tokens are returned. */ isValid?: boolean; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; - /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. - */ + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -999,20 +1126,28 @@ export interface OAuthTokensListQueryParam { queryParameters?: OAuthTokensListQueryParamProperties; } -export type OAuthTokensListParameters = RequestParameters & OAuthTokensListQueryParam; +export type OAuthTokensListParameters = OAuthTokensListQueryParam & RequestParameters; export interface OAuthTokensGetOAuthConnectionLinkBodyParam { + /** OAuth Connect Request. */ body?: OAuthConnectRequest; } -export type OAuthTokensGetOAuthConnectionLinkParameters = RequestParameters & - OAuthTokensGetOAuthConnectionLinkBodyParam; +export interface OAuthTokensGetOAuthConnectionLinkMediaTypesParam { + /** Request content type */ + contentType?: "application/json"; +} + +export type OAuthTokensGetOAuthConnectionLinkParameters = + OAuthTokensGetOAuthConnectionLinkMediaTypesParam & + OAuthTokensGetOAuthConnectionLinkBodyParam & + RequestParameters; export type OAuthTokensGetCascadeDeleteJobDetailsParameters = RequestParameters; export interface OAuthTokensCreateCascadeDeleteJobQueryParamProperties { - /** ID of the farmer. */ + /** Id of the associated farmer. */ farmerId: string; - /** ID of the OAuthProvider. */ + /** Id of the OAuth provider resource. */ oauthProviderId: string; } @@ -1020,67 +1155,64 @@ export interface OAuthTokensCreateCascadeDeleteJobQueryParam { queryParameters: OAuthTokensCreateCascadeDeleteJobQueryParamProperties; } -export type OAuthTokensCreateCascadeDeleteJobParameters = RequestParameters & - OAuthTokensCreateCascadeDeleteJobQueryParam; +export type OAuthTokensCreateCascadeDeleteJobParameters = + OAuthTokensCreateCascadeDeleteJobQueryParam & RequestParameters; export interface PlantingDataListByFarmerIdQueryParamProperties { - /** Minimum AvgPlantingRate value(inclusive). */ + /** Planting data with average planting rate greater than or equal to the value specified will be returned. */ minAvgPlantingRate?: number; - /** Maximum AvgPlantingRate value (inclusive). */ + /** Planting data with average planting rate lesser than or equal to the value specified will be returned. */ maxAvgPlantingRate?: number; - /** Minimum TotalMaterial value(inclusive). */ + /** Planting data with total material greater than or equal to the value specified will be returned. */ minTotalMaterial?: number; - /** Maximum TotalMaterial value (inclusive). */ + /** Planting data with total material lesser than or equal to the value specified will be returned. */ maxTotalMaterial?: number; - /** Minimum AvgMaterial value(inclusive). */ + /** Planting data with average material greater than or equal to the value specified will be returned. */ minAvgMaterial?: number; - /** Maximum AvgMaterial value (inclusive). */ + /** Planting data with total material lesser than or equal to the value specified will be returned. */ maxAvgMaterial?: number; - /** Sources of the operation data. */ - sources?: string[]; - /** Boundary IDs associated with operation data. */ - associatedBoundaryIds?: string[]; - /** Operation boundary IDs associated with operation data. */ - operationBoundaryIds?: string[]; - /** Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationStartDateTime?: Date; - /** Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationStartDateTime?: Date; - /** Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationEndDateTime?: Date; - /** Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationEndDateTime?: Date; - /** Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationModifiedDateTime?: Date; - /** Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationModifiedDateTime?: Date; - /** Minimum area for which operation was applied (inclusive). */ + /** Planting data obtained from the given list of sources will be returned. */ + sources?: Array; + /** List of boundary Ids of the field/seasonal field on which the planting operation was done. */ + associatedBoundaryIds?: Array; + /** List of the boundary Ids that were created using the geographical area on which the planting operation was carried out. */ + operationBoundaryIds?: Array; + /** Planting operations that began at or after the given UTC date-time is returned. */ + minOperationStartDateTime?: Date | string; + /** Planting operations that began at or before the given UTC date-time is returned. */ + maxOperationStartDateTime?: Date | string; + /** Planting operations that ended at or after the given UTC date-time is returned. */ + minOperationEndDateTime?: Date | string; + /** Planting operations that ended at or before the given UTC date-time is returned. */ + maxOperationEndDateTime?: Date | string; + /** Planting operations that were modified (at source) at or after the given UTC date-time is returned. */ + minOperationModifiedDateTime?: Date | string; + /** Planting operations that were modified (at source) at or before the given UTC date-time is returned. */ + maxOperationModifiedDateTime?: Date | string; + /** Planting operations carried over area greater than or equal to the given value is returned. */ minArea?: number; - /** Maximum area for which operation was applied (inclusive). */ + /** Planting operations carried over area lesser than or equal to the given value is returned. */ maxArea?: number; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; + /** List of Ids of planting operations to be returned. */ + ids?: Array; + /** List of names of planting operations to be returned. */ + names?: Array; /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; - /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Planting data with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -1090,67 +1222,64 @@ export interface PlantingDataListByFarmerIdQueryParam { queryParameters?: PlantingDataListByFarmerIdQueryParamProperties; } -export type PlantingDataListByFarmerIdParameters = RequestParameters & - PlantingDataListByFarmerIdQueryParam; +export type PlantingDataListByFarmerIdParameters = PlantingDataListByFarmerIdQueryParam & + RequestParameters; export interface PlantingDataListQueryParamProperties { - /** Minimum AvgPlantingRate value(inclusive). */ + /** Planting data with average planting rate greater than or equal to the value specified will be returned. */ minAvgPlantingRate?: number; - /** Maximum AvgPlantingRate value (inclusive). */ + /** Planting data with average planting rate lesser than or equal to the value specified will be returned. */ maxAvgPlantingRate?: number; - /** Minimum TotalMaterial value(inclusive). */ + /** Planting data with total material greater than or equal to the value specified will be returned. */ minTotalMaterial?: number; - /** Maximum TotalMaterial value (inclusive). */ + /** Planting data with total material lesser than or equal to the value specified will be returned. */ maxTotalMaterial?: number; - /** Minimum AvgMaterial value(inclusive). */ + /** Planting data with average material greater than or equal to the value specified will be returned. */ minAvgMaterial?: number; - /** Maximum AvgMaterial value (inclusive). */ + /** Planting data with average material lesser than or equal to the value specified will be returned. */ maxAvgMaterial?: number; - /** Sources of the operation data. */ - sources?: string[]; - /** Boundary IDs associated with operation data. */ - associatedBoundaryIds?: string[]; - /** Operation boundary IDs associated with operation data. */ - operationBoundaryIds?: string[]; - /** Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationStartDateTime?: Date; - /** Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationStartDateTime?: Date; - /** Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationEndDateTime?: Date; - /** Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationEndDateTime?: Date; - /** Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationModifiedDateTime?: Date; - /** Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationModifiedDateTime?: Date; - /** Minimum area for which operation was applied (inclusive). */ + /** Planting data obtained from the given list of sources will be returned. */ + sources?: Array; + /** List of boundary Ids of the field/seasonal field on which the planting operation was done. */ + associatedBoundaryIds?: Array; + /** List of the boundary Ids that were created using the geographical area on which the planting operation was carried out. */ + operationBoundaryIds?: Array; + /** Planting operations that began at or after the given UTC date-time is returned. */ + minOperationStartDateTime?: Date | string; + /** Planting operations that began at or before the given UTC date-time is returned. */ + maxOperationStartDateTime?: Date | string; + /** Planting operations that ended at or after the given UTC date-time is returned. */ + minOperationEndDateTime?: Date | string; + /** Planting operations that ended at or before the given UTC date-time is returned. */ + maxOperationEndDateTime?: Date | string; + /** Planting operations that were modified (at source) at or after the given UTC date-time is returned. */ + minOperationModifiedDateTime?: Date | string; + /** Planting operations that were modified (at source) at or before the given UTC date-time is returned. */ + maxOperationModifiedDateTime?: Date | string; + /** Planting operations carried over area greater than or equal to the given value is returned. */ minArea?: number; - /** Maximum area for which operation was applied (inclusive). */ + /** Planting operations carried over area lesser than or equal to the given value is returned. */ maxArea?: number; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; - /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; + /** List of Ids of planting operations to be returned. */ + ids?: Array; + /** List of names of planting operations to be returned. */ + names?: Array; /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Planting data with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -1160,44 +1289,66 @@ export interface PlantingDataListQueryParam { queryParameters?: PlantingDataListQueryParamProperties; } -export type PlantingDataListParameters = RequestParameters & PlantingDataListQueryParam; +export type PlantingDataListParameters = PlantingDataListQueryParam & RequestParameters; export type PlantingDataGetParameters = RequestParameters; export interface PlantingDataCreateOrUpdateBodyParam { + /** Planting data resource payload to Create or update. */ body?: PlantingData; } -export type PlantingDataCreateOrUpdateParameters = RequestParameters & - PlantingDataCreateOrUpdateBodyParam; +export interface PlantingDataCreateOrUpdateMediaTypesParam { + /** Request content type */ + contentType?: "application/merge-patch+json"; +} + +export type PlantingDataCreateOrUpdateParameters = PlantingDataCreateOrUpdateMediaTypesParam & + PlantingDataCreateOrUpdateBodyParam & + RequestParameters; export type PlantingDataDeleteParameters = RequestParameters; +export type PlantingDataGetCascadeDeleteJobDetailsParameters = RequestParameters; + +export interface PlantingDataCreateCascadeDeleteJobQueryParamProperties { + /** Id of the associated farmer. */ + farmerId: string; + /** Id of the planting data resource. */ + plantingDataId: string; +} + +export interface PlantingDataCreateCascadeDeleteJobQueryParam { + queryParameters: PlantingDataCreateCascadeDeleteJobQueryParamProperties; +} + +export type PlantingDataCreateCascadeDeleteJobParameters = + PlantingDataCreateCascadeDeleteJobQueryParam & RequestParameters; export interface ScenesListQueryParamProperties { - /** Provider name of scene data. */ + /** Name of the data provider for the scene. For satellite imagery, this refers to the name of the satellite data provider. */ provider: string; - /** FarmerId. */ + /** Id of the associated farmer. */ farmerId: string; - /** BoundaryId. */ + /** Id of the associated boundary. */ boundaryId: string; - /** Source name of scene data, default value Sentinel_2_L2A (Sentinel 2 L2A). */ + /** Source from where the scene was procured/generated. For satellite imagery, this refers to the name of the satellite constellation. */ source?: string; - /** Scene start UTC datetime (inclusive), sample format: yyyy-MM-ddThh:mm:ssZ. */ - startDateTime?: Date; - /** Scene end UTC datetime (inclusive), sample format: yyyy-MM-dThh:mm:ssZ. */ - endDateTime?: Date; - /** Filter scenes with cloud coverage percentage less than max value. Range [0 to 100.0]. */ + /** Scenes that were captured/made available (at source) at or after this UTC Date-time is returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + startDateTime?: Date | string; + /** Scenes that were captured/made available (at source) at or before this UTC Date-time is returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + endDateTime?: Date | string; + /** Scenes with cloud cover less than or equal to the given value are returned. Range [0 to 100.0]. */ maxCloudCoveragePercentage?: number; - /** Filter scenes with dark pixel coverage percentage less than max value. Range [0 to 100.0]. */ + /** Scenes with dark pixel cover less than or equal to the given value are returned. Range [0 to 100.0]. */ maxDarkPixelCoveragePercentage?: number; - /** List of image names to be filtered. */ - imageNames?: string[]; - /** List of image resolutions in meters to be filtered. */ - imageResolutions?: number[]; - /** List of image formats to be filtered. */ - imageFormats?: string[]; /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * List of names of images to be fetched. + * For Sentinel-2, allowed values are: 'B01', 'B02', 'B03', 'B04', 'B05', 'B06', 'B07', 'B08', 'B8A', 'B09', 'B11', 'B12', 'AOT', 'SCL', 'SNW', 'CLD', 'NDVI', 'NDWI', 'EVI', 'LAI', 'LAIMask', 'CLP', 'CLM', 'dataMask', sunAzimuthAngles, sunZenithAngles, viewAzimuthMean and viewZenithMean. */ + imageNames?: Array; + /** List of image resolutions in meters. For Sentinel-2, available values are: 10, 20, 60. */ + imageResolutions?: Array; + /** Format in which the scenes are to be returned. Available value: TIF. */ + imageFormats?: Array; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -1207,18 +1358,26 @@ export interface ScenesListQueryParam { queryParameters: ScenesListQueryParamProperties; } -export type ScenesListParameters = RequestParameters & ScenesListQueryParam; +export type ScenesListParameters = ScenesListQueryParam & RequestParameters; export interface ScenesCreateSatelliteDataIngestionJobBodyParam { + /** Job parameters supplied by the user. */ body?: SatelliteDataIngestionJob; } -export type ScenesCreateSatelliteDataIngestionJobParameters = RequestParameters & - ScenesCreateSatelliteDataIngestionJobBodyParam; +export interface ScenesCreateSatelliteDataIngestionJobMediaTypesParam { + /** Request content type */ + contentType?: "application/json"; +} + +export type ScenesCreateSatelliteDataIngestionJobParameters = + ScenesCreateSatelliteDataIngestionJobMediaTypesParam & + ScenesCreateSatelliteDataIngestionJobBodyParam & + RequestParameters; export type ScenesGetSatelliteDataIngestionJobDetailsParameters = RequestParameters; export interface ScenesDownloadQueryParamProperties { - /** cloud storage path of scene file. */ + /** Relative path where the scene is stored in cloud storage. */ filePath: string; } @@ -1226,58 +1385,55 @@ export interface ScenesDownloadQueryParam { queryParameters: ScenesDownloadQueryParamProperties; } -export type ScenesDownloadParameters = RequestParameters & ScenesDownloadQueryParam; +export type ScenesDownloadParameters = ScenesDownloadQueryParam & RequestParameters; export interface SeasonalFieldsListByFarmerIdQueryParamProperties { - /** Farm Ids of the resource. */ - farmIds?: string[]; - /** Field Ids of the resource. */ - fieldIds?: string[]; - /** Season Ids of the resource. */ - seasonIds?: string[]; - /** CropVarietyIds of the resource. */ - cropVarietyIds?: string[]; - /** Ids of the crop it belongs to. */ - cropIds?: string[]; - /** Minimum average yield value of the seasonal field(inclusive). */ + /** Seasonal fields associated with the given farms are returned. */ + farmIds?: Array; + /** Seasonal fields associated with the given fields are returned. */ + fieldIds?: Array; + /** Seasonal fields associated with the given seasons are returned. */ + seasonIds?: Array; + /** Seasonal fields associated with at least one of the given crop varieties are returned. */ + cropVarietyIds?: Array; + /** Seasonal fields associated with at least one of the given crops are returned. */ + cropIds?: Array; + /** Seasonal fields with average yield greater than or equal to the value specified will be returned. */ minAvgYieldValue?: number; - /** Maximum average yield value of the seasonal field(inclusive). */ + /** Seasonal fields with average yield lesser than or equal to the value specified will be returned. */ maxAvgYieldValue?: number; - /** Unit of the average yield value attribute. */ + /** Unit of the average yield. */ avgYieldUnit?: string; - /** Minimum average seed population value of the seasonal field(inclusive). */ + /** Seasonal fields with average seed population greater than or equal to the value specified will be returned. */ minAvgSeedPopulationValue?: number; - /** Maximum average seed population value of the seasonal field(inclusive). */ + /** Seasonal fields with average seed population lesser than or equal to the value specified will be returned. */ maxAvgSeedPopulationValue?: number; - /** Unit of average seed population value attribute. */ + /** Unit of average seed population. */ avgSeedPopulationUnit?: string; - /** Minimum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - minPlantingDateTime?: Date; - /** Maximum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - maxPlantingDateTime?: Date; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; + /** Seasonal fields with planting date at or after the value specified will be returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minPlantingDateTime?: Date | string; + /** Seasonal fields with planting date at or before the value specified will be returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxPlantingDateTime?: Date | string; + /** List of Ids of seasonal fields to be returned. */ + ids?: Array; + /** List of names of seasonal fields to be returned. */ + names?: Array; /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; - /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Seasonal fields with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -1287,59 +1443,56 @@ export interface SeasonalFieldsListByFarmerIdQueryParam { queryParameters?: SeasonalFieldsListByFarmerIdQueryParamProperties; } -export type SeasonalFieldsListByFarmerIdParameters = RequestParameters & - SeasonalFieldsListByFarmerIdQueryParam; +export type SeasonalFieldsListByFarmerIdParameters = SeasonalFieldsListByFarmerIdQueryParam & + RequestParameters; export interface SeasonalFieldsListQueryParamProperties { - /** Farm Ids of the resource. */ - farmIds?: string[]; - /** Field Ids of the resource. */ - fieldIds?: string[]; - /** Season Ids of the resource. */ - seasonIds?: string[]; - /** CropVarietyIds of the resource. */ - cropVarietyIds?: string[]; - /** Ids of the crop it belongs to. */ - cropIds?: string[]; - /** Minimum average yield value of the seasonal field(inclusive). */ + /** Seasonal fields associated with the given farms are returned. */ + farmIds?: Array; + /** Seasonal fields associated with the given fields are returned. */ + fieldIds?: Array; + /** Seasonal fields associated with the given seasons are returned. */ + seasonIds?: Array; + /** Seasonal fields associated with at least one of the given crop varieties are returned. */ + cropVarietyIds?: Array; + /** Seasonal fields associated with at least one of the given crops are returned. */ + cropIds?: Array; + /** Seasonal fields with average yield greater than or equal to the value specified will be returned. */ minAvgYieldValue?: number; - /** Maximum average yield value of the seasonal field(inclusive). */ + /** Seasonal fields with average yield lesser than or equal to the value specified will be returned. */ maxAvgYieldValue?: number; - /** Unit of the average yield value attribute. */ + /** Unit of the average yield. */ avgYieldUnit?: string; - /** Minimum average seed population value of the seasonal field(inclusive). */ + /** Seasonal fields with average seed population greater than or equal to the value specified will be returned. */ minAvgSeedPopulationValue?: number; - /** Maximum average seed population value of the seasonal field(inclusive). */ + /** Seasonal fields with average seed population lesser than or equal to the value specified will be returned. */ maxAvgSeedPopulationValue?: number; - /** Unit of average seed population value attribute. */ + /** Unit of average seed population. */ avgSeedPopulationUnit?: string; - /** Minimum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - minPlantingDateTime?: Date; - /** Maximum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - maxPlantingDateTime?: Date; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; - /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; + /** Seasonal fields with planting date at or after the value specified will be returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minPlantingDateTime?: Date | string; + /** Seasonal fields with planting date at or before the value specified will be returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxPlantingDateTime?: Date | string; + /** List of Ids of seasonal fields to be returned. */ + ids?: Array; + /** List of names of seasonal fields to be returned. */ + names?: Array; /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Seasonal fields with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -1349,22 +1502,29 @@ export interface SeasonalFieldsListQueryParam { queryParameters?: SeasonalFieldsListQueryParamProperties; } -export type SeasonalFieldsListParameters = RequestParameters & SeasonalFieldsListQueryParam; +export type SeasonalFieldsListParameters = SeasonalFieldsListQueryParam & RequestParameters; export type SeasonalFieldsGetParameters = RequestParameters; export interface SeasonalFieldsCreateOrUpdateBodyParam { + /** Seasonal field resource payload to Create or update. */ body?: SeasonalField; } -export type SeasonalFieldsCreateOrUpdateParameters = RequestParameters & - SeasonalFieldsCreateOrUpdateBodyParam; +export interface SeasonalFieldsCreateOrUpdateMediaTypesParam { + /** Request content type */ + contentType?: "application/merge-patch+json"; +} + +export type SeasonalFieldsCreateOrUpdateParameters = SeasonalFieldsCreateOrUpdateMediaTypesParam & + SeasonalFieldsCreateOrUpdateBodyParam & + RequestParameters; export type SeasonalFieldsDeleteParameters = RequestParameters; export type SeasonalFieldsGetCascadeDeleteJobDetailsParameters = RequestParameters; export interface SeasonalFieldsCreateCascadeDeleteJobQueryParamProperties { - /** ID of the associated farmer. */ + /** Id of the associated farmer. */ farmerId: string; - /** ID of the seasonalField to be deleted. */ + /** Id of the seasonal field to be deleted. */ seasonalFieldId: string; } @@ -1372,43 +1532,40 @@ export interface SeasonalFieldsCreateCascadeDeleteJobQueryParam { queryParameters: SeasonalFieldsCreateCascadeDeleteJobQueryParamProperties; } -export type SeasonalFieldsCreateCascadeDeleteJobParameters = RequestParameters & - SeasonalFieldsCreateCascadeDeleteJobQueryParam; +export type SeasonalFieldsCreateCascadeDeleteJobParameters = + SeasonalFieldsCreateCascadeDeleteJobQueryParam & RequestParameters; export interface SeasonsListQueryParamProperties { - /** Minimum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - minStartDateTime?: Date; - /** Maximum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - maxStartDateTime?: Date; - /** Minimum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - minEndDateTime?: Date; - /** Maximum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ. */ - maxEndDateTime?: Date; - /** Years of the resource. */ - years?: number[]; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; - /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; + /** Seasons which start at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minStartDateTime?: Date | string; + /** Seasons which start at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxStartDateTime?: Date | string; + /** Seasons which end at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minEndDateTime?: Date | string; + /** Seasons which end at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxEndDateTime?: Date | string; + /** Seasons with given list of years are returned. */ + years?: Array; + /** List of Ids of seasons to be returned. */ + ids?: Array; + /** List of names of seasons to be returned. */ + names?: Array; /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Seasons with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -1418,70 +1575,75 @@ export interface SeasonsListQueryParam { queryParameters?: SeasonsListQueryParamProperties; } -export type SeasonsListParameters = RequestParameters & SeasonsListQueryParam; +export type SeasonsListParameters = SeasonsListQueryParam & RequestParameters; export type SeasonsGetParameters = RequestParameters; export interface SeasonsCreateOrUpdateBodyParam { + /** Season resource payload to Create or update. */ body?: Season; } -export type SeasonsCreateOrUpdateParameters = RequestParameters & SeasonsCreateOrUpdateBodyParam; +export interface SeasonsCreateOrUpdateMediaTypesParam { + /** Request content type */ + contentType?: "application/merge-patch+json"; +} + +export type SeasonsCreateOrUpdateParameters = SeasonsCreateOrUpdateMediaTypesParam & + SeasonsCreateOrUpdateBodyParam & + RequestParameters; export type SeasonsDeleteParameters = RequestParameters; export interface TillageDataListByFarmerIdQueryParamProperties { - /** Minimum measured tillage depth (inclusive). */ + /** Tillage data with tillage depth greater than or equal to the value specified will be returned. */ minTillageDepth?: number; - /** Maximum measured tillage depth (inclusive). */ + /** Tillage data with tillage depth lesser than or equal to the value specified will be returned. */ maxTillageDepth?: number; - /** Minimum pressure applied by a tillage implement (inclusive). */ + /** Tillage data with tillage pressure greater than or equal to the value specified will be returned. */ minTillagePressure?: number; - /** Maximum pressure applied by a tillage implement (inclusive). */ + /** Tillage data with tillage pressure lesser than or equal to the value specified will be returned. */ maxTillagePressure?: number; - /** Sources of the operation data. */ - sources?: string[]; - /** Boundary IDs associated with operation data. */ - associatedBoundaryIds?: string[]; - /** Operation boundary IDs associated with operation data. */ - operationBoundaryIds?: string[]; - /** Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationStartDateTime?: Date; - /** Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationStartDateTime?: Date; - /** Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationEndDateTime?: Date; - /** Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationEndDateTime?: Date; - /** Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationModifiedDateTime?: Date; - /** Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationModifiedDateTime?: Date; - /** Minimum area for which operation was applied (inclusive). */ + /** Tillage data obtained from the given list of sources will be returned. */ + sources?: Array; + /** List of boundary Ids of the field/seasonal field on which the tillage operation was done. */ + associatedBoundaryIds?: Array; + /** List of the boundary Ids that were created using the geographical area on which the tillage operation was carried out. */ + operationBoundaryIds?: Array; + /** Tillage operations that began at or after the given UTC date-time is returned. */ + minOperationStartDateTime?: Date | string; + /** Tillage operations that began at or before the given UTC date-time is returned. */ + maxOperationStartDateTime?: Date | string; + /** Tillage operations that ended at or after the given UTC date-time is returned. */ + minOperationEndDateTime?: Date | string; + /** Tillage operations that ended at or before the given UTC date-time is returned. */ + maxOperationEndDateTime?: Date | string; + /** Tillage operations that were modified (at source) at or after the given UTC date-time is returned. */ + minOperationModifiedDateTime?: Date | string; + /** Tillage operations that were modified (at source) at or before the given UTC date-time is returned. */ + maxOperationModifiedDateTime?: Date | string; + /** Tillage operations carried over area greater than or equal to the given value is returned. */ minArea?: number; - /** Maximum area for which operation was applied (inclusive). */ + /** Tillage operations carried over area lesser than or equal to the given value is returned. */ maxArea?: number; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; - /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; + /** List of Ids of tillage operations to be returned. */ + ids?: Array; + /** List of names of tillage operations to be returned. */ + names?: Array; /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Tillage data with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -1491,63 +1653,60 @@ export interface TillageDataListByFarmerIdQueryParam { queryParameters?: TillageDataListByFarmerIdQueryParamProperties; } -export type TillageDataListByFarmerIdParameters = RequestParameters & - TillageDataListByFarmerIdQueryParam; +export type TillageDataListByFarmerIdParameters = TillageDataListByFarmerIdQueryParam & + RequestParameters; export interface TillageDataListQueryParamProperties { - /** Minimum measured tillage depth (inclusive). */ + /** Tillage data with tillage depth greater than or equal to the value specified will be returned. */ minTillageDepth?: number; - /** Maximum measured tillage depth (inclusive). */ + /** Tillage data with tillage depth lesser than or equal to the value specified will be returned. */ maxTillageDepth?: number; - /** Minimum pressure applied by a tillage implement (inclusive). */ + /** Tillage data with tillage pressure greater than or equal to the value specified will be returned. */ minTillagePressure?: number; - /** Maximum pressure applied by a tillage implement (inclusive). */ + /** Tillage data with tillage pressure lesser than or equal to the value specified will be returned. */ maxTillagePressure?: number; - /** Sources of the operation data. */ - sources?: string[]; - /** Boundary IDs associated with operation data. */ - associatedBoundaryIds?: string[]; - /** Operation boundary IDs associated with operation data. */ - operationBoundaryIds?: string[]; - /** Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationStartDateTime?: Date; - /** Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationStartDateTime?: Date; - /** Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationEndDateTime?: Date; - /** Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationEndDateTime?: Date; - /** Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - minOperationModifiedDateTime?: Date; - /** Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive). */ - maxOperationModifiedDateTime?: Date; - /** Minimum area for which operation was applied (inclusive). */ + /** Tillage data obtained from the given list of sources will be returned. */ + sources?: Array; + /** List of boundary Ids of the field/seasonal field on which the tillage operation was done. */ + associatedBoundaryIds?: Array; + /** List of the boundary Ids that were created using the geographical area on which the tillage operation was carried out. */ + operationBoundaryIds?: Array; + /** Tillage operations that began at or after the given UTC date-time is returned. */ + minOperationStartDateTime?: Date | string; + /** Tillage operations that began at or before the given UTC date-time is returned. */ + maxOperationStartDateTime?: Date | string; + /** Tillage operations that ended at or after the given UTC date-time is returned. */ + minOperationEndDateTime?: Date | string; + /** Tillage operations that ended at or before the given UTC date-time is returned. */ + maxOperationEndDateTime?: Date | string; + /** Tillage operations that were modified (at source) at or after the given UTC date-time is returned. */ + minOperationModifiedDateTime?: Date | string; + /** Tillage operations that were modified (at source) at or before the given UTC date-time is returned. */ + maxOperationModifiedDateTime?: Date | string; + /** Tillage operations carried over area greater than or equal to the given value is returned. */ minArea?: number; - /** Maximum area for which operation was applied (inclusive). */ + /** Tillage operations carried over area lesser than or equal to the given value is returned. */ maxArea?: number; - /** Ids of the resource. */ - ids?: string[]; - /** Names of the resource. */ - names?: string[]; - /** - * Filters on key-value pairs within the Properties object. - * eg. "\{testKey\} eq \{testValue\}". - */ - propertyFilters?: string[]; - /** Statuses of the resource. */ - statuses?: string[]; - /** Minimum creation date of resource (inclusive). */ - minCreatedDateTime?: Date; - /** Maximum creation date of resource (inclusive). */ - maxCreatedDateTime?: Date; - /** Minimum last modified date of resource (inclusive). */ - minLastModifiedDateTime?: Date; - /** Maximum last modified date of resource (inclusive). */ - maxLastModifiedDateTime?: Date; + /** List of Ids of tillage operations to be returned. */ + ids?: Array; + /** List of names of tillage operations to be returned. */ + names?: Array; /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. + * Filters on key-value pairs within 'Properties'. + * eg. "{testKey} eq {testValue}". */ + propertyFilters?: Array; + /** Tillage data with only the given statuses are returned. */ + statuses?: Array; + /** Resources created at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minCreatedDateTime?: Date | string; + /** Resources created at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxCreatedDateTime?: Date | string; + /** Resources last modified at or after the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + minLastModifiedDateTime?: Date | string; + /** Resources last modified at or before the given UTC date-time are returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + maxLastModifiedDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -1557,36 +1716,55 @@ export interface TillageDataListQueryParam { queryParameters?: TillageDataListQueryParamProperties; } -export type TillageDataListParameters = RequestParameters & TillageDataListQueryParam; +export type TillageDataListParameters = TillageDataListQueryParam & RequestParameters; export type TillageDataGetParameters = RequestParameters; export interface TillageDataCreateOrUpdateBodyParam { + /** Tillage data resource payload to Create or update. */ body?: TillageData; } -export type TillageDataCreateOrUpdateParameters = RequestParameters & - TillageDataCreateOrUpdateBodyParam; +export interface TillageDataCreateOrUpdateMediaTypesParam { + /** Request content type */ + contentType?: "application/merge-patch+json"; +} + +export type TillageDataCreateOrUpdateParameters = TillageDataCreateOrUpdateMediaTypesParam & + TillageDataCreateOrUpdateBodyParam & + RequestParameters; export type TillageDataDeleteParameters = RequestParameters; +export type TillageDataGetCascadeDeleteJobDetailsParameters = RequestParameters; + +export interface TillageDataCreateCascadeDeleteJobQueryParamProperties { + /** Id of the associated farmer. */ + farmerId: string; + /** Id of the tillage data resource. */ + tillageDataId: string; +} + +export interface TillageDataCreateCascadeDeleteJobQueryParam { + queryParameters: TillageDataCreateCascadeDeleteJobQueryParamProperties; +} + +export type TillageDataCreateCascadeDeleteJobParameters = + TillageDataCreateCascadeDeleteJobQueryParam & RequestParameters; export interface WeatherListQueryParamProperties { - /** Farmer ID. */ + /** Id of the associated farmer. */ farmerId: string; - /** Boundary ID. */ + /** Id of the associated boundary. */ boundaryId: string; - /** ID of the weather extension. */ + /** Id of the weather extension. This signifies the source from where the weather data is fetched (eg. DTN.ClearAg). */ extensionId: string; /** Type of weather data (forecast/historical). */ weatherDataType: string; /** Granularity of weather data (daily/hourly). */ granularity: string; - /** Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. */ - startDateTime?: Date; - /** Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ. */ - endDateTime?: Date; - /** - * Maximum number of items needed (inclusive). - * Minimum = 10, Maximum = 1000, Default value = 50. - */ + /** Weather data at or after the given UTC Date-time will be returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + startDateTime?: Date | string; + /** Weather data at or before the given UTC Date-time will be returned (format: yyyy-MM-ddTHH:mm:ssZ). */ + endDateTime?: Date | string; + /** Maximum number of items to be returned in a single page. */ $maxPageSize?: number; /** Skip token for getting next set of results. */ $skipToken?: string; @@ -1596,20 +1774,34 @@ export interface WeatherListQueryParam { queryParameters: WeatherListQueryParamProperties; } -export type WeatherListParameters = RequestParameters & WeatherListQueryParam; +export type WeatherListParameters = WeatherListQueryParam & RequestParameters; export type WeatherGetDataIngestionJobDetailsParameters = RequestParameters; export interface WeatherCreateDataIngestionJobBodyParam { + /** Job parameters supplied by the user. */ body?: WeatherDataIngestionJob; } -export type WeatherCreateDataIngestionJobParameters = RequestParameters & - WeatherCreateDataIngestionJobBodyParam; +export interface WeatherCreateDataIngestionJobMediaTypesParam { + /** Request content type */ + contentType?: "application/json"; +} + +export type WeatherCreateDataIngestionJobParameters = WeatherCreateDataIngestionJobMediaTypesParam & + WeatherCreateDataIngestionJobBodyParam & + RequestParameters; export type WeatherGetDataDeleteJobDetailsParameters = RequestParameters; export interface WeatherCreateDataDeleteJobBodyParam { + /** Job parameters supplied by the user. */ body?: WeatherDataDeleteJob; } -export type WeatherCreateDataDeleteJobParameters = RequestParameters & - WeatherCreateDataDeleteJobBodyParam; +export interface WeatherCreateDataDeleteJobMediaTypesParam { + /** Request content type */ + contentType?: "application/json"; +} + +export type WeatherCreateDataDeleteJobParameters = WeatherCreateDataDeleteJobMediaTypesParam & + WeatherCreateDataDeleteJobBodyParam & + RequestParameters; diff --git a/sdk/core/core-client-lro-rest/src/getLongRunningHelper.ts b/sdk/agrifood/agrifood-farming-rest/src/pollingHelper.ts similarity index 66% rename from sdk/core/core-client-lro-rest/src/getLongRunningHelper.ts rename to sdk/agrifood/agrifood-farming-rest/src/pollingHelper.ts index bcdffc048948..573a6be6b7b4 100644 --- a/sdk/core/core-client-lro-rest/src/getLongRunningHelper.ts +++ b/sdk/agrifood/agrifood-farming-rest/src/pollingHelper.ts @@ -11,46 +11,17 @@ import { PollerLike, } from "@azure/core-lro"; -/** - * Options for the poller - */ -export interface PollerOptions { - /** - * Defines how much time the poller is going to wait before making a new request to the service. - */ - updateIntervalInMs?: number; - /** - * A serialized poller which can be used to resume an existing paused Long-Running-Operation. - */ - resumeFrom?: string; -} - /** * Helper function that builds a Poller object to help polling a long running operation. * @param client - Client to use for sending the request to get additional pages. * @param initialResponse - The initial response. + * @param options - Options to set a resume state or custom polling interval. * @returns - A poller object to poll for operation state updates and eventually get the final response. */ -export function getLongRunningPoller( - client: Client, - initialResponse: TResult -): PollerLike, TResult>; -/** - * Helper function that builds a Poller object to help polling a long running operation. - * @param client - Client to use for sending the request to get additional pages. - * @param initialResponse - The initial response. - * @param pollerOptions - Options to set a resume state or custom polling interval. - * @returns - A poller object to poll for operation state updates and eventually get the final response. - */ -export function getLongRunningPoller( - client: Client, - initialResponse: TResult, - pollerOptions: LroEngineOptions> -): PollerLike, TResult>; export function getLongRunningPoller( client: Client, initialResponse: TResult, - pollerOptions?: LroEngineOptions> + options: LroEngineOptions> = {} ): PollerLike, TResult> { const poller: LongRunningOperation = { requestMethod: initialResponse.request.method, @@ -71,7 +42,7 @@ export function getLongRunningPoller( }, }; - return new LroEngine(poller, pollerOptions); + return new LroEngine(poller, options); } /** diff --git a/sdk/agrifood/agrifood-farming-rest/src/responses.ts b/sdk/agrifood/agrifood-farming-rest/src/responses.ts index ad5e3f9632c1..05adc39d947c 100644 --- a/sdk/agrifood/agrifood-farming-rest/src/responses.ts +++ b/sdk/agrifood/agrifood-farming-rest/src/responses.ts @@ -1,1258 +1,3023 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT license. -import { - ApplicationDataListResponse, - ErrorResponse, - ApplicationData, - AttachmentListResponse, - Attachment, - BoundaryListResponse, - CascadeDeleteJob, - Boundary, - BoundaryOverlapResponse, - CropListResponse, - Crop, - CropVarietyListResponse, - CropVariety, - FarmerListResponse, - Farmer, - FarmOperationDataIngestionJob, - FarmListResponse, - Farm, - FieldListResponse, - Field, - HarvestDataListResponse, - HarvestData, - ImageProcessingRasterizeJob, - OAuthProviderListResponse, - OAuthProvider, - OAuthTokenListResponse, - PlantingDataListResponse, - PlantingData, - SceneListResponse, - SatelliteDataIngestionJob, - SeasonalFieldListResponse, - SeasonalField, - SeasonListResponse, - Season, - TillageDataListResponse, - TillageData, - WeatherDataListResponse, - WeatherDataIngestionJob, - WeatherDataDeleteJob, -} from "./models"; import { HttpResponse } from "@azure-rest/core-client"; - -/** Returns a paginated list of application data resources under a particular farm. */ +import { + ApplicationDataListResponseOutput, + ApplicationDataOutput, + AttachmentListResponseOutput, + AttachmentOutput, + BoundaryListResponseOutput, + BoundaryOutput, + BoundaryOverlapResponseOutput, + CascadeDeleteJobOutput, + CropListResponseOutput, + CropOutput, + CropVarietyListResponseOutput, + CropVarietyOutput, + ErrorResponseOutput, + FarmListResponseOutput, + FarmOperationDataIngestionJobOutput, + FarmOutput, + FarmerListResponseOutput, + FarmerOutput, + FieldListResponseOutput, + FieldOutput, + HarvestDataListResponseOutput, + HarvestDataOutput, + ImageProcessingRasterizeJobOutput, + OAuthProviderCascadeDeleteJobOutput, + OAuthProviderListResponseOutput, + OAuthProviderOutput, + OAuthTokenListResponseOutput, + PlantingDataListResponseOutput, + PlantingDataOutput, + SatelliteDataIngestionJobOutput, + SceneListResponseOutput, + SeasonListResponseOutput, + SeasonOutput, + SeasonalFieldListResponseOutput, + SeasonalFieldOutput, + TillageDataListResponseOutput, + TillageDataOutput, + WeatherDataDeleteJobOutput, + WeatherDataIngestionJobOutput, + WeatherDataListResponseOutput, +} from "./outputModels"; + +/** + * Get a paginated list of application data resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface ApplicationDataListByFarmerId200Response extends HttpResponse { status: "200"; - body: ApplicationDataListResponse; + body: ApplicationDataListResponseOutput; } -/** Returns a paginated list of application data resources under a particular farm. */ +/** + * Get a paginated list of application data resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface ApplicationDataListByFarmerIddefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of application data resources across all farmers. */ +/** + * Get a paginated list of application data resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface ApplicationDataList200Response extends HttpResponse { status: "200"; - body: ApplicationDataListResponse; + body: ApplicationDataListResponseOutput; } -/** Returns a paginated list of application data resources across all farmers. */ +/** + * Get a paginated list of application data resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface ApplicationDataListdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Get a specified application data resource under a particular farmer. */ +/** + * Get a specified application data resource for a given farmer. + * + * + */ export interface ApplicationDataGet200Response extends HttpResponse { status: "200"; - body: ApplicationData; + body: ApplicationDataOutput; } -/** Get a specified application data resource under a particular farmer. */ +/** + * Get a specified application data resource for a given farmer. + * + * + */ export interface ApplicationDataGetdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Creates or updates an application data resource under a particular farmer. */ + body: ErrorResponseOutput; +} + +/** + * Create or update an application data resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface ApplicationDataCreateOrUpdate200Response extends HttpResponse { status: "200"; - body: ApplicationData; -} - -/** Creates or updates an application data resource under a particular farmer. */ + body: ApplicationDataOutput; +} + +/** + * Create or update an application data resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface ApplicationDataCreateOrUpdate201Response extends HttpResponse { status: "201"; - body: ApplicationData; -} - -/** Creates or updates an application data resource under a particular farmer. */ + body: ApplicationDataOutput; +} + +/** + * Create or update an application data resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface ApplicationDataCreateOrUpdatedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Deletes a specified application data resource under a particular farmer. */ +/** + * Delete a specified application data resource for a given farmer. + * + * + */ export interface ApplicationDataDelete204Response extends HttpResponse { status: "204"; + body: Record; } -/** Deletes a specified application data resource under a particular farmer. */ +/** + * Delete a specified application data resource for a given farmer. + * + * + */ export interface ApplicationDataDeletedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of attachment resources under a particular farmer. */ +/** + * Get details of a cascade delete job for application data resource. + * + * + */ +export interface ApplicationDataGetCascadeDeleteJobDetails200Response extends HttpResponse { + status: "200"; + body: CascadeDeleteJobOutput; +} + +/** + * Get details of a cascade delete job for application data resource. + * + * + */ +export interface ApplicationDataGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { + status: "500"; + body: ErrorResponseOutput; +} + +/** + * Create cascade delete job for application data resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ +export interface ApplicationDataCreateCascadeDeleteJob202Response extends HttpResponse { + status: "202"; + body: CascadeDeleteJobOutput; +} + +/** + * Create cascade delete job for application data resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ +export interface ApplicationDataCreateCascadeDeleteJobdefaultResponse extends HttpResponse { + status: "500"; + body: ErrorResponseOutput; +} + +/** + * Get a paginated list of attachment resources for a given farmer and search criteria. + * + * + */ export interface AttachmentsListByFarmerId200Response extends HttpResponse { status: "200"; - body: AttachmentListResponse; + body: AttachmentListResponseOutput; } -/** Returns a paginated list of attachment resources under a particular farmer. */ +/** + * Get a paginated list of attachment resources for a given farmer and search criteria. + * + * + */ export interface AttachmentsListByFarmerIddefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Gets a specified attachment resource under a particular farmer. */ +/** + * Get a specified attachment resource for a given farmer. + * + * + */ export interface AttachmentsGet200Response extends HttpResponse { status: "200"; - body: Attachment; + body: AttachmentOutput; } -/** Gets a specified attachment resource under a particular farmer. */ +/** + * Get a specified attachment resource for a given farmer. + * + * + */ export interface AttachmentsGetdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Creates or updates an attachment resource under a particular farmer. */ +/** + * Create or update an attachment resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * + * + */ export interface AttachmentsCreateOrUpdate200Response extends HttpResponse { status: "200"; - body: Attachment; + body: AttachmentOutput; } -/** Creates or updates an attachment resource under a particular farmer. */ +/** + * Create or update an attachment resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * + * + */ export interface AttachmentsCreateOrUpdate201Response extends HttpResponse { status: "201"; - body: Attachment; -} - -/** Creates or updates an attachment resource under a particular farmer. */ + body: AttachmentOutput; +} + +/** + * Create or update an attachment resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * + * + */ export interface AttachmentsCreateOrUpdatedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Deletes a specified attachment resource under a particular farmer. */ +/** + * Delete a specified attachment resource for a given farmer. + * + * + */ export interface AttachmentsDelete204Response extends HttpResponse { status: "204"; + body: Record; } -/** Deletes a specified attachment resource under a particular farmer. */ +/** + * Delete a specified attachment resource for a given farmer. + * + * + */ export interface AttachmentsDeletedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Downloads and returns attachment as response for the given input filePath. */ +/** + * Return attachment as a file stream for a given input filePath. + * + * + */ export interface AttachmentsDownload200Response extends HttpResponse { status: "200"; + /** Value may contain any sequence of octets */ + body: Uint8Array; } -/** Downloads and returns attachment as response for the given input filePath. */ +/** + * Return attachment as a file stream for a given input filePath. + * + * + */ export interface AttachmentsDownloaddefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of boundary resources under a particular farmer. */ +/** + * Get a paginated list of boundary resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface BoundariesListByFarmerId200Response extends HttpResponse { status: "200"; - body: BoundaryListResponse; + body: BoundaryListResponseOutput; } -/** Returns a paginated list of boundary resources under a particular farmer. */ +/** + * Get a paginated list of boundary resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface BoundariesListByFarmerIddefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Search for boundaries by fields and intersecting geometry. */ +/** + * Search for boundaries of a farmer intersecting with a given geometry. + * This API is expected to be used when users want to find boundaries that intersect with a given geometry. Otherwise, this is functionally same as 'List by Farmer Id' API for boundaries. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface BoundariesSearchByFarmerId200Response extends HttpResponse { status: "200"; - body: BoundaryListResponse; + body: BoundaryListResponseOutput; } -/** Search for boundaries by fields and intersecting geometry. */ +/** + * Search for boundaries of a farmer intersecting with a given geometry. + * This API is expected to be used when users want to find boundaries that intersect with a given geometry. Otherwise, this is functionally same as 'List by Farmer Id' API for boundaries. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface BoundariesSearchByFarmerIddefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of boundary resources across all farmers. */ +/** + * Get a paginated list of boundary resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface BoundariesList200Response extends HttpResponse { status: "200"; - body: BoundaryListResponse; + body: BoundaryListResponseOutput; } -/** Returns a paginated list of boundary resources across all farmers. */ +/** + * Get a paginated list of boundary resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface BoundariesListdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Search for boundaries across all farmers by fields and intersecting geometry. */ + body: ErrorResponseOutput; +} + +/** + * Search for boundaries across all the farmers intersecting with a given geometry. + * This API is expected to be used when users want to find boundaries that intersect with a given geometry. Otherwise, this is functionally same as 'List' API for boundaries. + * + * + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘Search by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface BoundariesSearch200Response extends HttpResponse { status: "200"; - body: BoundaryListResponse; -} - -/** Search for boundaries across all farmers by fields and intersecting geometry. */ + body: BoundaryListResponseOutput; +} + +/** + * Search for boundaries across all the farmers intersecting with a given geometry. + * This API is expected to be used when users want to find boundaries that intersect with a given geometry. Otherwise, this is functionally same as 'List' API for boundaries. + * + * + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘Search by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface BoundariesSearchdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Get cascade delete job for specified boundary. */ +/** + * Get details of cascade delete job for a specified boundary. + * + * + */ export interface BoundariesGetCascadeDeleteJobDetails200Response extends HttpResponse { status: "200"; - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; } -/** Get cascade delete job for specified boundary. */ +/** + * Get details of cascade delete job for a specified boundary. + * + * + */ export interface BoundariesGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Create a cascade delete job for specified boundary. */ +/** + * Create a cascade delete job for a specified boundary. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ export interface BoundariesCreateCascadeDeleteJob202Response extends HttpResponse { status: "202"; - body: CascadeDeleteJob; -} - -/** Create a cascade delete job for specified boundary. */ + body: CascadeDeleteJobOutput; +} + +/** + * Create a cascade delete job for a specified boundary. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ export interface BoundariesCreateCascadeDeleteJobdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Gets a specified boundary resource under a particular farmer. */ +/** + * Get a specified boundary resource for a given farmer. + * + * + */ export interface BoundariesGet200Response extends HttpResponse { status: "200"; - body: Boundary; + body: BoundaryOutput; } -/** Gets a specified boundary resource under a particular farmer. */ +/** + * Get a specified boundary resource for a given farmer. + * + * + */ export interface BoundariesGetdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Creates or updates a boundary resource. */ + body: ErrorResponseOutput; +} + +/** + * Create or update a boundary resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface BoundariesCreateOrUpdate200Response extends HttpResponse { status: "200"; - body: Boundary; -} - -/** Creates or updates a boundary resource. */ + body: BoundaryOutput; +} + +/** + * Create or update a boundary resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface BoundariesCreateOrUpdate201Response extends HttpResponse { status: "201"; - body: Boundary; -} - -/** Creates or updates a boundary resource. */ + body: BoundaryOutput; +} + +/** + * Create or update a boundary resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface BoundariesCreateOrUpdatedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Deletes a specified boundary resource under a particular farmer. */ +/** + * Delete a specified boundary resource for a given farmer. It can only be deleted if it has no linked attachments, satellite or weather data. + * + * + */ export interface BoundariesDelete204Response extends HttpResponse { status: "204"; + body: Record; } -/** Deletes a specified boundary resource under a particular farmer. */ +/** + * Delete a specified boundary resource for a given farmer. It can only be deleted if it has no linked attachments, satellite or weather data. + * + * + */ export interface BoundariesDeletedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns overlapping acreage between two boundary Ids. */ +/** + * Get overlapping (intersecting) acreage between two boundaries. + * + * + */ export interface BoundariesGetOverlap200Response extends HttpResponse { status: "200"; - body: BoundaryOverlapResponse; + body: BoundaryOverlapResponseOutput; } -/** Returns overlapping acreage between two boundary Ids. */ +/** + * Get overlapping (intersecting) acreage between two boundaries. + * + * + */ export interface BoundariesGetOverlapdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of crop resources. */ +/** + * Get a paginated list of crop resources. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface CropsList200Response extends HttpResponse { status: "200"; - body: CropListResponse; + body: CropListResponseOutput; } -/** Returns a paginated list of crop resources. */ +/** + * Get a paginated list of crop resources. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface CropsListdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Gets a specified crop resource. */ +/** + * Get a specified crop resource. + * + * + */ export interface CropsGet200Response extends HttpResponse { status: "200"; - body: Crop; + body: CropOutput; } -/** Gets a specified crop resource. */ +/** + * Get a specified crop resource. + * + * + */ export interface CropsGetdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Creates or updates a crop resource. */ + body: ErrorResponseOutput; +} + +/** + * Create or update a crop resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface CropsCreateOrUpdate200Response extends HttpResponse { status: "200"; - body: Crop; -} - -/** Creates or updates a crop resource. */ + body: CropOutput; +} + +/** + * Create or update a crop resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface CropsCreateOrUpdate201Response extends HttpResponse { status: "201"; - body: Crop; -} - -/** Creates or updates a crop resource. */ + body: CropOutput; +} + +/** + * Create or update a crop resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface CropsCreateOrUpdatedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Deletes Crop for given crop id. */ +/** + * Delete a specified crop resource. + * + * + */ export interface CropsDelete204Response extends HttpResponse { status: "204"; + body: Record; } -/** Deletes Crop for given crop id. */ +/** + * Delete a specified crop resource. + * + * + */ export interface CropsDeletedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of crop variety resources under a particular crop. */ +/** + * Get a paginated list of crop variety resources for a given crop and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface CropVarietiesListByCropId200Response extends HttpResponse { status: "200"; - body: CropVarietyListResponse; + body: CropVarietyListResponseOutput; } -/** Returns a paginated list of crop variety resources under a particular crop. */ +/** + * Get a paginated list of crop variety resources for a given crop and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface CropVarietiesListByCropIddefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of crop variety resources across all crops. */ +/** + * Get a paginated list of crop variety resources across all the crops for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the crop Id is available, it is strongly recommended to use **‘List by Crop Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface CropVarietiesList200Response extends HttpResponse { status: "200"; - body: CropVarietyListResponse; + body: CropVarietyListResponseOutput; } -/** Returns a paginated list of crop variety resources across all crops. */ +/** + * Get a paginated list of crop variety resources across all the crops for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the crop Id is available, it is strongly recommended to use **‘List by Crop Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface CropVarietiesListdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Gets a specified crop variety resource under a particular crop. */ +/** + * Get a specified crop variety resource for a given crop. + * + * + */ export interface CropVarietiesGet200Response extends HttpResponse { status: "200"; - body: CropVariety; + body: CropVarietyOutput; } -/** Gets a specified crop variety resource under a particular crop. */ +/** + * Get a specified crop variety resource for a given crop. + * + * + */ export interface CropVarietiesGetdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Creates or updates a crop variety resource. */ + body: ErrorResponseOutput; +} + +/** + * Create or update a crop variety resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface CropVarietiesCreateOrUpdate200Response extends HttpResponse { status: "200"; - body: CropVariety; -} - -/** Creates or updates a crop variety resource. */ + body: CropVarietyOutput; +} + +/** + * Create or update a crop variety resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface CropVarietiesCreateOrUpdate201Response extends HttpResponse { status: "201"; - body: CropVariety; -} - -/** Creates or updates a crop variety resource. */ + body: CropVarietyOutput; +} + +/** + * Create or update a crop variety resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface CropVarietiesCreateOrUpdatedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Deletes a specified crop variety resource under a particular crop. */ +/** + * Delete a specified crop variety resource for a given crop. + * + * + */ export interface CropVarietiesDelete204Response extends HttpResponse { status: "204"; + body: Record; } -/** Deletes a specified crop variety resource under a particular crop. */ +/** + * Delete a specified crop variety resource for a given crop. + * + * + */ export interface CropVarietiesDeletedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of farmer resources. */ +/** + * Get a paginated list of farmer resources for a given search criteria. + * + * + */ export interface FarmersList200Response extends HttpResponse { status: "200"; - body: FarmerListResponse; + body: FarmerListResponseOutput; } -/** Returns a paginated list of farmer resources. */ +/** + * Get a paginated list of farmer resources for a given search criteria. + * + * + */ export interface FarmersListdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Gets a specified farmer resource. */ +/** + * Get a specified farmer resource. + * + * + */ export interface FarmersGet200Response extends HttpResponse { status: "200"; - body: Farmer; + body: FarmerOutput; } -/** Gets a specified farmer resource. */ +/** + * Get a specified farmer resource. + * + * + */ export interface FarmersGetdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Creates or updates a farmer resource. */ + body: ErrorResponseOutput; +} + +/** + * Create or update a farmer resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface FarmersCreateOrUpdate200Response extends HttpResponse { status: "200"; - body: Farmer; -} - -/** Creates or updates a farmer resource. */ + body: FarmerOutput; +} + +/** + * Create or update a farmer resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface FarmersCreateOrUpdate201Response extends HttpResponse { status: "201"; - body: Farmer; -} - -/** Creates or updates a farmer resource. */ + body: FarmerOutput; +} + +/** + * Create or update a farmer resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface FarmersCreateOrUpdatedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Deletes a specified farmer resource. */ +/** + * Delete a specified farmer resource. It can only be deleted if it has no linked attachments or farms. + * + * + */ export interface FarmersDelete204Response extends HttpResponse { status: "204"; + body: Record; } -/** Deletes a specified farmer resource. */ +/** + * Delete a specified farmer resource. It can only be deleted if it has no linked attachments or farms. + * + * + */ export interface FarmersDeletedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Get a cascade delete job for specified farmer. */ +/** + * Get details of a cascade delete job for a specified farmer. + * + * + */ export interface FarmersGetCascadeDeleteJobDetails200Response extends HttpResponse { status: "200"; - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; } -/** Get a cascade delete job for specified farmer. */ +/** + * Get details of a cascade delete job for a specified farmer. + * + * + */ export interface FarmersGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Create a cascade delete job for specified farmer. */ +/** + * Create a cascade delete job for a specified farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ export interface FarmersCreateCascadeDeleteJob202Response extends HttpResponse { status: "202"; - body: CascadeDeleteJob; -} - -/** Create a cascade delete job for specified farmer. */ + body: CascadeDeleteJobOutput; +} + +/** + * Create a cascade delete job for a specified farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ export interface FarmersCreateCascadeDeleteJobdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Create a farm operation data ingestion job. */ + body: ErrorResponseOutput; +} + +/** + * Create a farm operation data ingestion job. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface FarmOperationsCreateDataIngestionJob202Response extends HttpResponse { status: "202"; - body: FarmOperationDataIngestionJob; -} - -/** Create a farm operation data ingestion job. */ + body: FarmOperationDataIngestionJobOutput; +} + +/** + * Create a farm operation data ingestion job. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface FarmOperationsCreateDataIngestionJobdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Get a farm operation data ingestion job. */ +/** + * Get details of a farm operation data ingestion job. + * + * + */ export interface FarmOperationsGetDataIngestionJobDetails200Response extends HttpResponse { status: "200"; - body: FarmOperationDataIngestionJob; + body: FarmOperationDataIngestionJobOutput; } -/** Get a farm operation data ingestion job. */ +/** + * Get details of a farm operation data ingestion job. + * + * + */ export interface FarmOperationsGetDataIngestionJobDetailsdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of farm resources under a particular farmer. */ +/** + * Get a paginated list of farm resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface FarmsListByFarmerId200Response extends HttpResponse { status: "200"; - body: FarmListResponse; + body: FarmListResponseOutput; } -/** Returns a paginated list of farm resources under a particular farmer. */ +/** + * Get a paginated list of farm resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface FarmsListByFarmerIddefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of farm resources across all farmers. */ +/** + * Get a paginated list of farm resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface FarmsList200Response extends HttpResponse { status: "200"; - body: FarmListResponse; + body: FarmListResponseOutput; } -/** Returns a paginated list of farm resources across all farmers. */ +/** + * Get a paginated list of farm resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface FarmsListdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Gets a specified farm resource under a particular farmer. */ +/** + * Get a specified farm resource for a given farmer. + * + * + */ export interface FarmsGet200Response extends HttpResponse { status: "200"; - body: Farm; + body: FarmOutput; } -/** Gets a specified farm resource under a particular farmer. */ +/** + * Get a specified farm resource for a given farmer. + * + * + */ export interface FarmsGetdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Creates or updates a farm resource under a particular farmer. */ + body: ErrorResponseOutput; +} + +/** + * Create or update a farm resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface FarmsCreateOrUpdate200Response extends HttpResponse { status: "200"; - body: Farm; -} - -/** Creates or updates a farm resource under a particular farmer. */ + body: FarmOutput; +} + +/** + * Create or update a farm resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface FarmsCreateOrUpdate201Response extends HttpResponse { status: "201"; - body: Farm; -} - -/** Creates or updates a farm resource under a particular farmer. */ + body: FarmOutput; +} + +/** + * Create or update a farm resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface FarmsCreateOrUpdatedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Deletes a specified farm resource under a particular farmer. */ +/** + * Delete a specified farm resource for a given farmer. It can only be deleted if it has no linked attachments, fields or seasonal fields. + * + * + */ export interface FarmsDelete204Response extends HttpResponse { status: "204"; + body: Record; } -/** Deletes a specified farm resource under a particular farmer. */ +/** + * Delete a specified farm resource for a given farmer. It can only be deleted if it has no linked attachments, fields or seasonal fields. + * + * + */ export interface FarmsDeletedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Get a cascade delete job for specified farm. */ +/** + * Get details of cascade delete job for a specified farm. + * + * + */ export interface FarmsGetCascadeDeleteJobDetails200Response extends HttpResponse { status: "200"; - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; } -/** Get a cascade delete job for specified farm. */ +/** + * Get details of cascade delete job for a specified farm. + * + * + */ export interface FarmsGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Create a cascade delete job for specified farm. */ +/** + * Create a cascade delete job for a specified farm. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ export interface FarmsCreateCascadeDeleteJob202Response extends HttpResponse { status: "202"; - body: CascadeDeleteJob; -} - -/** Create a cascade delete job for specified farm. */ + body: CascadeDeleteJobOutput; +} + +/** + * Create a cascade delete job for a specified farm. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ export interface FarmsCreateCascadeDeleteJobdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of field resources under a particular farmer. */ +/** + * Get a paginated list of field resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface FieldsListByFarmerId200Response extends HttpResponse { status: "200"; - body: FieldListResponse; + body: FieldListResponseOutput; } -/** Returns a paginated list of field resources under a particular farmer. */ +/** + * Get a paginated list of field resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface FieldsListByFarmerIddefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of field resources across all farmers. */ +/** + * Get a paginated list of field resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface FieldsList200Response extends HttpResponse { status: "200"; - body: FieldListResponse; + body: FieldListResponseOutput; } -/** Returns a paginated list of field resources across all farmers. */ +/** + * Get a paginated list of field resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface FieldsListdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Gets a specified field resource under a particular farmer. */ +/** + * Get a specified field resource for a given farmer. + * + * + */ export interface FieldsGet200Response extends HttpResponse { status: "200"; - body: Field; + body: FieldOutput; } -/** Gets a specified field resource under a particular farmer. */ +/** + * Get a specified field resource for a given farmer. + * + * + */ export interface FieldsGetdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Creates or Updates a field resource under a particular farmer. */ + body: ErrorResponseOutput; +} + +/** + * Create or update a field resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface FieldsCreateOrUpdate200Response extends HttpResponse { status: "200"; - body: Field; -} - -/** Creates or Updates a field resource under a particular farmer. */ + body: FieldOutput; +} + +/** + * Create or update a field resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface FieldsCreateOrUpdate201Response extends HttpResponse { status: "201"; - body: Field; -} - -/** Creates or Updates a field resource under a particular farmer. */ + body: FieldOutput; +} + +/** + * Create or update a field resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface FieldsCreateOrUpdatedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Deletes a specified field resource under a particular farmer. */ +/** + * Delete a specified field resource for a given farmer. It can only be deleted if it has no linked attachments, boundaries or seasonal fields. + * + * + */ export interface FieldsDelete204Response extends HttpResponse { status: "204"; + body: Record; } -/** Deletes a specified field resource under a particular farmer. */ +/** + * Delete a specified field resource for a given farmer. It can only be deleted if it has no linked attachments, boundaries or seasonal fields. + * + * + */ export interface FieldsDeletedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Get a cascade delete job for specified field. */ +/** + * Get details of cascade delete job for a specified field. + * + * + */ export interface FieldsGetCascadeDeleteJobDetails200Response extends HttpResponse { status: "200"; - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; } -/** Get a cascade delete job for specified field. */ +/** + * Get details of cascade delete job for a specified field. + * + * + */ export interface FieldsGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Create a cascade delete job for specified field. */ +/** + * Create a cascade delete job for specified field. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ export interface FieldsCreateCascadeDeleteJob202Response extends HttpResponse { status: "202"; - body: CascadeDeleteJob; -} - -/** Create a cascade delete job for specified field. */ + body: CascadeDeleteJobOutput; +} + +/** + * Create a cascade delete job for specified field. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ export interface FieldsCreateCascadeDeleteJobdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of harvest data resources under a particular farm. */ +/** + * Get a paginated list of harvest data resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface HarvestDataListByFarmerId200Response extends HttpResponse { status: "200"; - body: HarvestDataListResponse; + body: HarvestDataListResponseOutput; } -/** Returns a paginated list of harvest data resources under a particular farm. */ +/** + * Get a paginated list of harvest data resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface HarvestDataListByFarmerIddefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of harvest data resources across all farmers. */ +/** + * Get a paginated list of harvest data resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface HarvestDataList200Response extends HttpResponse { status: "200"; - body: HarvestDataListResponse; + body: HarvestDataListResponseOutput; } -/** Returns a paginated list of harvest data resources across all farmers. */ +/** + * Get a paginated list of harvest data resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface HarvestDataListdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Get a specified harvest data resource under a particular farmer. */ +/** + * Get a specified harvest data resource for a given farmer. + * + * + */ export interface HarvestDataGet200Response extends HttpResponse { status: "200"; - body: HarvestData; + body: HarvestDataOutput; } -/** Get a specified harvest data resource under a particular farmer. */ +/** + * Get a specified harvest data resource for a given farmer. + * + * + */ export interface HarvestDataGetdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Creates or updates harvest data resource under a particular farmer. */ + body: ErrorResponseOutput; +} + +/** + * Create or update harvest data resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface HarvestDataCreateOrUpdate200Response extends HttpResponse { status: "200"; - body: HarvestData; -} - -/** Creates or updates harvest data resource under a particular farmer. */ + body: HarvestDataOutput; +} + +/** + * Create or update harvest data resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface HarvestDataCreateOrUpdate201Response extends HttpResponse { status: "201"; - body: HarvestData; -} - -/** Creates or updates harvest data resource under a particular farmer. */ + body: HarvestDataOutput; +} + +/** + * Create or update harvest data resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface HarvestDataCreateOrUpdatedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Deletes a specified harvest data resource under a particular farmer. */ +/** + * Delete a specified harvest data resource for a given farmer. + * + * + */ export interface HarvestDataDelete204Response extends HttpResponse { status: "204"; + body: Record; } -/** Deletes a specified harvest data resource under a particular farmer. */ +/** + * Delete a specified harvest data resource for a given farmer. + * + * + */ export interface HarvestDataDeletedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Create a ImageProcessing Rasterize job. */ -export interface ImageProcessingCreateRasterizeJob202Response extends HttpResponse { - status: "202"; - body: ImageProcessingRasterizeJob; +/** + * Get details of a cascade delete job for harvest data resource. + * + * + */ +export interface HarvestDataGetCascadeDeleteJobDetails200Response extends HttpResponse { + status: "200"; + body: CascadeDeleteJobOutput; +} + +/** + * Get details of a cascade delete job for harvest data resource. + * + * + */ +export interface HarvestDataGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { + status: "500"; + body: ErrorResponseOutput; } -/** Create a ImageProcessing Rasterize job. */ +/** + * Create cascade delete job for harvest data resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ +export interface HarvestDataCreateCascadeDeleteJob202Response extends HttpResponse { + status: "202"; + body: CascadeDeleteJobOutput; +} + +/** + * Create cascade delete job for harvest data resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ +export interface HarvestDataCreateCascadeDeleteJobdefaultResponse extends HttpResponse { + status: "500"; + body: ErrorResponseOutput; +} + +/** + * Create a job which converts shape files into raster images. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ +export interface ImageProcessingCreateRasterizeJob202Response extends HttpResponse { + status: "202"; + body: ImageProcessingRasterizeJobOutput; +} + +/** + * Create a job which converts shape files into raster images. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface ImageProcessingCreateRasterizeJobdefaultResponse extends HttpResponse { status: "500"; + body: Record; } -/** Get ImageProcessing Rasterize job's details. */ +/** + * Get details of rasterize job. Rasterize job converts shape files into raster images. + * + * + */ export interface ImageProcessingGetRasterizeJob200Response extends HttpResponse { status: "200"; - body: ImageProcessingRasterizeJob; + body: ImageProcessingRasterizeJobOutput; } -/** Returns a paginated list of oauthProvider resources. */ +/** + * Get a paginated list of OAuth provider resources for a given search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface OAuthProvidersList200Response extends HttpResponse { status: "200"; - body: OAuthProviderListResponse; + body: OAuthProviderListResponseOutput; } -/** Returns a paginated list of oauthProvider resources. */ +/** + * Get a paginated list of OAuth provider resources for a given search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface OAuthProvidersListdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Get a specified oauthProvider resource. */ +/** + * Get a specified OAuth provider resource. + * + * + */ export interface OAuthProvidersGet200Response extends HttpResponse { status: "200"; - body: OAuthProvider; + body: OAuthProviderOutput; } -/** Get a specified oauthProvider resource. */ +/** + * Get a specified OAuth provider resource. + * + * + */ export interface OAuthProvidersGetdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Creates or updates an oauthProvider resource. */ + body: ErrorResponseOutput; +} + +/** + * Create or update an OAuth provider resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface OAuthProvidersCreateOrUpdate200Response extends HttpResponse { status: "200"; - body: OAuthProvider; -} - -/** Creates or updates an oauthProvider resource. */ + body: OAuthProviderOutput; +} + +/** + * Create or update an OAuth provider resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface OAuthProvidersCreateOrUpdate201Response extends HttpResponse { status: "201"; - body: OAuthProvider; -} - -/** Creates or updates an oauthProvider resource. */ + body: OAuthProviderOutput; +} + +/** + * Create or update an OAuth provider resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface OAuthProvidersCreateOrUpdatedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Deletes an specified oauthProvider resource. */ +/** + * Delete a specified OAuth provider resource. + * + * + */ export interface OAuthProvidersDelete204Response extends HttpResponse { status: "204"; + body: Record; } -/** Deletes an specified oauthProvider resource. */ +/** + * Delete a specified OAuth provider resource. + * + * + */ export interface OAuthProvidersDeletedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; +} + +/** + * Get details of cascade delete job for an OAuth provider resource. + * + * + */ +export interface OAuthProvidersGetCascadeDeleteJobDetails200Response extends HttpResponse { + status: "200"; + body: OAuthProviderCascadeDeleteJobOutput; +} + +/** + * Get details of cascade delete job for an OAuth provider resource. + * + * + */ +export interface OAuthProvidersGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { + status: "500"; + body: ErrorResponseOutput; } -/** Returns a list of OAuthToken documents. */ +/** + * Create cascade delete job for an OAuth provider resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ +export interface OAuthProvidersCreateCascadeDeleteJob202Response extends HttpResponse { + status: "202"; + body: OAuthProviderCascadeDeleteJobOutput; +} + +/** + * Create cascade delete job for an OAuth provider resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ +export interface OAuthProvidersCreateCascadeDeleteJobdefaultResponse extends HttpResponse { + status: "500"; + body: ErrorResponseOutput; +} + +/** + * Get a list of OAuthToken documents for a given search criteria. + * + * + */ export interface OAuthTokensList200Response extends HttpResponse { status: "200"; - body: OAuthTokenListResponse; + body: OAuthTokenListResponseOutput; } -/** Returns a list of OAuthToken documents. */ +/** + * Get a list of OAuthToken documents for a given search criteria. + * + * + */ export interface OAuthTokensListdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns Connection link needed in the OAuth flow. */ +/** + * Get connection link needed in the OAuth flow. + * + * + */ export interface OAuthTokensGetOAuthConnectionLink200Response extends HttpResponse { status: "200"; body: string; } -/** Returns Connection link needed in the OAuth flow. */ +/** + * Get connection link needed in the OAuth flow. + * + * + */ export interface OAuthTokensGetOAuthConnectionLinkdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Get cascade delete job details for OAuth tokens for specified job ID. */ +/** + * Get details of OAuth token remove job. + * + * + */ export interface OAuthTokensGetCascadeDeleteJobDetails200Response extends HttpResponse { status: "200"; - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; } -/** Get cascade delete job details for OAuth tokens for specified job ID. */ +/** + * Get details of OAuth token remove job. + * + * + */ export interface OAuthTokensGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Create a cascade delete job for OAuth tokens. */ +/** + * Create job to remove OAuth token. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ export interface OAuthTokensCreateCascadeDeleteJob202Response extends HttpResponse { status: "202"; - body: CascadeDeleteJob; -} - -/** Create a cascade delete job for OAuth tokens. */ + body: CascadeDeleteJobOutput; +} + +/** + * Create job to remove OAuth token. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ export interface OAuthTokensCreateCascadeDeleteJobdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of planting data resources under a particular farm. */ +/** + * Get a paginated list of planting data resources for a given farm and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface PlantingDataListByFarmerId200Response extends HttpResponse { status: "200"; - body: PlantingDataListResponse; + body: PlantingDataListResponseOutput; } -/** Returns a paginated list of planting data resources under a particular farm. */ +/** + * Get a paginated list of planting data resources for a given farm and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface PlantingDataListByFarmerIddefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of planting data resources across all farmers. */ +/** + * Get a paginated list of planting data resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface PlantingDataList200Response extends HttpResponse { status: "200"; - body: PlantingDataListResponse; + body: PlantingDataListResponseOutput; } -/** Returns a paginated list of planting data resources across all farmers. */ +/** + * Get a paginated list of planting data resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface PlantingDataListdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Get a specified planting data resource under a particular farmer. */ +/** + * Get a specified planting data resource for a given farmer. + * + * + */ export interface PlantingDataGet200Response extends HttpResponse { status: "200"; - body: PlantingData; + body: PlantingDataOutput; } -/** Get a specified planting data resource under a particular farmer. */ +/** + * Get a specified planting data resource for a given farmer. + * + * + */ export interface PlantingDataGetdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Creates or updates an planting data resource under a particular farmer. */ + body: ErrorResponseOutput; +} + +/** + * Create or update a planting data resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface PlantingDataCreateOrUpdate200Response extends HttpResponse { status: "200"; - body: PlantingData; -} - -/** Creates or updates an planting data resource under a particular farmer. */ + body: PlantingDataOutput; +} + +/** + * Create or update a planting data resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface PlantingDataCreateOrUpdate201Response extends HttpResponse { status: "201"; - body: PlantingData; -} - -/** Creates or updates an planting data resource under a particular farmer. */ + body: PlantingDataOutput; +} + +/** + * Create or update a planting data resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface PlantingDataCreateOrUpdatedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Deletes a specified planting data resource under a particular farmer. */ +/** + * Delete a specified planting data resource under a particular farmer. + * + * + */ export interface PlantingDataDelete204Response extends HttpResponse { status: "204"; + body: Record; } -/** Deletes a specified planting data resource under a particular farmer. */ +/** + * Delete a specified planting data resource under a particular farmer. + * + * + */ export interface PlantingDataDeletedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of scene resources. */ -export interface ScenesList200Response extends HttpResponse { +/** + * Get details of a cascade delete job for planting data resource. + * + * + */ +export interface PlantingDataGetCascadeDeleteJobDetails200Response extends HttpResponse { status: "200"; - body: SceneListResponse; + body: CascadeDeleteJobOutput; } -/** Returns a paginated list of scene resources. */ -export interface ScenesListdefaultResponse extends HttpResponse { +/** + * Get details of a cascade delete job for planting data resource. + * + * + */ +export interface PlantingDataGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Create a satellite data ingestion job. */ -export interface ScenesCreateSatelliteDataIngestionJob202Response extends HttpResponse { +/** + * Create cascade delete job for planting data resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ +export interface PlantingDataCreateCascadeDeleteJob202Response extends HttpResponse { status: "202"; - body: SatelliteDataIngestionJob; + body: CascadeDeleteJobOutput; +} + +/** + * Create cascade delete job for planting data resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ +export interface PlantingDataCreateCascadeDeleteJobdefaultResponse extends HttpResponse { + status: "500"; + body: ErrorResponseOutput; +} + +/** + * Get a paginated list of scene resources for a given search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * 2. This API will retrieve scenes present in the FarmBeats datastore and does not ingest new data. Example: a user has ingested satellite data from 1st of Jan 2019 to 30th of June 2019. However, using the current API, the user has asked for data from 1st of Jan 2019 to 31st of December 2019. In such a case, only data for the first 6 months is returned to the user. + * + * + */ +export interface ScenesList200Response extends HttpResponse { + status: "200"; + body: SceneListResponseOutput; } -/** Create a satellite data ingestion job. */ +/** + * Get a paginated list of scene resources for a given search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * 2. This API will retrieve scenes present in the FarmBeats datastore and does not ingest new data. Example: a user has ingested satellite data from 1st of Jan 2019 to 30th of June 2019. However, using the current API, the user has asked for data from 1st of Jan 2019 to 31st of December 2019. In such a case, only data for the first 6 months is returned to the user. + * + * + */ +export interface ScenesListdefaultResponse extends HttpResponse { + status: "500"; + body: ErrorResponseOutput; +} + +/** + * Create a satellite data ingestion job. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ +export interface ScenesCreateSatelliteDataIngestionJob202Response extends HttpResponse { + status: "202"; + body: SatelliteDataIngestionJobOutput; +} + +/** + * Create a satellite data ingestion job. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface ScenesCreateSatelliteDataIngestionJobdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Get a satellite data ingestion job. */ +/** + * Get details of a satellite data ingestion job. + * + * + */ export interface ScenesGetSatelliteDataIngestionJobDetails200Response extends HttpResponse { status: "200"; - body: SatelliteDataIngestionJob; + body: SatelliteDataIngestionJobOutput; } -/** Get a satellite data ingestion job. */ +/** + * Get details of a satellite data ingestion job. + * + * + */ export interface ScenesGetSatelliteDataIngestionJobDetailsdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Downloads and returns file stream as response for the given input filePath. */ +/** + * Return scenes as a file stream for a given input filePath. + * + * + */ export interface ScenesDownload200Response extends HttpResponse { status: "200"; + /** Value may contain any sequence of octets */ + body: Uint8Array; } -/** Downloads and returns file stream as response for the given input filePath. */ +/** + * Return scenes as a file stream for a given input filePath. + * + * + */ export interface ScenesDownloaddefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of seasonal field resources under a particular farmer. */ +/** + * Get a paginated list of seasonal field resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface SeasonalFieldsListByFarmerId200Response extends HttpResponse { status: "200"; - body: SeasonalFieldListResponse; + body: SeasonalFieldListResponseOutput; } -/** Returns a paginated list of seasonal field resources under a particular farmer. */ +/** + * Get a paginated list of seasonal field resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface SeasonalFieldsListByFarmerIddefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of seasonal field resources across all farmers. */ +/** + * Get a paginated list of seasonal field resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface SeasonalFieldsList200Response extends HttpResponse { status: "200"; - body: SeasonalFieldListResponse; + body: SeasonalFieldListResponseOutput; } -/** Returns a paginated list of seasonal field resources across all farmers. */ +/** + * Get a paginated list of seasonal field resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface SeasonalFieldsListdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Gets a specified seasonal field resource under a particular farmer. */ +/** + * Get a specified seasonal field resource for a given farmer. + * + * + */ export interface SeasonalFieldsGet200Response extends HttpResponse { status: "200"; - body: SeasonalField; + body: SeasonalFieldOutput; } -/** Gets a specified seasonal field resource under a particular farmer. */ +/** + * Get a specified seasonal field resource for a given farmer. + * + * + */ export interface SeasonalFieldsGetdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Creates or Updates a seasonal field resource under a particular farmer. */ + body: ErrorResponseOutput; +} + +/** + * Create or update a seasonal field resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface SeasonalFieldsCreateOrUpdate200Response extends HttpResponse { status: "200"; - body: SeasonalField; -} - -/** Creates or Updates a seasonal field resource under a particular farmer. */ + body: SeasonalFieldOutput; +} + +/** + * Create or update a seasonal field resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface SeasonalFieldsCreateOrUpdate201Response extends HttpResponse { status: "201"; - body: SeasonalField; -} - -/** Creates or Updates a seasonal field resource under a particular farmer. */ + body: SeasonalFieldOutput; +} + +/** + * Create or update a seasonal field resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface SeasonalFieldsCreateOrUpdatedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Deletes a specified seasonal-field resource under a particular farmer. */ +/** + * Delete a specified seasonal field resource for a given farmer. It can only be deleted if it has no linked attachments or boundaries. + * + * + */ export interface SeasonalFieldsDelete204Response extends HttpResponse { status: "204"; + body: Record; } -/** Deletes a specified seasonal-field resource under a particular farmer. */ +/** + * Delete a specified seasonal field resource for a given farmer. It can only be deleted if it has no linked attachments or boundaries. + * + * + */ export interface SeasonalFieldsDeletedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Get cascade delete job for specified seasonal field. */ +/** + * Get details of cascade delete job for a specified seasonal field. + * + * + */ export interface SeasonalFieldsGetCascadeDeleteJobDetails200Response extends HttpResponse { status: "200"; - body: CascadeDeleteJob; + body: CascadeDeleteJobOutput; } -/** Get cascade delete job for specified seasonal field. */ +/** + * Get details of cascade delete job for a specified seasonal field. + * + * + */ export interface SeasonalFieldsGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Create a cascade delete job for specified seasonal field. */ +/** + * Create a cascade delete job for a specified seasonal field. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ export interface SeasonalFieldsCreateCascadeDeleteJob202Response extends HttpResponse { status: "202"; - body: CascadeDeleteJob; -} - -/** Create a cascade delete job for specified seasonal field. */ + body: CascadeDeleteJobOutput; +} + +/** + * Create a cascade delete job for a specified seasonal field. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ export interface SeasonalFieldsCreateCascadeDeleteJobdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of season resources. */ +/** + * Get a paginated list of season resources. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface SeasonsList200Response extends HttpResponse { status: "200"; - body: SeasonListResponse; + body: SeasonListResponseOutput; } -/** Returns a paginated list of season resources. */ +/** + * Get a paginated list of season resources. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface SeasonsListdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Gets a specified season resource. */ +/** + * Get a specified season resource. + * + * + */ export interface SeasonsGet200Response extends HttpResponse { status: "200"; - body: Season; + body: SeasonOutput; } -/** Gets a specified season resource. */ +/** + * Get a specified season resource. + * + * + */ export interface SeasonsGetdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Creates or updates a season resource. */ + body: ErrorResponseOutput; +} + +/** + * Create or update a season resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface SeasonsCreateOrUpdate200Response extends HttpResponse { status: "200"; - body: Season; -} - -/** Creates or updates a season resource. */ + body: SeasonOutput; +} + +/** + * Create or update a season resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface SeasonsCreateOrUpdate201Response extends HttpResponse { status: "201"; - body: Season; -} - -/** Creates or updates a season resource. */ + body: SeasonOutput; +} + +/** + * Create or update a season resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface SeasonsCreateOrUpdatedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Deletes a specified season resource. */ +/** + * Delete a specified season resource. + * + * + */ export interface SeasonsDelete204Response extends HttpResponse { status: "204"; + body: Record; } -/** Deletes a specified season resource. */ +/** + * Delete a specified season resource. + * + * + */ export interface SeasonsDeletedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of tillage data resources under a particular farm. */ +/** + * Get a paginated list of tillage data resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface TillageDataListByFarmerId200Response extends HttpResponse { status: "200"; - body: TillageDataListResponse; + body: TillageDataListResponseOutput; } -/** Returns a paginated list of tillage data resources under a particular farm. */ +/** + * Get a paginated list of tillage data resources for a given farmer and search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface TillageDataListByFarmerIddefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Returns a paginated list of tillage data resources across all farmers. */ +/** + * Get a paginated list of tillage data resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface TillageDataList200Response extends HttpResponse { status: "200"; - body: TillageDataListResponse; + body: TillageDataListResponseOutput; } -/** Returns a paginated list of tillage data resources across all farmers. */ +/** + * Get a paginated list of tillage data resources across all the farmers for a given search criteria. + * + * +###### Note: + * 1. This API does a serial search of the database for the given search criteria. If the farmer Id is available, it is strongly recommended to use **‘List by Farmer Id’** API as it is performant. + * 2. Users will get paginated response with each page containing a link to the next page. Few pages may have **no items (zero results)**. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * + * + */ export interface TillageDataListdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Get a specified tillage data resource under a particular farmer. */ +/** + * Get a specified tillage data resource for a given farmer. + * + * + */ export interface TillageDataGet200Response extends HttpResponse { status: "200"; - body: TillageData; + body: TillageDataOutput; } -/** Get a specified tillage data resource under a particular farmer. */ +/** + * Get a specified tillage data resource for a given farmer. + * + * + */ export interface TillageDataGetdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Creates or updates an tillage data resource under a particular farmer. */ + body: ErrorResponseOutput; +} + +/** + * Create or update a tillage data resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface TillageDataCreateOrUpdate200Response extends HttpResponse { status: "200"; - body: TillageData; -} - -/** Creates or updates an tillage data resource under a particular farmer. */ + body: TillageDataOutput; +} + +/** + * Create or update a tillage data resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface TillageDataCreateOrUpdate201Response extends HttpResponse { status: "201"; - body: TillageData; -} - -/** Creates or updates an tillage data resource under a particular farmer. */ + body: TillageDataOutput; +} + +/** + * Create or update a tillage data resource for a given farmer. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/merge-patch+json'**. + * 2. 'Id' of a resource can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of an ‘Id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface TillageDataCreateOrUpdatedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Deletes a specified tillage data resource under a particular farmer. */ +/** + * Delete a specified tillage data resource for a given farmer. + * + * + */ export interface TillageDataDelete204Response extends HttpResponse { status: "204"; + body: Record; } -/** Deletes a specified tillage data resource under a particular farmer. */ +/** + * Delete a specified tillage data resource for a given farmer. + * + * + */ export interface TillageDataDeletedefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; +} + +/** + * Get details of a cascade delete job for tillage data resource. + * + * + */ +export interface TillageDataGetCascadeDeleteJobDetails200Response extends HttpResponse { + status: "200"; + body: CascadeDeleteJobOutput; +} + +/** + * Get details of a cascade delete job for tillage data resource. + * + * + */ +export interface TillageDataGetCascadeDeleteJobDetailsdefaultResponse extends HttpResponse { + status: "500"; + body: ErrorResponseOutput; } -/** Returns a paginated list of weather data. */ +/** + * Create cascade delete job for tillage data resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ +export interface TillageDataCreateCascadeDeleteJob202Response extends HttpResponse { + status: "202"; + body: CascadeDeleteJobOutput; +} + +/** + * Create cascade delete job for tillage data resource. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * + * + */ +export interface TillageDataCreateCascadeDeleteJobdefaultResponse extends HttpResponse { + status: "500"; + body: ErrorResponseOutput; +} + +/** + * Get a paginated list of weather data resources for a given search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * 2. This API will retrieve weather data present in the FarmBeats datastore and does not ingest new data. Example: a user has ingested historical weather data from 1st of Jan 2019 to 30th of June 2019. However, using the current API, the user has asked for historical data from 1st of Jan 2019 to 31st of December 2019. In such a case, only data for the first 6 months is returned to the user. + * + * + */ export interface WeatherList200Response extends HttpResponse { status: "200"; - body: WeatherDataListResponse; + body: WeatherDataListResponseOutput; } -/** Returns a paginated list of weather data. */ +/** + * Get a paginated list of weather data resources for a given search criteria. + * + * + * ###### Note: + * 1. Users will get paginated response with each page containing a link to the next page. Users are expected to iterate over all the pages using ‘nextLink’. The search comes to an end when ‘nextLink’ is null. + * 2. This API will retrieve weather data present in the FarmBeats datastore and does not ingest new data. Example: a user has ingested historical weather data from 1st of Jan 2019 to 30th of June 2019. However, using the current API, the user has asked for historical data from 1st of Jan 2019 to 31st of December 2019. In such a case, only data for the first 6 months is returned to the user. + * + * + */ export interface WeatherListdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Get weather ingestion job. */ +/** + * Get details of a weather data ingestion job. + * + * + */ export interface WeatherGetDataIngestionJobDetails200Response extends HttpResponse { status: "200"; - body: WeatherDataIngestionJob; + body: WeatherDataIngestionJobOutput; } -/** Get weather ingestion job. */ +/** + * Get details of a weather data ingestion job. + * + * + */ export interface WeatherGetDataIngestionJobDetailsdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Create a weather data ingestion job. */ + body: ErrorResponseOutput; +} + +/** + * Create a weather data ingestion job. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface WeatherCreateDataIngestionJob202Response extends HttpResponse { status: "202"; - body: WeatherDataIngestionJob; -} - -/** Create a weather data ingestion job. */ + body: WeatherDataIngestionJobOutput; +} + +/** + * Create a weather data ingestion job. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface WeatherCreateDataIngestionJobdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } -/** Get weather data delete job. */ +/** + * Get details of a weather data delete job. + * + * + */ export interface WeatherGetDataDeleteJobDetails200Response extends HttpResponse { status: "200"; - body: WeatherDataDeleteJob; + body: WeatherDataDeleteJobOutput; } -/** Get weather data delete job. */ +/** + * Get details of a weather data delete job. + * + * + */ export interface WeatherGetDataDeleteJobDetailsdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; -} - -/** Create a weather data delete job. */ + body: ErrorResponseOutput; +} + +/** + * Create a weather data delete job. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface WeatherCreateDataDeleteJob202Response extends HttpResponse { status: "202"; - body: WeatherDataDeleteJob; -} - -/** Create a weather data delete job. */ + body: WeatherDataDeleteJobOutput; +} + +/** + * Create a weather data delete job. + * + * +###### Note: + * +1. The **‘contentType’** in the request header should be **'application/json'**. + * 2. ‘Job id’ can only contain alphanumeric characters, '-', '_', '~' or '.', and must begin and end with an alphanumeric character. Minimum length of a ‘Job id’ is 2 characters and maximum length is 50 characters. + * 3. 'Key' and 'value' in 'Properties' can have a maximum of 50 and 150 characters respectively. + * + * + */ export interface WeatherCreateDataDeleteJobdefaultResponse extends HttpResponse { status: "500"; - body: ErrorResponse; + body: ErrorResponseOutput; } diff --git a/sdk/agrifood/agrifood-farming-rest/swagger/README.md b/sdk/agrifood/agrifood-farming-rest/swagger/README.md index c681ac492bd6..7b7a18666266 100644 --- a/sdk/agrifood/agrifood-farming-rest/swagger/README.md +++ b/sdk/agrifood/agrifood-farming-rest/swagger/README.md @@ -12,11 +12,19 @@ generate-metadata: false license-header: MICROSOFT_MIT_NO_VERSION output-folder: ../ source-code-folder-path: ./src -input-file: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/agfood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json +input-file: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/7cc0a47e7808f3247c71cda25b7c1da8503272ba/specification/agrifood/data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json package-version: 1.0.0-beta.2 rest-level-client: true add-credentials: true credential-scopes: https://farmbeats.azure.net/.default use-extension: - "@autorest/typescript": "~/Microsoft/autorest.typescript" + "@autorest/typescript": "dev" ``` + +```yaml +directive: + - from: swagger-document + where: $.definitions.Farmer + transform: > + $.properties.properties["additionalProperties"] = {}; +``` \ No newline at end of file diff --git a/sdk/agrifood/agrifood-farming-rest/test/public/farmHeirarchy.spec.ts b/sdk/agrifood/agrifood-farming-rest/test/public/farmHeirarchy.spec.ts index 64c49963fcc5..95b8af53bf24 100644 --- a/sdk/agrifood/agrifood-farming-rest/test/public/farmHeirarchy.spec.ts +++ b/sdk/agrifood/agrifood-farming-rest/test/public/farmHeirarchy.spec.ts @@ -1,6 +1,6 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT license. -import { FarmBeatsRestClient, getPoller } from "../../src"; +import { FarmBeatsRestClient, getLongRunningPoller } from "../../src"; import { Recorder } from "@azure-tools/test-recorder"; import { isNode } from "@azure/core-util"; @@ -108,7 +108,7 @@ describe("Farmer Operations", () => { throw initialResponse.body.error; } - const poller = getPoller(client, initialResponse); + const poller = getLongRunningPoller(client, initialResponse); const result = await poller.pollUntilDone(); assert.equal(result.body.boundaryId, boundaryId); diff --git a/sdk/agrifood/agrifood-farming-rest/test/public/utils/recordedClient.ts b/sdk/agrifood/agrifood-farming-rest/test/public/utils/recordedClient.ts index 590991cdc5ce..467769305727 100644 --- a/sdk/agrifood/agrifood-farming-rest/test/public/utils/recordedClient.ts +++ b/sdk/agrifood/agrifood-farming-rest/test/public/utils/recordedClient.ts @@ -5,7 +5,7 @@ import { Context } from "mocha"; -import { env, Recorder, record, RecorderEnvironmentSetup } from "@azure-tools/test-recorder"; +import { Recorder, RecorderEnvironmentSetup, env, record } from "@azure-tools/test-recorder"; import FarmBeats, { FarmBeatsRestClient } from "../../../src"; import { ClientSecretCredential } from "@azure/identity"; diff --git a/sdk/core/ci.yml b/sdk/core/ci.yml index 47636ceccb28..0f0b8f5e85fc 100644 --- a/sdk/core/ci.yml +++ b/sdk/core/ci.yml @@ -48,10 +48,6 @@ extends: safeName: azurecoreclient - name: azure-rest-core-client safeName: azurerestcoreclient - - name: azure-rest-core-client-paging - safeName: azurerestcoreclientpaging - - name: azure-rest-core-client-lro - safeName: azurerestcoreclientlro - name: azure-core-crypto safeName: azurecorecrypto - name: azure-core-http diff --git a/sdk/core/core-client-lro-rest/CHANGELOG.md b/sdk/core/core-client-lro-rest/CHANGELOG.md deleted file mode 100644 index d693a6aaba0b..000000000000 --- a/sdk/core/core-client-lro-rest/CHANGELOG.md +++ /dev/null @@ -1,5 +0,0 @@ -# Release History - -## 1.0.0-beta.1 (2021-08-10) - -- First release of package, see README.md for details. diff --git a/sdk/core/core-client-lro-rest/LICENSE b/sdk/core/core-client-lro-rest/LICENSE deleted file mode 100644 index 2d3163745319..000000000000 --- a/sdk/core/core-client-lro-rest/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2021 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. diff --git a/sdk/core/core-client-lro-rest/README.md b/sdk/core/core-client-lro-rest/README.md deleted file mode 100644 index 97ff534f79bd..000000000000 --- a/sdk/core/core-client-lro-rest/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# Azure Rest Core LRO library for JavaScript - -This library is primarily intended to be used in code generated by [AutoRest](https://github.com/Azure/Autorest) and [`autorest.typescript`](https://github.com/Azure/autorest.typescript). Specifically for rest level clients, as a helper to handle long running operations. This package implements support for Autorest `x-ms-long-running-operation` specification. - -## Getting started - -### Requirements - -- [Node.js](https://nodejs.org) LTS - -### Installation - -This package is primarily used in generated code and not meant to be consumed directly by end users. - -## Key concepts - -### Helper function `getLongRunningPoller` - -## Examples - -Examples can be found in the `samples` folder. - -## Next steps - -You can build and run the tests locally by executing `rushx test`. Explore the `test` folder to see advanced usage and behavior of the public classes. - -Learn more about [AutoRest](https://github.com/Azure/autorest) and the [autorest.typescript extension](https://github.com/Azure/autorest.typescript) for generating a compatible client on top of this package. - -## Troubleshooting - -If you run into issues while using this library, please feel free to [file an issue](https://github.com/Azure/azure-sdk-for-js/issues/new). - -## Contributing - -If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code. - -![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fcore-rest%2Fcore-client%2FREADME.png) diff --git a/sdk/core/core-client-lro-rest/api-extractor.json b/sdk/core/core-client-lro-rest/api-extractor.json deleted file mode 100644 index bd003f19ac86..000000000000 --- a/sdk/core/core-client-lro-rest/api-extractor.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", - "mainEntryPointFilePath": "types/latest/src/index.d.ts", - "docModel": { - "enabled": true - }, - "apiReport": { - "enabled": true, - "reportFolder": "./review" - }, - "dtsRollup": { - "enabled": true, - "untrimmedFilePath": "", - "publicTrimmedFilePath": "./types/latest/core-client-lro-rest.d.ts" - }, - "messages": { - "tsdocMessageReporting": { - "default": { - "logLevel": "none" - } - }, - "extractorMessageReporting": { - "ae-missing-release-tag": { - "logLevel": "none" - }, - "ae-unresolved-link": { - "logLevel": "none" - } - } - } -} diff --git a/sdk/core/core-client-lro-rest/karma.conf.js b/sdk/core/core-client-lro-rest/karma.conf.js deleted file mode 100644 index 005c7f1c5a55..000000000000 --- a/sdk/core/core-client-lro-rest/karma.conf.js +++ /dev/null @@ -1,121 +0,0 @@ -// https://github.com/karma-runner/karma-chrome-launcher -process.env.CHROME_BIN = require("puppeteer").executablePath(); - -module.exports = function (config) { - config.set({ - // base path that will be used to resolve all patterns (eg. files, exclude) - basePath: "./", - - // frameworks to use - // available frameworks: https://npmjs.org/browse/keyword/karma-adapter - frameworks: ["mocha"], - - plugins: [ - "karma-mocha", - "karma-mocha-reporter", - "karma-chrome-launcher", - "karma-edge-launcher", - "karma-firefox-launcher", - "karma-ie-launcher", - "karma-env-preprocessor", - "karma-coverage", - "karma-sourcemap-loader", - "karma-junit-reporter", - ], - - // list of files / patterns to load in the browser - files: [ - // Uncomment the cdn link below for the polyfill service to support IE11 missing features - // Promise,String.prototype.startsWith,String.prototype.endsWith,String.prototype.repeat,String.prototype.includes,Array.prototype.includes,Object.keys - // "https://cdn.polyfill.io/v2/polyfill.js?features=Symbol,Promise,String.prototype.startsWith,String.prototype.endsWith,String.prototype.repeat,String.prototype.includes,Array.prototype.includes,Object.keys|always", - "dist-test/index.browser.js", - ], - - // list of files / patterns to exclude - exclude: [], - - // preprocess matching files before serving them to the browser - // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor - preprocessors: { - "**/*.js": ["sourcemap", "env"], - // IMPORTANT: COMMENT following line if you want to debug in your browsers!! - // Preprocess source file to calculate code coverage, however this will make source file unreadable - //"dist-test/index.browser.js": ["coverage"] - }, - - // inject following environment values into browser testing with window.__env__ - // environment values MUST be exported or set with same console running "karma start" - // https://www.npmjs.com/package/karma-env-preprocessor - // EXAMPLE: envPreprocessor: ["ACCOUNT_NAME", "ACCOUNT_SAS"], - - // test results reporter to use - // possible values: 'dots', 'progress' - // available reporters: https://npmjs.org/browse/keyword/karma-reporter - reporters: ["mocha", "coverage", "junit"], - - coverageReporter: { - // specify a common output directory - dir: "coverage-browser/", - reporters: [ - { type: "json", subdir: ".", file: "coverage.json" }, - { type: "lcovonly", subdir: ".", file: "lcov.info" }, - { type: "html", subdir: "html" }, - { type: "cobertura", subdir: ".", file: "cobertura-coverage.xml" }, - ], - }, - - junitReporter: { - outputDir: "", // results will be saved as $outputDir/$browserName.xml - outputFile: "test-results.browser.xml", // if included, results will be saved as $outputDir/$browserName/$outputFile - suite: "", // suite will become the package name attribute in xml testsuite element - useBrowserName: false, // add browser name to report and classes names - nameFormatter: undefined, // function (browser, result) to customize the name attribute in xml testcase element - classNameFormatter: undefined, // function (browser, result) to customize the classname attribute in xml testcase element - properties: {}, // key value pair of properties to add to the section of the report - }, - - // web server port - port: 9876, - - // enable / disable colors in the output (reporters and logs) - colors: true, - - // level of logging - // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG - logLevel: config.LOG_INFO, - - // enable / disable watching file and executing tests whenever any file changes - autoWatch: false, - - // start these browsers - // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher - // 'ChromeHeadless', 'Chrome', 'Firefox', 'Edge', 'IE' - browsers: ["ChromeHeadlessNoSandbox"], - customLaunchers: { - ChromeHeadlessNoSandbox: { - base: "ChromeHeadless", - flags: ["--no-sandbox"], - }, - }, - - // Continuous Integration mode - // if true, Karma captures browsers, runs the tests and exits - singleRun: true, - - // Concurrency level - // how many browser should be started simultaneous - concurrency: 1, - - browserNoActivityTimeout: 600000, - browserDisconnectTimeout: 10000, - browserDisconnectTolerance: 3, - - client: { - mocha: { - // change Karma's debug.html to the mocha web reporter - reporter: "html", - timeout: "600000", - }, - }, - }); -}; diff --git a/sdk/core/core-client-lro-rest/package.json b/sdk/core/core-client-lro-rest/package.json deleted file mode 100644 index 61e82415b7a4..000000000000 --- a/sdk/core/core-client-lro-rest/package.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "name": "@azure-rest/core-client-lro", - "version": "1.0.0-beta.1", - "description": "A helper library which implements Autorest x-ms-long-running-operation spec to handle long running operations.", - "sdk-type": "client", - "main": "dist/index.js", - "module": "dist-esm/src/index.js", - "types": "types/latest/core-client-lro-rest.d.ts", - "browser": { - "./dist-esm/test/utils/url.js": "./dist-esm/test/utils/url.browser.js" - }, - "scripts": { - "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit", - "build:samples": "echo Obsolete", - "build:test": "tsc -p . && rollup -c 2>&1", - "build": "npm run clean && tsc -p . && rollup -c 2>&1 && api-extractor run --local", - "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"", - "clean": "rimraf dist dist-* temp types *.tgz *.log", - "execute:samples": "echo skipped", - "extract-api": "tsc -p . && api-extractor run --local", - "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"", - "integration-test:browser": "echo skipped", - "integration-test:node": "echo skipped", - "integration-test": "npm run integration-test:node && npm run integration-test:browser", - "lint:fix": "eslint package.json api-extractor.json src test --ext .ts --fix --fix-type [problem,suggestion]", - "lint": "eslint package.json api-extractor.json src test --ext .ts", - "pack": "npm pack 2>&1", - "test:browser": "npm run clean && npm run build:test && npm run unit-test:browser && npm run integration-test:browser", - "test:node": "npm run clean && tsc -p . && npm run unit-test:node && npm run integration-test:node", - "test": "npm run clean && tsc -p . && npm run unit-test:node && rollup -c 2>&1 && npm run unit-test:browser && npm run integration-test", - "unit-test:browser": "karma start --single-run", - "unit-test:node": "mocha -r esm -r ts-node/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 1200000 --full-trace --exclude \"test/**/browser/*.spec.ts\" \"test/**/*.spec.ts\"", - "unit-test": "npm run unit-test:node && npm run unit-test:browser" - }, - "files": [ - "dist/", - "dist-esm/src/", - "types/latest/core-client-lro-rest.d.ts", - "README.md", - "LICENSE" - ], - "repository": "github:Azure/azure-sdk-for-js", - "keywords": [ - "azure", - "cloud" - ], - "author": "Microsoft Corporation", - "license": "MIT", - "bugs": { - "url": "https://github.com/Azure/azure-sdk-for-js/issues" - }, - "engines": { - "node": ">=12.0.0" - }, - "homepage": "https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-client-lro-rest/README.md", - "sideEffects": false, - "prettier": "@azure/eslint-plugin-azure-sdk/prettier.json", - "dependencies": { - "@azure/core-lro": "^2.2.0", - "@azure-rest/core-client": "1.0.0-beta.7", - "tslib": "^2.2.0" - }, - "devDependencies": { - "@azure/core-rest-pipeline": "^1.1.0", - "@azure/dev-tool": "^1.0.0", - "@azure/eslint-plugin-azure-sdk": "^3.0.0", - "@microsoft/api-extractor": "^7.18.11", - "@types/chai": "^4.1.6", - "@types/mocha": "^7.0.2", - "@types/node": "^12.0.0", - "chai": "^4.2.0", - "cross-env": "^7.0.2", - "eslint": "^7.15.0", - "inherits": "^2.0.3", - "karma-chrome-launcher": "^3.0.0", - "karma-coverage": "^2.0.0", - "karma-edge-launcher": "^0.4.2", - "karma-env-preprocessor": "^0.1.1", - "karma-firefox-launcher": "^1.1.0", - "karma-ie-launcher": "^1.0.0", - "karma-junit-reporter": "^2.0.1", - "karma-mocha-reporter": "^2.2.5", - "karma-mocha": "^2.0.1", - "karma-sourcemap-loader": "^0.3.8", - "karma": "^6.2.0", - "mocha-junit-reporter": "^2.0.0", - "mocha": "^7.1.1", - "prettier": "^2.5.1", - "rimraf": "^3.0.0", - "rollup": "^1.16.3", - "sinon": "^9.0.2", - "typescript": "~4.2.0", - "util": "^0.12.1" - } -} diff --git a/sdk/core/core-client-lro-rest/review/core-client-lro.api.md b/sdk/core/core-client-lro-rest/review/core-client-lro.api.md deleted file mode 100644 index 33f17878faca..000000000000 --- a/sdk/core/core-client-lro-rest/review/core-client-lro.api.md +++ /dev/null @@ -1,32 +0,0 @@ -## API Report File for "@azure-rest/core-client-lro" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { Client } from '@azure-rest/core-client'; -import { HttpResponse } from '@azure-rest/core-client'; -import { LroEngineOptions } from '@azure/core-lro'; -import { PollerLike } from '@azure/core-lro'; -import { PollOperationState } from '@azure/core-lro'; - -// @public -export function getLongRunningPoller(client: Client, initialResponse: TResult): PollerLike, TResult>; - -// @public -export function getLongRunningPoller(client: Client, initialResponse: TResult, pollerOptions: LroEngineOptions>): PollerLike, TResult>; - -export { LroEngineOptions } - -export { PollerLike } - -// @public -export interface PollerOptions { - resumeFrom?: string; - updateIntervalInMs?: number; -} - -export { PollOperationState } - - -``` diff --git a/sdk/core/core-client-lro-rest/rollup.config.js b/sdk/core/core-client-lro-rest/rollup.config.js deleted file mode 100644 index 26e83ddfafa4..000000000000 --- a/sdk/core/core-client-lro-rest/rollup.config.js +++ /dev/null @@ -1,2 +0,0 @@ -import { makeConfig } from "@azure/dev-tool/shared-config/rollup"; -export default makeConfig(require("./package.json")); diff --git a/sdk/core/core-client-lro-rest/src/index.ts b/sdk/core/core-client-lro-rest/src/index.ts deleted file mode 100644 index 2db330662737..000000000000 --- a/sdk/core/core-client-lro-rest/src/index.ts +++ /dev/null @@ -1,10 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -/** - * A helper library which implements Autorest x-ms-long-running-operation spec for long-running operations - * - * @packageDocumentation - */ -export { getLongRunningPoller, PollerOptions } from "./getLongRunningHelper"; -export { PollerLike, PollOperationState, LroEngineOptions } from "@azure/core-lro"; diff --git a/sdk/core/core-client-lro-rest/test/longRunning.spec.ts b/sdk/core/core-client-lro-rest/test/longRunning.spec.ts deleted file mode 100644 index 37b00cc41856..000000000000 --- a/sdk/core/core-client-lro-rest/test/longRunning.spec.ts +++ /dev/null @@ -1,289 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -import { assert } from "chai"; -import { Client, getClient } from "@azure-rest/core-client"; -import { getLongRunningPoller } from "../src/getLongRunningHelper"; -import { createHttpHeaders, HttpHeaders, HttpMethods } from "@azure/core-rest-pipeline"; -import { URL } from "./utils/url"; - -describe("LRO helper", () => { - let client: Client; - - beforeEach(() => { - client = getClient("http://localhost:3000", { allowInsecureConnection: true }); - client.pipeline.getOrderedPolicies().forEach(({ name }) => { - client.pipeline.removePolicy({ name }); - }); - }); - - it("LROs_put200Succeeded", async () => { - // Long running put request, service returns a 200 to the initial request, with an entity that contains ProvisioningState=’Succeeded’. - const expectedBody = { properties: { provisioningState: "Succeeded" }, id: "100", name: "foo" }; - mockResponse(client, [ - { - path: "/lro/put/200/succeeded", - method: "PUT", - response: { status: 200, body: expectedBody }, - }, - ]); - const initialResponse = await client.pathUnchecked("/lro/put/200/succeeded").put(); - const poller = getLongRunningPoller(client, initialResponse); - const result = await poller.pollUntilDone(); - - assert.equal(result.status, "200"); - assert.deepEqual(result.body, expectedBody); - }); - - it("LROs_put201Succeeded", async () => { - // Long running put request, service returns a 201 to the initial request, with an entity that contains ProvisioningState=’Succeeded’. - const expectedBody = { properties: { provisioningState: "Succeeded" }, id: "100", name: "foo" }; - mockResponse(client, [ - { - path: "/lro/put/201/succeeded", - method: "PUT", - response: { status: 201, body: expectedBody }, - }, - ]); - const initialResponse = await client.pathUnchecked("/lro/put/201/succeeded").put(); - const poller = getLongRunningPoller(client, initialResponse); - const result = await poller.pollUntilDone(); - - assert.equal(result.status, "201"); - assert.deepEqual(result.body, expectedBody); - }); - - it("LROs_post202List", async () => { - // Long running put request, service returns a 202 with empty body to first request, returns a 200 with body [{ 'id': '100', 'name': 'foo' }]. - const expectedBody = [{ id: "100", name: "foo" }]; - mockResponse(client, [ - { - path: "/lro/list", - method: "POST", - response: { - status: 202, - headers: createHttpHeaders({ - // Set the location for polling - "azure-asyncoperation": "http://localhost:3000/lro/list/pollingGet", - // Set location for getting the result once polling finished - location: "http://localhost:3000/lro/list/finalGet", - }), - }, - }, - { - path: "/lro/list/pollingGet", - method: "GET", - response: { status: 200, body: { status: "Succeeded" } }, - }, - { path: "/lro/list/finalGet", method: "GET", response: { status: 200, body: expectedBody } }, - ]); - const initialResponse = await client.pathUnchecked("/lro/list").post(); - const poller = getLongRunningPoller(client, initialResponse, { intervalInMs: 1 }); - const result = await poller.pollUntilDone(); - - assert.equal(result.status, "200"); - assert.deepEqual(result.body, expectedBody); - }); - - it("LROs_put200SucceededNoState", async () => { - // Long running put request, service returns a 200 to the initial request, with an entity that does not contain ProvisioningState=’Succeeded’. - const expectedBody = { id: "100", name: "foo" }; - mockResponse(client, [ - { - path: "/lro/put/200/succeeded/nostate", - method: "PUT", - response: { status: 200, body: expectedBody }, - }, - ]); - const initialResponse = await client.pathUnchecked("/lro/put/200/succeeded/nostate").put(); - const poller = getLongRunningPoller(client, initialResponse); - const result = await poller.pollUntilDone(); - - assert.equal(result.status, "200"); - assert.deepEqual(result.body, expectedBody); - }); - - it("LROs_put200UpdatingSucceeded200", async () => { - // Long running put request, service returns a 201 to the initial request, with an entity that contains ProvisioningState=’Updating’. Polls return this value until the last poll returns a ‘200’ with ProvisioningState=’Succeeded’ - const expectedBody = { properties: { provisioningState: "Succeeded" }, id: "100", name: "foo" }; - mockResponse(client, [ - { - path: "/lro/put/200/updating/succeeded/200", - method: "PUT", - response: { - status: 200, - body: { properties: { provisioningState: "Updating" }, id: "100", name: "foo" }, - }, - }, - { - path: "/lro/put/200/updating/succeeded/200", - method: "GET", - response: { status: 200, body: expectedBody }, - }, - ]); - const initialResponse = await client.pathUnchecked("/lro/put/200/updating/succeeded/200").put(); - const poller = getLongRunningPoller(client, initialResponse, { intervalInMs: 1 }); - const result = await poller.pollUntilDone(); - - assert.equal(result.status, "200"); - assert.deepEqual(result.body, expectedBody); - }); - - it("LROs_put201CreatingFailed200", async () => { - // Long running put request, service returns a 201 to the initial request, with an entity that contains ProvisioningState=’Created’. Polls return this value until the last poll returns a ‘200’ with ProvisioningState=’Failed’ const expectedBody = { "properties": { "provisioningState": "Succeeded"}, "id": "100", "name": "foo" } - const expectedBody = { properties: { provisioningState: "Failed" }, id: "100", name: "foo" }; - - mockResponse(client, [ - { - path: "/lro/put/201/created/failed/200", - method: "PUT", - response: { - status: 201, - body: { properties: { provisioningState: "Created" }, id: "100", name: "foo" }, - }, - }, - { - path: "/lro/put/201/created/failed/200", - method: "GET", - response: { status: 200, body: expectedBody }, - }, - ]); - const initialResponse = await client.pathUnchecked("/lro/put/201/created/failed/200").put(); - const poller = getLongRunningPoller(client, initialResponse, { intervalInMs: 1 }); - try { - await poller.pollUntilDone(); - assert.fail("Expected exception"); - } catch (error) { - assert.equal( - error.message, - "The long running operation has failed. The provisioning state: failed." - ); - } - }); - - it("LROs_put200Acceptedcanceled200", async () => { - // Long running put request, service returns a 201 to the initial request, with an entity that contains ProvisioningState=’Created’. Polls return this value until the last poll returns a ‘200’ with ProvisioningState=’Failed’ const expectedBody = { "properties": { "provisioningState": "Succeeded"}, "id": "100", "name": "foo" } - const expectedBody = { properties: { provisioningState: "canceled" }, id: "100", name: "foo" }; - - mockResponse(client, [ - { - path: "/lro/put/200/accepted/canceled/200", - method: "PUT", - response: { - status: 200, - body: { properties: { provisioningState: "Accepted" }, id: "100", name: "foo" }, - }, - }, - { - path: "/lro/put/200/accepted/canceled/200", - method: "GET", - response: { status: 200, body: expectedBody }, - }, - ]); - const initialResponse = await client.pathUnchecked("/lro/put/200/accepted/canceled/200").put(); - const poller = getLongRunningPoller(client, initialResponse, { intervalInMs: 1 }); - try { - await poller.pollUntilDone(); - assert.fail("Expected exception"); - } catch (error) { - assert.equal( - error.message, - "The long running operation has failed. The provisioning state: canceled." - ); - } - }); - - it("LROPutNoHeaderInRetry", async () => { - // Long running put request, service returns a 201 to the initial request, with an entity that contains ProvisioningState=’Created’. Polls return this value until the last poll returns a ‘200’ with ProvisioningState=’Failed’ const expectedBody = { "properties": { "provisioningState": "Succeeded"}, "id": "100", "name": "foo" } - const expectedBody = { properties: { provisioningState: "Succeeded" }, id: "100", name: "foo" }; - - mockResponse(client, [ - { - path: "/lro/put/noheader/202/200", - method: "PUT", - response: { - status: 200, - body: { properties: { provisioningState: "Accepted" }, id: "100", name: "foo" }, - headers: createHttpHeaders({ - location: "http://localhost:3000/lro/put/noheader/operationresults", - }), - }, - }, - { path: "/lro/put/noheader/operationresults", method: "GET", response: { status: 202 } }, - { - path: "/lro/put/noheader/operationresults", - method: "GET", - response: { status: 200, body: expectedBody }, - }, - ]); - const initialResponse = await client.pathUnchecked("/lro/put/noheader/202/200").put(); - const poller = getLongRunningPoller(client, initialResponse, { intervalInMs: 1 }); - const result = await poller.pollUntilDone(); - - assert.equal(result.status, "200"); - assert.deepEqual(result.body, expectedBody); - }); -}); - -interface MockResponse { - path: string; - method: HttpMethods; - response: { - status: number; - body?: any; - headers?: HttpHeaders; - }; -} - -/** - * Creates a pipeline with a mocked service call - * @param client - client to mock requests for - * @param response - Responses to return, the actual request url is matched to one of the paths in the responses and the defined object is returned. - * if no path matches a 404 error is returned - */ -function mockResponse(client: Client, responses: MockResponse[]) { - let count = 0; - - client.pipeline.addPolicy({ - name: "mockClient", - sendRequest: async (request, _next) => { - if (count < responses.length) { - count++; - } - - const path = new URL(request.url).pathname; - let responseIndex = -1; - - const response = responses.find((r, index) => { - const match = - r.path === path && r.method.toLocaleLowerCase() === request.method.toLocaleLowerCase(); - - if (match) { - responseIndex = index; - } - - return match; - }); - - if (!response) { - console.warn(`Didn't find a match for path ${path} and method: ${request.method}`); - return { - headers: createHttpHeaders(), - request, - status: 404, - }; - } - - const { body, status } = response.response; - const bodyAsText = JSON.stringify(body); - // remove the matched response from the list to avoid matching it again - responses.splice(responseIndex, 1); - return { - headers: response.response.headers ?? createHttpHeaders(), - request, - status, - bodyAsText, - }; - }, - }); -} diff --git a/sdk/core/core-client-lro-rest/test/utils/url.browser.ts b/sdk/core/core-client-lro-rest/test/utils/url.browser.ts deleted file mode 100644 index a6b3956caf41..000000000000 --- a/sdk/core/core-client-lro-rest/test/utils/url.browser.ts +++ /dev/null @@ -1,9 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -/// - -const url = URL; -const urlSearchParams = URLSearchParams; - -export { url as URL, urlSearchParams as URLSearchParams }; diff --git a/sdk/core/core-client-lro-rest/test/utils/url.ts b/sdk/core/core-client-lro-rest/test/utils/url.ts deleted file mode 100644 index 993e69798f9e..000000000000 --- a/sdk/core/core-client-lro-rest/test/utils/url.ts +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -export { URL, URLSearchParams } from "url"; diff --git a/sdk/core/core-client-lro-rest/tsconfig.json b/sdk/core/core-client-lro-rest/tsconfig.json deleted file mode 100644 index 82e643af7e8c..000000000000 --- a/sdk/core/core-client-lro-rest/tsconfig.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "extends": "../../../tsconfig.package", - "compilerOptions": { - "outDir": "./dist-esm", - "declarationDir": "./types/latest" - }, - "include": ["src/**/*.ts", "test/**/*.ts"] -} diff --git a/sdk/core/core-client-lro-rest/tsdoc.json b/sdk/core/core-client-lro-rest/tsdoc.json deleted file mode 100644 index 81c5a8a2aa2f..000000000000 --- a/sdk/core/core-client-lro-rest/tsdoc.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "extends": ["../../../tsdoc.json"] -} diff --git a/sdk/core/core-client-paging-rest/CHANGELOG.md b/sdk/core/core-client-paging-rest/CHANGELOG.md deleted file mode 100644 index c2c4c45ff2d7..000000000000 --- a/sdk/core/core-client-paging-rest/CHANGELOG.md +++ /dev/null @@ -1,17 +0,0 @@ -# Release History - -## 1.0.0-beta.2 (Unreleased) - -### Features Added - -### Breaking Changes - -### Bugs Fixed - -### Other Changes - -- Updates package to work with the react native bundler. Browser APIs may still need to be pollyfilled for this package to run in react native. [PR #17783](https://github.com/Azure/azure-sdk-for-js/pull/17783) - -## 1.0.0-beta.1 (2021-08-05) - -- First release of package, see README.md for details. diff --git a/sdk/core/core-client-paging-rest/LICENSE b/sdk/core/core-client-paging-rest/LICENSE deleted file mode 100644 index ea8fb1516028..000000000000 --- a/sdk/core/core-client-paging-rest/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2020 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. diff --git a/sdk/core/core-client-paging-rest/README.md b/sdk/core/core-client-paging-rest/README.md deleted file mode 100644 index 52ea1ec51d5c..000000000000 --- a/sdk/core/core-client-paging-rest/README.md +++ /dev/null @@ -1,112 +0,0 @@ -# Azure Rest Core Paging library for JavaScript - -This library is primarily intended to be used in code generated by [AutoRest](https://github.com/Azure/Autorest) and [`autorest.typescript`](https://github.com/Azure/autorest.typescript). Specifically for rest level clients, as a helper to handle Pageable operations. This package implements support for Autorest `x-ms-pageable` specification. - -## Getting started - -### Requirements - -- [Node.js](https://nodejs.org) LTS - -### Installation - -This package is primarily used in generated code and not meant to be consumed directly by end users. - -## Key concepts - -### Helper function `paginateResponse` - -Paginate response is a helper function to handle pagination for the user. Given a response that contains a body with a link to the next page and an array with the current page of results, this helper returns a PagedAsyncIterableIterator that can be used to get all the items or page by page. - -In order to provide better typings, the library that consumes `paginateResponse` can wrap it providing additional types. For example a code generator may consume and export in the following way - -#### Typescript - -```typescript -/** - * This is the wrapper function that would be exposed. It is hiding the Pagination Options because it can be - * obtained in the case of a generator from the Swagger definition or by a developer context knowledge in case of a - * hand written library. - */ -export function paginate( - client: Client, - initialResponse: TReturn -): PagedAsyncIterableIterator, PaginateReturn[]> { - return paginateResponse>(client, initialResponse, { - // For example these values could come from the swagger - itemName: "items", - nextLinkName: "continuationLink", - }); -} - -// Helper type to extract the type of an array -type GetArrayType = T extends Array ? TData : never; - -// Helper type to infer the Type of the paged elements from the response type -// This type will be generated based on the swagger information for x-ms-pageable -// specifically on the itemName property which indicates the property of the response -// where the page items are found. The default value is `value`. -// This type will allow us to provide strongly typed Iterator based on the response we get as second parameter -export type PaginateReturn = TResult extends { - body: { items: infer TPage }; -} - ? GetArrayType - : Array; - -// Usage -const client = Client("https://example.org", new DefaultAzureCredentials()); - -const response = client.path("/foo").get(); -const items = paginate(client, response); - -for await (const item of items) { - console.log(item.name); -} -``` - -#### JavaScript - -```javascript -/** - * This is the wrapper function that would be exposed. It is hiding the Pagination Options because it can be - * obtained in the case of a generator from the Swagger definition or by a developer context knowledge in case of a - * hand written library. - */ -export function paginate(client, initialResponse) { - return paginateResponse(client, initialResponse, { - // For example these values could come from the swagger - itemName: "items", - nextLinkName: "continuationLink", - }); -} - -// Usage -const client = Client("https://example.org", new DefaultAzureCredentials()); - -const response = client.path("/foo").get(); -const items = paginate(client, response); - -for await (const item of items) { - console.log(item.name); -} -``` - -## Examples - -Examples can be found in the `samples` folder. - -## Next steps - -You can build and run the tests locally by executing `rushx test`. Explore the `test` folder to see advanced usage and behavior of the public classes. - -Learn more about [AutoRest](https://github.com/Azure/autorest) and the [autorest.typescript extension](https://github.com/Azure/autorest.typescript) for generating a compatible client on top of this package. - -## Troubleshooting - -If you run into issues while using this library, please feel free to [file an issue](https://github.com/Azure/azure-sdk-for-js/issues/new). - -## Contributing - -If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code. - -![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fcore-rest%2Fcore-client%2FREADME.png) diff --git a/sdk/core/core-client-paging-rest/api-extractor.json b/sdk/core/core-client-paging-rest/api-extractor.json deleted file mode 100644 index 5f0bb62e9090..000000000000 --- a/sdk/core/core-client-paging-rest/api-extractor.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", - "mainEntryPointFilePath": "types/latest/src/index.d.ts", - "docModel": { - "enabled": true - }, - "apiReport": { - "enabled": true, - "reportFolder": "./review" - }, - "dtsRollup": { - "enabled": true, - "untrimmedFilePath": "", - "publicTrimmedFilePath": "./types/latest/core-client-paging-rest.d.ts" - }, - "messages": { - "tsdocMessageReporting": { - "default": { - "logLevel": "none" - } - }, - "extractorMessageReporting": { - "ae-missing-release-tag": { - "logLevel": "none" - }, - "ae-unresolved-link": { - "logLevel": "none" - } - } - } -} diff --git a/sdk/core/core-client-paging-rest/karma.conf.js b/sdk/core/core-client-paging-rest/karma.conf.js deleted file mode 100644 index 005c7f1c5a55..000000000000 --- a/sdk/core/core-client-paging-rest/karma.conf.js +++ /dev/null @@ -1,121 +0,0 @@ -// https://github.com/karma-runner/karma-chrome-launcher -process.env.CHROME_BIN = require("puppeteer").executablePath(); - -module.exports = function (config) { - config.set({ - // base path that will be used to resolve all patterns (eg. files, exclude) - basePath: "./", - - // frameworks to use - // available frameworks: https://npmjs.org/browse/keyword/karma-adapter - frameworks: ["mocha"], - - plugins: [ - "karma-mocha", - "karma-mocha-reporter", - "karma-chrome-launcher", - "karma-edge-launcher", - "karma-firefox-launcher", - "karma-ie-launcher", - "karma-env-preprocessor", - "karma-coverage", - "karma-sourcemap-loader", - "karma-junit-reporter", - ], - - // list of files / patterns to load in the browser - files: [ - // Uncomment the cdn link below for the polyfill service to support IE11 missing features - // Promise,String.prototype.startsWith,String.prototype.endsWith,String.prototype.repeat,String.prototype.includes,Array.prototype.includes,Object.keys - // "https://cdn.polyfill.io/v2/polyfill.js?features=Symbol,Promise,String.prototype.startsWith,String.prototype.endsWith,String.prototype.repeat,String.prototype.includes,Array.prototype.includes,Object.keys|always", - "dist-test/index.browser.js", - ], - - // list of files / patterns to exclude - exclude: [], - - // preprocess matching files before serving them to the browser - // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor - preprocessors: { - "**/*.js": ["sourcemap", "env"], - // IMPORTANT: COMMENT following line if you want to debug in your browsers!! - // Preprocess source file to calculate code coverage, however this will make source file unreadable - //"dist-test/index.browser.js": ["coverage"] - }, - - // inject following environment values into browser testing with window.__env__ - // environment values MUST be exported or set with same console running "karma start" - // https://www.npmjs.com/package/karma-env-preprocessor - // EXAMPLE: envPreprocessor: ["ACCOUNT_NAME", "ACCOUNT_SAS"], - - // test results reporter to use - // possible values: 'dots', 'progress' - // available reporters: https://npmjs.org/browse/keyword/karma-reporter - reporters: ["mocha", "coverage", "junit"], - - coverageReporter: { - // specify a common output directory - dir: "coverage-browser/", - reporters: [ - { type: "json", subdir: ".", file: "coverage.json" }, - { type: "lcovonly", subdir: ".", file: "lcov.info" }, - { type: "html", subdir: "html" }, - { type: "cobertura", subdir: ".", file: "cobertura-coverage.xml" }, - ], - }, - - junitReporter: { - outputDir: "", // results will be saved as $outputDir/$browserName.xml - outputFile: "test-results.browser.xml", // if included, results will be saved as $outputDir/$browserName/$outputFile - suite: "", // suite will become the package name attribute in xml testsuite element - useBrowserName: false, // add browser name to report and classes names - nameFormatter: undefined, // function (browser, result) to customize the name attribute in xml testcase element - classNameFormatter: undefined, // function (browser, result) to customize the classname attribute in xml testcase element - properties: {}, // key value pair of properties to add to the section of the report - }, - - // web server port - port: 9876, - - // enable / disable colors in the output (reporters and logs) - colors: true, - - // level of logging - // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG - logLevel: config.LOG_INFO, - - // enable / disable watching file and executing tests whenever any file changes - autoWatch: false, - - // start these browsers - // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher - // 'ChromeHeadless', 'Chrome', 'Firefox', 'Edge', 'IE' - browsers: ["ChromeHeadlessNoSandbox"], - customLaunchers: { - ChromeHeadlessNoSandbox: { - base: "ChromeHeadless", - flags: ["--no-sandbox"], - }, - }, - - // Continuous Integration mode - // if true, Karma captures browsers, runs the tests and exits - singleRun: true, - - // Concurrency level - // how many browser should be started simultaneous - concurrency: 1, - - browserNoActivityTimeout: 600000, - browserDisconnectTimeout: 10000, - browserDisconnectTolerance: 3, - - client: { - mocha: { - // change Karma's debug.html to the mocha web reporter - reporter: "html", - timeout: "600000", - }, - }, - }); -}; diff --git a/sdk/core/core-client-paging-rest/package.json b/sdk/core/core-client-paging-rest/package.json deleted file mode 100644 index 6bdba4b25fdc..000000000000 --- a/sdk/core/core-client-paging-rest/package.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "name": "@azure-rest/core-client-paging", - "version": "1.0.0-beta.2", - "description": "A helper library which implements Autorest x-ms-pageable spec for pagination.", - "sdk-type": "client", - "main": "dist/index.js", - "module": "dist-esm/src/index.js", - "types": "types/latest/core-client-paging-rest.d.ts", - "browser": { - "./dist-esm/src/url.js": "./dist-esm/src/url.browser.js" - }, - "react-native": { - "./dist/index.js": "./dist-esm/src/index.js" - }, - "scripts": { - "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit", - "build:samples": "echo Obsolete", - "build:test": "tsc -p . && rollup -c 2>&1", - "build": "npm run clean && tsc -p . && rollup -c 2>&1 && api-extractor run --local", - "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"", - "clean": "rimraf dist dist-* temp types *.tgz *.log", - "execute:samples": "echo skipped", - "extract-api": "tsc -p . && api-extractor run --local", - "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\"", - "integration-test:browser": "echo skipped", - "integration-test:node": "echo skipped", - "integration-test": "npm run integration-test:node && npm run integration-test:browser", - "lint:fix": "eslint package.json api-extractor.json src test --ext .ts --fix --fix-type [problem,suggestion]", - "lint": "eslint package.json api-extractor.json src test --ext .ts", - "pack": "npm pack 2>&1", - "test:browser": "npm run clean && npm run build:test && npm run unit-test:browser && npm run integration-test:browser", - "test:node": "npm run clean && tsc -p . && npm run unit-test:node && npm run integration-test:node", - "test": "npm run clean && tsc -p . && npm run unit-test:node && rollup -c 2>&1 && npm run unit-test:browser && npm run integration-test", - "unit-test:browser": "karma start --single-run", - "unit-test:node": "mocha -r esm -r ts-node/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 1200000 --full-trace \"test/{,!(browser)/**/}*.spec.ts\"", - "unit-test": "npm run unit-test:node && npm run unit-test:browser" - }, - "files": [ - "dist/", - "dist-esm/src/", - "types/latest/core-client-paging-rest.d.ts", - "README.md", - "LICENSE" - ], - "repository": "github:Azure/azure-sdk-for-js", - "keywords": [ - "azure", - "cloud" - ], - "author": "Microsoft Corporation", - "license": "MIT", - "bugs": { - "url": "https://github.com/Azure/azure-sdk-for-js/issues" - }, - "engines": { - "node": ">=12.0.0" - }, - "homepage": "https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-client-paging-rest/", - "sideEffects": false, - "prettier": "@azure/eslint-plugin-azure-sdk/prettier.json", - "dependencies": { - "@azure/core-paging": "^1.2.0", - "@azure/core-rest-pipeline": "^1.1.0", - "@azure-rest/core-client": "1.0.0-beta.7", - "tslib": "^2.2.0" - }, - "devDependencies": { - "@microsoft/api-extractor": "^7.18.11", - "@types/chai": "^4.1.6", - "@types/mocha": "^7.0.2", - "@types/node": "^12.0.0", - "@azure/eslint-plugin-azure-sdk": "^3.0.0", - "@azure/dev-tool": "^1.0.0", - "chai": "^4.2.0", - "cross-env": "^7.0.2", - "eslint": "^7.15.0", - "inherits": "^2.0.3", - "karma": "^6.2.0", - "karma-chrome-launcher": "^3.0.0", - "karma-coverage": "^2.0.0", - "karma-edge-launcher": "^0.4.2", - "karma-env-preprocessor": "^0.1.1", - "karma-firefox-launcher": "^1.1.0", - "karma-ie-launcher": "^1.0.0", - "karma-junit-reporter": "^2.0.1", - "karma-mocha": "^2.0.1", - "karma-mocha-reporter": "^2.2.5", - "karma-sourcemap-loader": "^0.3.8", - "mocha": "^7.1.1", - "mocha-junit-reporter": "^2.0.0", - "prettier": "^2.5.1", - "rimraf": "^3.0.0", - "rollup": "^1.16.3", - "sinon": "^9.0.2", - "typescript": "~4.2.0", - "util": "^0.12.1" - } -} diff --git a/sdk/core/core-client-paging-rest/review/core-client-paging.api.md b/sdk/core/core-client-paging-rest/review/core-client-paging.api.md deleted file mode 100644 index c4a052cd26b0..000000000000 --- a/sdk/core/core-client-paging-rest/review/core-client-paging.api.md +++ /dev/null @@ -1,24 +0,0 @@ -## API Report File for "@azure-rest/core-client-paging" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -/// - -import { Client } from '@azure-rest/core-client'; -import { HttpResponse } from '@azure-rest/core-client'; -import { PagedAsyncIterableIterator } from '@azure/core-paging'; - -export { PagedAsyncIterableIterator } - -// @public -export interface PaginateOptions { - itemNames?: string[]; - nextLinkNames?: string[] | null; -} - -// @public -export function paginateResponse(client: Client, initialResponse: HttpResponse, options?: PaginateOptions): PagedAsyncIterableIterator; - -``` diff --git a/sdk/core/core-client-paging-rest/rollup.config.js b/sdk/core/core-client-paging-rest/rollup.config.js deleted file mode 100644 index 26e83ddfafa4..000000000000 --- a/sdk/core/core-client-paging-rest/rollup.config.js +++ /dev/null @@ -1,2 +0,0 @@ -import { makeConfig } from "@azure/dev-tool/shared-config/rollup"; -export default makeConfig(require("./package.json")); diff --git a/sdk/core/core-client-paging-rest/src/index.ts b/sdk/core/core-client-paging-rest/src/index.ts deleted file mode 100644 index 902316ffaffd..000000000000 --- a/sdk/core/core-client-paging-rest/src/index.ts +++ /dev/null @@ -1,10 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -/** - * A helper library which implements Autorest x-ms-pageable spec for pagination - * - * @packageDocumentation - */ -export { paginateResponse, PaginateOptions } from "./paginate"; -export { PagedAsyncIterableIterator } from "@azure/core-paging"; diff --git a/sdk/core/core-client-paging-rest/src/paginate.ts b/sdk/core/core-client-paging-rest/src/paginate.ts deleted file mode 100644 index 447b888149ce..000000000000 --- a/sdk/core/core-client-paging-rest/src/paginate.ts +++ /dev/null @@ -1,155 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -/// - -import { - Client, - createRestError, - HttpResponse, - PathUncheckedResponse, -} from "@azure-rest/core-client"; -import { getPagedAsyncIterator, PagedAsyncIterableIterator, PagedResult } from "@azure/core-paging"; - -const Http2xxStatusCodes = ["200", "201", "202", "203", "204", "205", "206", "207", "208", "226"]; - -const DEFAULT_NEXTLINK = "nextLink"; -const DEFAULT_VALUES = "value"; - -/** - * Options to indicate custom values for where to look for nextLink and values - * when paginating a response - */ -export interface PaginateOptions { - /** - * Property name in the body where the nextLink is located - * The default value is `nextLink`. - * nextLink is an opaque URL for the client, in which the next set of results is located. - * Note: if nextLinkName is set to `null` only the first page is returned, no additional - * requests are made. - */ - nextLinkNames?: string[] | null; - /** - * Indicates the name of the property in which the set of values is found. Default: `value` - */ - itemNames?: string[]; -} - -/** - * Helper to iterate pageable responses - * @param client - Client to use for sending the request to get additional pages - * @param initialResponse - The initial response - * @param options - Options to use custom property names for pagination - * @returns - return a PagedAsyncIterableIterator that can be used to iterate the elements - */ -export function paginateResponse( - client: Client, - initialResponse: HttpResponse, - options: PaginateOptions = {} -): PagedAsyncIterableIterator { - let firstRun = true; - const { itemName, nextLinkName } = getPaginationProperties(initialResponse, options); - const pagedResult: PagedResult = { - firstPageLink: "", - async getPage(pageLink: string) { - const result = firstRun ? initialResponse : await client.pathUnchecked(pageLink).get(); - firstRun = false; - checkPagingRequest(result); - const nextLink = getNextLink(result.body, nextLinkName); - const values = getElements(result.body, itemName); - return { - page: values, - // According to x-ms-pageable is the nextLinkNames is set to null we should only - // return the first page and skip any additional queries even if the initial response - // contains a nextLink. - nextPageLink: options.nextLinkNames === null ? undefined : nextLink, - }; - }, - }; - return getPagedAsyncIterator(pagedResult); -} - -/** - * Checks if a request failed - */ -function checkPagingRequest(response: PathUncheckedResponse): void { - if (!Http2xxStatusCodes.includes(response.status)) { - throw createRestError( - `Pagination failed with unexpected statusCode ${response.status}`, - response - ); - } -} - -/** - * Extracts the itemName and nextLinkName from the initial response to use them for pagination - */ -function getPaginationProperties(initialResponse: HttpResponse, options: PaginateOptions = {}) { - // Build a set with the passed custom nextLinkNames - const nextLinkNames = new Set(options.nextLinkNames ?? DEFAULT_NEXTLINK); - // Add the default nextLinkName if it doesn't exist yet - nextLinkNames.add(DEFAULT_NEXTLINK); - - // Build a set with the passed custom set of itemNames - const itemNames = new Set(options.itemNames ?? DEFAULT_VALUES); - // Add the default itemName if it doesn't exist yet - itemNames.add(DEFAULT_VALUES); - - let nextLinkName: string | undefined; - let itemName: string | undefined; - - for (const name of nextLinkNames) { - const nextLink = (initialResponse.body as Record)[name] as string; - if (nextLink) { - nextLinkName = name; - break; - } - } - - for (const name of itemNames) { - const item = (initialResponse.body as Record)[name] as string; - if (item) { - itemName = name; - break; - } - } - - if (!itemName) { - throw new Error( - `Couldn't paginate response\n Body doesn't contain an array property with name: ${[ - ...itemNames, - ].join(" OR ")}` - ); - } - - return { itemName, nextLinkName }; -} - -/** - * Gets for the value of nextLink in the body. If a custom nextLinkNames was provided, it will be used instead of default - */ -function getNextLink(body: unknown, nextLinkName?: string): string | undefined { - // It is possible to get an undefined for nextLinkName, in the scenario where the initial response contains the last page. - const nextLink = - nextLinkName === undefined - ? undefined - : ((body as Record)[nextLinkName] as string); - - return nextLink; -} - -/** - * Gets the elements of the current request in the body. By default it will look in the `value` property unless - * a different value for itemNames has been provided as part of the options. - */ -function getElements(body: unknown, itemName: string): T[] { - const value = (body as Record)[itemName]; - - if (!Array.isArray(value)) { - throw new Error( - `Couldn't paginate response\n Body doesn't contain an array property with name: ${itemName}` - ); - } - - return (value as T[]) ?? []; -} diff --git a/sdk/core/core-client-paging-rest/src/url.browser.ts b/sdk/core/core-client-paging-rest/src/url.browser.ts deleted file mode 100644 index a6b3956caf41..000000000000 --- a/sdk/core/core-client-paging-rest/src/url.browser.ts +++ /dev/null @@ -1,9 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -/// - -const url = URL; -const urlSearchParams = URLSearchParams; - -export { url as URL, urlSearchParams as URLSearchParams }; diff --git a/sdk/core/core-client-paging-rest/src/url.ts b/sdk/core/core-client-paging-rest/src/url.ts deleted file mode 100644 index 993e69798f9e..000000000000 --- a/sdk/core/core-client-paging-rest/src/url.ts +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -export { URL, URLSearchParams } from "url"; diff --git a/sdk/core/core-client-paging-rest/test/paginate.spec.ts b/sdk/core/core-client-paging-rest/test/paginate.spec.ts deleted file mode 100644 index 202a2cf56794..000000000000 --- a/sdk/core/core-client-paging-rest/test/paginate.spec.ts +++ /dev/null @@ -1,258 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -import { assert } from "chai"; -import { Client, getClient, PathUncheckedResponse } from "@azure-rest/core-client"; -import { paginateResponse } from "../src/paginate"; -import { createHttpHeaders } from "@azure/core-rest-pipeline"; -import { URL } from "../src/url"; -import { PagedAsyncIterableIterator } from "@azure/core-paging"; - -/** - * This is a sample of how code generator can generate code around the Swagger spec for pagination to improve UX - */ - -// Helper type to extract the type of an array -type GetArrayType = T extends Array ? TData : unknown; - -// Helper type to infer the Type of the paged elements from the response type -// This type will be generated based on the swagger information for x-ms-pageable -// specifically on the itemName property which indicates the property of the response -// where the page items are found. The default value is `value` -export type PaginateReturn = TResult extends - | { - body: { value: infer TPage }; - } - | { - // In the tests below we are using values as a custom pagination property - // In cases like this the generator will have to generate one of these - // entries for each unique value of itemName in the swagger. Most of the times - // the itemName remains constant throughout the swagger, but that is not a requirement - body: { values: infer TPage }; - } - ? GetArrayType - : Array; - -/** - * Shapes of the test responses - */ -interface TestItem { - foo?: number; -} - -interface TestResponse extends PathUncheckedResponse { - body: { - value: Array; - }; -} - -interface TestResponseValues extends PathUncheckedResponse { - body: { - values: Array; - }; -} - -/** - * This is the default paginate helper function - */ -export function paginate( - client: Client, - initialResponse: TReturn -): PagedAsyncIterableIterator, PaginateReturn[]> { - return paginateResponse>(client, initialResponse, { - itemNames: ["value", "values"], - nextLinkNames: ["nextLink", "continuationLink"], - }); -} - -describe("Paginate heleper", () => { - let client: Client; - - beforeEach(() => { - client = getClient("http://localhost:3000", { allowInsecureConnection: true }); - client.pipeline.getOrderedPolicies().forEach(({ name }) => { - client.pipeline.removePolicy({ name }); - }); - }); - - it("Paging_getNoItemNamePages", async () => { - // Paginate assumes the resource supports get and nextLink is an opaque url to which a get can be done - // by default and following autorest x-ms-pageable extension, Paginate assumes that the pageable result - // will contain a property nextLink which is the opaque url for the next page, and a value property containing - // an array with the results (the page); - const expectedPage = [{ foo: 1 }]; - mockResponse(client, [ - { path: "/paging/noitemname", response: { status: 200, body: { value: expectedPage } } }, - ]); - const response: TestResponse = await client.pathUnchecked("/paging/noitemname").get(); - const items = paginate(client, response); - const result = []; - - for await (const item of items) { - result.push(item); - } - - assert.deepEqual(result, expectedPage); - }); - - it("Paging_getNullNextLinkNamePages", async () => { - // A paging operation that must ignore any kind of nextLink, and stop after page 1. - - const expectedPage = [{ foo: 1 }]; - mockResponse(client, [ - { - path: "/paging/nullnextlink", - response: { status: 200, body: { value: expectedPage, nextLink: "/paging/nullnextlink" } }, - }, - { - path: "/paging/nullnextlink", - response: { status: 400, body: { value: expectedPage, nextLink: "/paging/nullnextlink" } }, - }, - ]); - - const response: TestResponse = await client.pathUnchecked("/paging/nullnextlink").get(); - const items = paginateResponse(client, response, { nextLinkNames: null }); - const result = []; - - for await (const item of items) { - result.push(item); - } - - assert.deepEqual(result, expectedPage); - }); - - it("Paging_getSinglePages", async () => { - // Autorest x-ms-pageable extension allows setting a different name for the property that contains the page - // we can allow overriding this through the pagingOptions values. - // The extension also allows setting a custom nextLink property name. - - const expectedPage = [{ foo: 1 }]; - mockResponse(client, [ - { path: "/paging/single", response: { status: 200, body: { values: expectedPage } } }, - ]); - - const response: TestResponseValues = await client.pathUnchecked("/paging/single").get(); - const items = paginate(client, response); - const result = []; - for await (const item of items) { - // We get a strong type for item :) - result.push(item); - } - - assert.deepEqual(result, expectedPage); - }); - - it("Paging_firstResponseEmpty", async () => { - // First response has an empty [] next page contains a page with an element - const expectedPage = [{ foo: 1 }]; - mockResponse(client, [ - { - path: "/paging/firstResponseEmpty/1", - response: { - status: 200, - body: { value: [], continuationLink: "/paging/firstResponseEmpty/2" }, - }, - }, - { - path: "/paging/firstResponseEmpty/2", - response: { status: 200, body: { value: expectedPage } }, - }, - ]); - - const response: TestResponse = await client.pathUnchecked("/paging/firstResponseEmpty/1").get(); - const items = paginate(client, response); - const result = []; - for await (const item of items) { - result.push(item); - } - - assert.deepEqual(result, expectedPage); - }); - - it("Paging_getMultiplePages", async () => { - const expectedPages = [{ foo: 1 }, { foo: 2 }, { foo: 3 }]; - - const mockResponses: MockResponse[] = [ - { - path: "/paging/multiple", - response: { - status: 200, - body: { value: [expectedPages[0]], nextLink: "/paging/multiple/1" }, - }, - }, - { - path: "/paging/multiple/1", - response: { - status: 200, - body: { value: [expectedPages[1]], nextLink: "/paging/multiple/2" }, - }, - }, - { - path: "/paging/multiple/2", - response: { - status: 200, - body: { value: [expectedPages[2]], nextLink: undefined }, - }, - }, - ]; - - mockResponse(client, mockResponses); - - const response: TestResponse = await client.pathUnchecked("/paging/multiple").get(); - const items = paginate(client, response); - const result = []; - for await (const item of items) { - result.push(item); - } - - assert.deepEqual(result, [...expectedPages]); - }); -}); - -interface MockResponse { - path: string; - response: { - status: number; - body: any; - }; -} - -/** - * Creates a pipeline with a mocked service call - * @param client - client to mock requests for - * @param response - Responses to return, the actual request url is matched to one of the paths in the responses and the defined object is returned. - * if no path matches a 404 error is returned - */ -function mockResponse(client: Client, responses: MockResponse[]): void { - let count = 0; - - client.pipeline.addPolicy({ - name: "mockClient", - sendRequest: async (request, _next) => { - if (count < responses.length) { - count++; - } - - const path = new URL(request.url).pathname; - - const response = responses.find((r) => r.path === path); - - if (!response) { - return { - headers: createHttpHeaders(), - request, - status: 404, - }; - } - - const { body, status } = response.response; - const bodyAsText = JSON.stringify(body); - return { - headers: createHttpHeaders(), - request, - status, - bodyAsText, - }; - }, - }); -} diff --git a/sdk/core/core-client-paging-rest/tsconfig.json b/sdk/core/core-client-paging-rest/tsconfig.json deleted file mode 100644 index 82e643af7e8c..000000000000 --- a/sdk/core/core-client-paging-rest/tsconfig.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "extends": "../../../tsconfig.package", - "compilerOptions": { - "outDir": "./dist-esm", - "declarationDir": "./types/latest" - }, - "include": ["src/**/*.ts", "test/**/*.ts"] -} diff --git a/sdk/core/core-client-paging-rest/tsdoc.json b/sdk/core/core-client-paging-rest/tsdoc.json deleted file mode 100644 index 81c5a8a2aa2f..000000000000 --- a/sdk/core/core-client-paging-rest/tsdoc.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "extends": ["../../../tsdoc.json"] -} diff --git a/sdk/purview/ci.yml b/sdk/purview/ci.yml index 01bb60da46aa..bcd6bd936da6 100644 --- a/sdk/purview/ci.yml +++ b/sdk/purview/ci.yml @@ -29,8 +29,6 @@ extends: safeName: azurerestpurviewcatalog - name: azure-rest-purview-scanning safeName: azurerestpurviewscanning - - name: azure-rest-purview-account - safeName: azurerestpurviewaccount - name: azure-rest-purview-administration safeName: azurerestpurviewadministration - name: azure-arm-purview diff --git a/sdk/purview/purview-account-rest/.eslintrc.json b/sdk/purview/purview-account-rest/.eslintrc.json deleted file mode 100644 index 619797ac39b6..000000000000 --- a/sdk/purview/purview-account-rest/.eslintrc.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "plugins": ["@azure/azure-sdk"], - "extends": ["plugin:@azure/azure-sdk/azure-sdk-base"], - "rules": { - "@azure/azure-sdk/ts-modules-only-named": "warn", - "@azure/azure-sdk/ts-apiextractor-json-types": "warn", - "@azure/azure-sdk/ts-package-json-types": "warn", - "@azure/azure-sdk/ts-package-json-engine-is-present": "warn", - "tsdoc/syntax": "warn" - } -} diff --git a/sdk/purview/purview-account-rest/CHANGELOG.md b/sdk/purview/purview-account-rest/CHANGELOG.md deleted file mode 100644 index 0adb473e9857..000000000000 --- a/sdk/purview/purview-account-rest/CHANGELOG.md +++ /dev/null @@ -1,5 +0,0 @@ -# Release History - -## 1.0.0-beta.1 (2021-08-13) - -- First release of package, see README.md for details. diff --git a/sdk/purview/purview-account-rest/LICENSE b/sdk/purview/purview-account-rest/LICENSE deleted file mode 100644 index 2d3163745319..000000000000 --- a/sdk/purview/purview-account-rest/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2021 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. diff --git a/sdk/purview/purview-account-rest/README.md b/sdk/purview/purview-account-rest/README.md deleted file mode 100644 index 15ae8913f93d..000000000000 --- a/sdk/purview/purview-account-rest/README.md +++ /dev/null @@ -1,141 +0,0 @@ -# Azure Purview Account REST client library for JavaScript - -Azure Purview Account is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. At the same time, Data Account helps organizations get more value from their existing investments. - -- Search for data using technical or business terms -- Browse associated technical, business, semantic, and operational metadata -- Identify the sensitivity level of data. - -**Please rely heavily on the [service's documentation][account_product_documentation] and our [REST client docs][rest_client] to use this library** - -Key links: -- [Source code][source_code] -- [Package (NPM)][account_npm] -- [API reference documentation][account_ref_docs] -- [Product documentation][account_product_documentation] - -## Getting started - -### Currently supported environments - -- Node.js version 14.x.x or higher - -### Prerequisites - -- You must have an [Azure subscription][azure_subscription] and a [Purview][purview_resource] to use this package. - -#### Create a Purview Resource - -Follow [these][purview_resource] instructions to create your Purview resource - -### Install the `@azure-rest/purview-account` package - -Install the Azure Purview Account client library for JavaScript with `npm`: - -```bash -npm install @azure-rest/purview-account -``` - -### Create and authenticate a `PurviewAccount` - -To use an [Azure Active Directory (AAD) token credential][authenticate_with_token], -provide an instance of the desired credential type obtained from the -[@azure/identity][azure_identity_credentials] library. - -To authenticate with AAD, you must first `npm` install [`@azure/identity`][azure_identity_npm] and -[enable AAD authentication on your Purview resource][enable_aad] - -After setup, you can choose which type of [credential][azure_identity_credentials] from `@azure/identity` to use. -As an example, [DefaultAzureCredential][default_azure_credential] -can be used to authenticate the client: - -Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: -AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET - -Use the returned token credential to authenticate the client: - -```typescript -import PurviewAccount from "@azure-rest/purview-account"; -import { DefaultAzureCredential } from "@azure/identity"; -const client = PurviewAccount( - "https://.purview.azure.com", - new DefaultAzureCredential() -); -``` - -## Key concepts - -### REST Client - -This client is one of our REST clients. We highly recommend you read how to use a REST client [here][rest_client]. - -## Examples - -The following section shows you how to initialize and authenticate your client, then get all of your type-defs. - -- [Get A List of Collections](#get-a-list-of-collections "Get A List of Collections") - -```typescript -import PurviewAccount from "@azure-rest/purview-account"; -import { DefaultAzureCredential } from "@azure/identity"; -import dotenv from "dotenv"; - -dotenv.config(); - -const endpoint = process.env["ENDPOINT"] || ""; - -async function main() { - console.log("== List collections sample =="); - const client = PurviewAccount(endpoint, new DefaultAzureCredential()); - - const response = await client.path("/collections").get(); - - if (response.status !== "200") { - console.log(`GET "/collections" failed with ${response.status}`); - } - - console.log(response.body); -} - -main().catch(console.error); - -``` - -## Troubleshooting - -### Logging - -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 -import { setLogLevel } from "@azure/logger"; - -setLogLevel("info"); -``` - -For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger). - -## Next steps - -## Contributing - -If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code. - -## Related projects - -- [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%2Fpurview%2Fpurview-account-rest%2FREADME.png) - -[account_product_documentation]: https://azure.microsoft.com/services/purview/ -[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/purview/purview-catalog-rest -[account_npm]: https://www.npmjs.com/org/azure-rest -[account_ref_docs]: https://azure.github.io/azure-sdk-for-js -[azure_subscription]: https://azure.microsoft.com/free/ -[purview_resource]: https://docs.microsoft.com/azure/purview/create-catalog-portal -[authenticate_with_token]: https://docs.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 -[enable_aad]: https://docs.microsoft.com/azure/purview/create-catalog-portal#add-a-security-principal-to-a-data-plane-role -[default_azure_credential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential diff --git a/sdk/purview/purview-account-rest/api-extractor.json b/sdk/purview/purview-account-rest/api-extractor.json deleted file mode 100644 index df353f770a8f..000000000000 --- a/sdk/purview/purview-account-rest/api-extractor.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", - "mainEntryPointFilePath": "types/src/index.d.ts", - "docModel": { - "enabled": true - }, - "apiReport": { - "enabled": true, - "reportFolder": "./review" - }, - "dtsRollup": { - "enabled": true, - "untrimmedFilePath": "", - "publicTrimmedFilePath": "./types/purview-account-rest.d.ts" - }, - "messages": { - "tsdocMessageReporting": { - "default": { - "logLevel": "none" - } - }, - "extractorMessageReporting": { - "ae-missing-release-tag": { - "logLevel": "none" - }, - "ae-unresolved-link": { - "logLevel": "none" - } - } - } -} diff --git a/sdk/purview/purview-account-rest/package.json b/sdk/purview/purview-account-rest/package.json deleted file mode 100644 index 822009fcfbec..000000000000 --- a/sdk/purview/purview-account-rest/package.json +++ /dev/null @@ -1,128 +0,0 @@ -{ - "name": "@azure-rest/purview-account", - "sdk-type": "client", - "author": "Microsoft Corporation", - "description": "An isomorphic rest level client library for the Azure Purview Account service.", - "version": "1.0.0-beta.1", - "keywords": [ - "node", - "azure", - "cloud", - "typescript", - "browser", - "isomorphic" - ], - "license": "MIT", - "main": "./dist/index.js", - "module": "./dist-esm/src/index.js", - "types": "./types/purview-account-rest.d.ts", - "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/purview/purview-account-rest/README.md", - "repository": "github:Azure/azure-sdk-for-js", - "bugs": { - "url": "https://github.com/Azure/azure-sdk-for-js/issues" - }, - "files": [ - "dist/", - "dist-esm/src/", - "types/purview-account-rest.d.ts", - "README.md", - "LICENSE" - ], - "engines": { - "node": ">=12.0.0" - }, - "//metadata": { - "constantPaths": [ - { - "path": "swagger/README.md", - "prefix": "package-version" - } - ] - }, - "//sampleConfiguration": { - "productName": "Azure Purview Scanning rest", - "productSlugs": [ - "azure" - ], - "requiredResources": { - "Azure Cognitive Services instance": "https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account" - } - }, - "browser": { - "./dist-esm/test/public/utils/env.js": "./dist-esm/test/public/utils/env.browser.js" - }, - "scripts": { - "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit", - "build:browser": "tsc -p . && cross-env ONLY_BROWSER=true rollup -c 2>&1", - "build:node": "tsc -p . && cross-env ONLY_NODE=true rollup -c 2>&1", - "build:samples": "echo Obsolete.", - "build:test": "tsc -p . && rollup -c 2>&1", - "build": "npm run clean && tsc -p . && rollup -c 2>&1 && mkdirp ./review && api-extractor run --local", - "build:debug": "tsc -p . && rollup -c 2>&1 && api-extractor run --local", - "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"", - "clean": "rimraf dist dist-browser dist-esm test-dist temp types *.tgz *.log", - "execute:samples": "dev-tool samples run samples-dev", - "extract-api": "rimraf review && mkdirp ./review && api-extractor run --local", - "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"", - "generate:client": "autorest --typescript swagger/README.md && npm run format", - "integration-test:browser": "karma start --single-run", - "integration-test:node": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 5000000 --full-trace \"dist-esm/test/{,!(browser)/**/}*.spec.js\"", - "integration-test": "npm run integration-test:node && npm run integration-test:browser", - "lint:fix": "eslint package.json api-extractor.json src test --ext .ts --fix --fix-type [problem,suggestion]", - "lint": "eslint package.json api-extractor.json src test --ext .ts", - "pack": "npm pack 2>&1", - "test:browser": "npm run clean && npm run build:test && npm run unit-test:browser", - "test:node": "npm run clean && npm run build:test && npm run unit-test:node", - "test": "npm run clean && npm run build:test && npm run unit-test", - "unit-test:browser": "echo skipped", - "unit-test:node": "cross-env mocha -r esm --require ts-node/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 1200000 --full-trace \"test/{,!(browser)/**/}*.spec.ts\"", - "unit-test": "npm run unit-test:node && npm run unit-test:browser" - }, - "sideEffects": false, - "autoPublish": false, - "dependencies": { - "@azure-rest/core-client-paging": "1.0.0-beta.1", - "@azure/core-auth": "^1.3.0", - "@azure-rest/core-client": "1.0.0-beta.7", - "@azure/core-rest-pipeline": "^1.1.0", - "@azure/logger": "^1.0.0", - "tslib": "^2.2.0" - }, - "devDependencies": { - "@azure/dev-tool": "^1.0.0", - "@azure/eslint-plugin-azure-sdk": "^3.0.0", - "@azure/identity": "^2.0.1", - "@azure-tools/test-recorder": "^1.0.0", - "@microsoft/api-extractor": "^7.18.11", - "@types/chai": "^4.1.6", - "@types/mocha": "^7.0.2", - "@types/node": "^12.0.0", - "chai": "^4.2.0", - "cross-env": "^7.0.2", - "dotenv": "^8.2.0", - "eslint": "^7.15.0", - "karma-chrome-launcher": "^3.0.0", - "karma-coverage": "^2.0.0", - "karma-edge-launcher": "^0.4.2", - "karma-env-preprocessor": "^0.1.1", - "karma-firefox-launcher": "^1.1.0", - "karma-ie-launcher": "^1.0.0", - "karma-json-preprocessor": "^0.3.3", - "karma-json-to-file-reporter": "^1.0.1", - "karma-junit-reporter": "^2.0.1", - "karma-mocha-reporter": "^2.2.5", - "karma-mocha": "^2.0.1", - "karma-source-map-support": "~1.4.0", - "karma-sourcemap-loader": "^0.3.8", - "karma": "^6.2.0", - "mkdirp": "^1.0.4", - "mocha-junit-reporter": "^2.0.0", - "mocha": "^7.1.1", - "nyc": "^15.0.0", - "prettier": "2.5.1", - "rimraf": "^3.0.0", - "rollup": "^1.16.3", - "source-map-support": "^0.5.9", - "typescript": "~4.2.0" - } -} diff --git a/sdk/purview/purview-account-rest/recordings/node/get_account_info/recording_should_get_the_account_info.js b/sdk/purview/purview-account-rest/recordings/node/get_account_info/recording_should_get_the_account_info.js deleted file mode 100644 index ab1e9580b0f5..000000000000 --- a/sdk/purview/purview-account-rest/recordings/node/get_account_info/recording_should_get_the_account_info.js +++ /dev/null @@ -1,131 +0,0 @@ -let nock = require('nock'); - -module.exports.hash = "2ff3b5a65daf079dc2f7d73b5d58f0de"; - -module.exports.testInfo = {"uniqueName":{},"newDate":{}} - -nock('https://login.microsoftonline.com:443', {"encodedQueryParams":true}) - .get('/common/discovery/instance') - .query(true) - .reply(200, {"tenant_discovery_endpoint":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/v2.0/.well-known/openid-configuration","api-version":"1.1","metadata":[{"preferred_network":"login.microsoftonline.com","preferred_cache":"login.windows.net","aliases":["login.microsoftonline.com","login.windows.net","login.microsoft.com","sts.windows.net"]},{"preferred_network":"login.partner.microsoftonline.cn","preferred_cache":"login.partner.microsoftonline.cn","aliases":["login.partner.microsoftonline.cn","login.chinacloudapi.cn"]},{"preferred_network":"login.microsoftonline.de","preferred_cache":"login.microsoftonline.de","aliases":["login.microsoftonline.de"]},{"preferred_network":"login.microsoftonline.us","preferred_cache":"login.microsoftonline.us","aliases":["login.microsoftonline.us","login.usgovcloudapi.net"]},{"preferred_network":"login-us.microsoftonline.com","preferred_cache":"login-us.microsoftonline.com","aliases":["login-us.microsoftonline.com"]}]}, [ - 'Cache-Control', - 'max-age=86400, private', - 'Content-Type', - 'application/json; charset=utf-8', - 'Strict-Transport-Security', - 'max-age=31536000; includeSubDomains', - 'X-Content-Type-Options', - 'nosniff', - 'Access-Control-Allow-Origin', - '*', - 'Access-Control-Allow-Methods', - 'GET, OPTIONS', - 'P3P', - 'CP="DSP CUR OTPi IND OTRi ONL FIN"', - 'x-ms-request-id', - '61bade29-ae60-493d-870c-9ec9da9a2d02', - 'x-ms-ests-server', - '2.1.12171.14 - SCUS ProdSlices', - 'Set-Cookie', - 'fpc=AkOWu2lqxhdDkHfaAu4_mAc; expires=Sat, 04-Dec-2021 16:28:36 GMT; path=/; secure; HttpOnly; SameSite=None', - 'Set-Cookie', - 'esctx=AQABAAAAAAD--DLA3VO7QrddgJg7WevrwwGWw0lbyUzqjOsd4dMVmZ703FhEH64QevMVb1DwdXUQ9pzX6dsCWZS1EzIOGd0RLYwGbO2ZTgvv0HkIv-VYiLXEoUYaKqxmY4V1DckQeBmogaoiTxeqkC1nZHhGFYqrg4UD6yTozLUsCfVypo23SGT0xvgmFZaHAhc6klGQgokgAA; domain=.login.microsoftonline.com; path=/; secure; HttpOnly; SameSite=None', - 'Set-Cookie', - 'x-ms-gateway-slice=estsfd; path=/; secure; samesite=none; httponly', - 'Set-Cookie', - 'stsservicecookie=estsfd; path=/; secure; samesite=none; httponly', - 'Date', - 'Thu, 04 Nov 2021 16:28:36 GMT', - 'Content-Length', - '980' -]); - -nock('https://login.microsoftonline.com:443', {"encodedQueryParams":true}) - .get('/88888888-8888-8888-8888-888888888888/v2.0/.well-known/openid-configuration') - .reply(200, {"token_endpoint":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/oauth2/v2.0/token","token_endpoint_auth_methods_supported":["client_secret_post","private_key_jwt","client_secret_basic"],"jwks_uri":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/discovery/v2.0/keys","response_modes_supported":["query","fragment","form_post"],"subject_types_supported":["pairwise"],"id_token_signing_alg_values_supported":["RS256"],"response_types_supported":["code","id_token","code id_token","id_token token"],"scopes_supported":["openid","profile","email","offline_access"],"issuer":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/v2.0","request_uri_parameter_supported":false,"userinfo_endpoint":"https://graph.microsoft.com/oidc/userinfo","authorization_endpoint":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/oauth2/v2.0/authorize","device_authorization_endpoint":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/oauth2/v2.0/devicecode","http_logout_supported":true,"frontchannel_logout_supported":true,"end_session_endpoint":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/oauth2/v2.0/logout","claims_supported":["sub","iss","cloud_instance_name","cloud_instance_host_name","cloud_graph_host_name","msgraph_host","aud","exp","iat","auth_time","acr","nonce","preferred_username","name","tid","ver","at_hash","c_hash","email"],"kerberos_endpoint":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/kerberos","tenant_region_scope":"WW","cloud_instance_name":"microsoftonline.com","cloud_graph_host_name":"graph.windows.net","msgraph_host":"graph.microsoft.com","rbac_url":"https://pas.windows.net"}, [ - 'Cache-Control', - 'max-age=86400, private', - 'Content-Type', - 'application/json; charset=utf-8', - 'Strict-Transport-Security', - 'max-age=31536000; includeSubDomains', - 'X-Content-Type-Options', - 'nosniff', - 'Access-Control-Allow-Origin', - '*', - 'Access-Control-Allow-Methods', - 'GET, OPTIONS', - 'P3P', - 'CP="DSP CUR OTPi IND OTRi ONL FIN"', - 'x-ms-request-id', - 'ade56010-2ac0-4cc1-a0be-cded17b71600', - 'x-ms-ests-server', - '2.1.12197.4 - NCUS ProdSlices', - 'Set-Cookie', - 'fpc=AqLHQXHG3UZLg7y7k96PBq0; expires=Sat, 04-Dec-2021 16:28:36 GMT; path=/; secure; HttpOnly; SameSite=None', - 'Set-Cookie', - 'esctx=AQABAAAAAAD--DLA3VO7QrddgJg7Wevrnu6i2A3eqs6ZNxFIdssUx4EATaw4oyXk1xA5JLPYXTuWz1BUUISyqSS0uhjbeebVYjUMzAzGj1OBiOAU-VKGz30uoCkmV4x_tTT0Doe9JdYyuh-jYcxJJyHgZXoFfpbvjWlxPV_1Hd6gZgK1dATCq5Uki7Y-pL9_gTddqba-Q_wgAA; domain=.login.microsoftonline.com; path=/; secure; HttpOnly; SameSite=None', - 'Set-Cookie', - 'x-ms-gateway-slice=estsfd; path=/; secure; samesite=none; httponly', - 'Set-Cookie', - 'stsservicecookie=estsfd; path=/; secure; samesite=none; httponly', - 'Date', - 'Thu, 04 Nov 2021 16:28:36 GMT', - 'Content-Length', - '1753' -]); - -nock('https://login.microsoftonline.com:443', {"encodedQueryParams":true}) - .post('/88888888-8888-8888-8888-888888888888/oauth2/v2.0/token', "client_id=azure_client_id&scope=https%3A%2F%2Fsanitized%2F&grant_type=client_credentials&x-client-SKU=msal.js.node&x-client-VER=1.3.2&x-client-OS=linux&x-client-CPU=x64&x-ms-lib-capability=retry-after, h429&x-client-current-telemetry=5|771,2,,,|,&x-client-last-telemetry=5|0|||0,0&client-request-id=88eff70c-a995-4894-8e9c-0fb3bd1ec8e7&client_secret=azure_client_secret&claims=%7B%22access_token%22%3A%7B%22xms_cc%22%3A%7B%22values%22%3A%5B%22CP1%22%5D%7D%7D%7D") - .reply(200, {"token_type":"Bearer","expires_in":86399,"ext_expires_in":86399,"access_token":"access_token"}, [ - 'Cache-Control', - 'no-store, no-cache', - 'Pragma', - 'no-cache', - 'Content-Type', - 'application/json; charset=utf-8', - 'Expires', - '-1', - 'Strict-Transport-Security', - 'max-age=31536000; includeSubDomains', - 'X-Content-Type-Options', - 'nosniff', - 'P3P', - 'CP="DSP CUR OTPi IND OTRi ONL FIN"', - 'x-ms-request-id', - '54cf00a4-bc0a-4482-b96a-a18e6f161e00', - 'x-ms-ests-server', - '2.1.12197.4 - SCUS ProdSlices', - 'x-ms-clitelem', - '1,0,0,,', - 'Set-Cookie', - 'fpc=AqBWJWj6pUJBkzhkRKzZpZj__1r8AQAAADMBFtkOAAAA; expires=Sat, 04-Dec-2021 16:28:37 GMT; path=/; secure; HttpOnly; SameSite=None', - 'Set-Cookie', - 'x-ms-gateway-slice=estsfd; path=/; secure; samesite=none; httponly', - 'Set-Cookie', - 'stsservicecookie=estsfd; path=/; secure; samesite=none; httponly', - 'Date', - 'Thu, 04 Nov 2021 16:28:37 GMT', - 'Content-Length', - '1318' -]); - -nock('https://endpoint', {"encodedQueryParams":true}) - .get('/') - .query(true) - .reply(200, {"sku":{"name":"Standard","capacity":1},"properties":{"cloudConnectors":{"awsExternalId":"ec2bff3a-3cba-4be0-a9ca-6d6b0a5cc268"},"friendlyName":"joheredipv","createdBy":"joheredi@microsoft.com","createdByObjectId":"35ac9d32-a8ca-4324-9393-d4000746f07c","createdAt":"2021-08-10T17:25:46.5991716Z","endpoints":{"catalog":"https://endpoint/catalog","scan":"https://endpoint/scan","guardian":"https://endpoint/guardian"},"provisioningState":"Succeeded","privateEndpointConnections":[],"managedResources":{"resourceGroup":"/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/managed-rg-joheredipv","storageAccount":"/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/managed-rg-joheredipv/providers/Microsoft.Storage/storageAccounts/scaneastusgiaeeoh","eventHubNamespace":"/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/managed-rg-joheredipv/providers/Microsoft.EventHub/namespaces/Atlas-9fe2f965-5f93-4bdf-a811-7221a78e2fdb"},"publicNetworkAccess":"Enabled","managedResourceGroupName":"managed-rg-joheredipv"},"id":"/subscriptions/faa080af-c1d8-40ad-9cce-e1a450ca5b57/resourceGroups/joheredi-test/providers/Microsoft.Purview/accounts/joheredipv","name":"joheredipv","type":"Microsoft.Purview/accounts","location":"eastus","identity":{"type":"SystemAssigned","principalId":"dab894e8-208b-4092-9ddc-71dbb9447e9d","tenantId":"88888888-8888-8888-8888-888888888888"},"tags":{},"systemData":{"createdBy":"joheredi@microsoft.com","createdByType":"User","createdAt":"2021-08-10T17:25:46.5991716Z","lastModifiedByType":"User","lastModifiedAt":"2021-09-15T23:38:59.768035Z"}}, [ - 'Date', - 'Thu, 04 Nov 2021 16:28:36 GMT', - 'Content-Type', - 'application/json; charset=utf-8', - 'Server', - 'Kestrel', - 'Transfer-Encoding', - 'chunked', - 'Strict-Transport-Security', - 'max-age=31536000; includeSubDomains', - 'x-ms-correlation-request-id', - '6f485cbb-2d8f-4bb8-99c4-59c3a114d0ff', - 'x-ms-account-status', - 'Succeeded' -]); diff --git a/sdk/purview/purview-account-rest/recordings/node/list_collections/recording_should_list_all_available_collections.js b/sdk/purview/purview-account-rest/recordings/node/list_collections/recording_should_list_all_available_collections.js deleted file mode 100644 index b6708907f457..000000000000 --- a/sdk/purview/purview-account-rest/recordings/node/list_collections/recording_should_list_all_available_collections.js +++ /dev/null @@ -1,129 +0,0 @@ -let nock = require('nock'); - -module.exports.hash = "79c0a4821517e16a01cb575ad9a8fa83"; - -module.exports.testInfo = {"uniqueName":{},"newDate":{}} - -nock('https://login.microsoftonline.com:443', {"encodedQueryParams":true}) - .get('/common/discovery/instance') - .query(true) - .reply(200, {"tenant_discovery_endpoint":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/v2.0/.well-known/openid-configuration","api-version":"1.1","metadata":[{"preferred_network":"login.microsoftonline.com","preferred_cache":"login.windows.net","aliases":["login.microsoftonline.com","login.windows.net","login.microsoft.com","sts.windows.net"]},{"preferred_network":"login.partner.microsoftonline.cn","preferred_cache":"login.partner.microsoftonline.cn","aliases":["login.partner.microsoftonline.cn","login.chinacloudapi.cn"]},{"preferred_network":"login.microsoftonline.de","preferred_cache":"login.microsoftonline.de","aliases":["login.microsoftonline.de"]},{"preferred_network":"login.microsoftonline.us","preferred_cache":"login.microsoftonline.us","aliases":["login.microsoftonline.us","login.usgovcloudapi.net"]},{"preferred_network":"login-us.microsoftonline.com","preferred_cache":"login-us.microsoftonline.com","aliases":["login-us.microsoftonline.com"]}]}, [ - 'Cache-Control', - 'max-age=86400, private', - 'Content-Type', - 'application/json; charset=utf-8', - 'Strict-Transport-Security', - 'max-age=31536000; includeSubDomains', - 'X-Content-Type-Options', - 'nosniff', - 'Access-Control-Allow-Origin', - '*', - 'Access-Control-Allow-Methods', - 'GET, OPTIONS', - 'P3P', - 'CP="DSP CUR OTPi IND OTRi ONL FIN"', - 'x-ms-request-id', - '52c9e799-c1a5-4425-b1b3-45ed70fa2e00', - 'x-ms-ests-server', - '2.1.12197.4 - SCUS ProdSlices', - 'Set-Cookie', - 'fpc=Aryk7ezWtMRKic3QcsRdIUY; expires=Sat, 04-Dec-2021 16:28:37 GMT; path=/; secure; HttpOnly; SameSite=None', - 'Set-Cookie', - 'esctx=AQABAAAAAAD--DLA3VO7QrddgJg7WevrQnF04b-leBZRXhPeFplK0bTcKM8oL1UCUDPfAMrazwRYYPlcsEyWCM5G5hxRxixNW21_UmG7G07Gao8FaUU3Rs_i0PQC_90HLYTS3cTehR2BGGN88h6mhrtQkenrmD3SDucVB82tdEq95vzA_vtrlPKcGT4U8U9Hmy3hxWmeh8sgAA; domain=.login.microsoftonline.com; path=/; secure; HttpOnly; SameSite=None', - 'Set-Cookie', - 'x-ms-gateway-slice=estsfd; path=/; secure; samesite=none; httponly', - 'Set-Cookie', - 'stsservicecookie=estsfd; path=/; secure; samesite=none; httponly', - 'Date', - 'Thu, 04 Nov 2021 16:28:37 GMT', - 'Content-Length', - '980' -]); - -nock('https://login.microsoftonline.com:443', {"encodedQueryParams":true}) - .get('/88888888-8888-8888-8888-888888888888/v2.0/.well-known/openid-configuration') - .reply(200, {"token_endpoint":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/oauth2/v2.0/token","token_endpoint_auth_methods_supported":["client_secret_post","private_key_jwt","client_secret_basic"],"jwks_uri":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/discovery/v2.0/keys","response_modes_supported":["query","fragment","form_post"],"subject_types_supported":["pairwise"],"id_token_signing_alg_values_supported":["RS256"],"response_types_supported":["code","id_token","code id_token","id_token token"],"scopes_supported":["openid","profile","email","offline_access"],"issuer":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/v2.0","request_uri_parameter_supported":false,"userinfo_endpoint":"https://graph.microsoft.com/oidc/userinfo","authorization_endpoint":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/oauth2/v2.0/authorize","device_authorization_endpoint":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/oauth2/v2.0/devicecode","http_logout_supported":true,"frontchannel_logout_supported":true,"end_session_endpoint":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/oauth2/v2.0/logout","claims_supported":["sub","iss","cloud_instance_name","cloud_instance_host_name","cloud_graph_host_name","msgraph_host","aud","exp","iat","auth_time","acr","nonce","preferred_username","name","tid","ver","at_hash","c_hash","email"],"kerberos_endpoint":"https://login.microsoftonline.com/88888888-8888-8888-8888-888888888888/kerberos","tenant_region_scope":"WW","cloud_instance_name":"microsoftonline.com","cloud_graph_host_name":"graph.windows.net","msgraph_host":"graph.microsoft.com","rbac_url":"https://pas.windows.net"}, [ - 'Cache-Control', - 'max-age=86400, private', - 'Content-Type', - 'application/json; charset=utf-8', - 'Strict-Transport-Security', - 'max-age=31536000; includeSubDomains', - 'X-Content-Type-Options', - 'nosniff', - 'Access-Control-Allow-Origin', - '*', - 'Access-Control-Allow-Methods', - 'GET, OPTIONS', - 'P3P', - 'CP="DSP CUR OTPi IND OTRi ONL FIN"', - 'x-ms-request-id', - 'c51f5b63-7ddc-4dc0-8ba5-89bf6f891e00', - 'x-ms-ests-server', - '2.1.12197.4 - EUS ProdSlices', - 'Set-Cookie', - 'fpc=Ag01qgzza1JIr46xPI-vt8I; expires=Sat, 04-Dec-2021 16:28:37 GMT; path=/; secure; HttpOnly; SameSite=None', - 'Set-Cookie', - 'esctx=AQABAAAAAAD--DLA3VO7QrddgJg7WevrnwMvAMsbPvv4gSMldZYTJo-WHQNozjyZCE0hP_GMXfSbp4mAedtHQMnj6m0cR9Jukh8uUi7mKxMDjbmEJ0BkamVHf_gtUEEBxWCxRpYrS_1aTvQYTjCz2ErQaNcoBqrQgmuORA-PcE8zwWdbKRXzfm_usVIxmenaLFeH2wxhRyEgAA; domain=.login.microsoftonline.com; path=/; secure; HttpOnly; SameSite=None', - 'Set-Cookie', - 'x-ms-gateway-slice=estsfd; path=/; secure; samesite=none; httponly', - 'Set-Cookie', - 'stsservicecookie=estsfd; path=/; secure; samesite=none; httponly', - 'Date', - 'Thu, 04 Nov 2021 16:28:37 GMT', - 'Content-Length', - '1753' -]); - -nock('https://login.microsoftonline.com:443', {"encodedQueryParams":true}) - .post('/88888888-8888-8888-8888-888888888888/oauth2/v2.0/token', "client_id=azure_client_id&scope=https%3A%2F%2Fsanitized%2F&grant_type=client_credentials&x-client-SKU=msal.js.node&x-client-VER=1.3.2&x-client-OS=linux&x-client-CPU=x64&x-ms-lib-capability=retry-after, h429&x-client-current-telemetry=5|771,2,,,|,&x-client-last-telemetry=5|0|||0,0&client-request-id=66a6ba0e-c837-468f-9933-bc47f7f7d80e&client_secret=azure_client_secret&claims=%7B%22access_token%22%3A%7B%22xms_cc%22%3A%7B%22values%22%3A%5B%22CP1%22%5D%7D%7D%7D") - .reply(200, {"token_type":"Bearer","expires_in":86399,"ext_expires_in":86399,"access_token":"access_token"}, [ - 'Cache-Control', - 'no-store, no-cache', - 'Pragma', - 'no-cache', - 'Content-Type', - 'application/json; charset=utf-8', - 'Expires', - '-1', - 'Strict-Transport-Security', - 'max-age=31536000; includeSubDomains', - 'X-Content-Type-Options', - 'nosniff', - 'P3P', - 'CP="DSP CUR OTPi IND OTRi ONL FIN"', - 'x-ms-request-id', - 'c51f5b63-7ddc-4dc0-8ba5-89bf72891e00', - 'x-ms-ests-server', - '2.1.12197.4 - EUS ProdSlices', - 'x-ms-clitelem', - '1,0,0,,', - 'Set-Cookie', - 'fpc=AiflO11QFGpLvDLB4_CyYEs; expires=Sat, 04-Dec-2021 16:28:37 GMT; path=/; secure; HttpOnly; SameSite=None', - 'Set-Cookie', - 'x-ms-gateway-slice=estsfd; path=/; secure; samesite=none; httponly', - 'Set-Cookie', - 'stsservicecookie=estsfd; path=/; secure; samesite=none; httponly', - 'Date', - 'Thu, 04 Nov 2021 16:28:37 GMT', - 'Content-Length', - '1318' -]); - -nock('https://endpoint', {"encodedQueryParams":true}) - .get('/collections') - .query(true) - .reply(200, {"value":[{"name":"joheredipv","friendlyName":"joheredipv","description":"The root collection.","systemData":{"createdBy":"35ac9d32-a8ca-4324-9393-d4000746f07c","createdByType":"User","createdAt":"2021-08-10T17:25:46.5991716Z","lastModifiedByType":"User","lastModifiedAt":"2021-09-15T23:38:59.768035Z"},"collectionProvisioningState":"Succeeded"},{"name":"Collection-lGe","friendlyName":"Collection-lGe","parentCollection":{"type":"CollectionReference","referenceName":"joheredipv"},"systemData":{"createdBy":"35ac9d32-a8ca-4324-9393-d4000746f07c","createdByType":"Application","createdAt":"2021-10-11T20:20:20.1813272Z","lastModifiedByType":"Application","lastModifiedAt":"2021-10-11T20:20:20.1813273Z"},"collectionProvisioningState":"Succeeded"}],"count":2}, [ - 'Date', - 'Thu, 04 Nov 2021 16:28:37 GMT', - 'Content-Type', - 'application/json; charset=utf-8', - 'Server', - 'Kestrel', - 'Transfer-Encoding', - 'chunked', - 'Strict-Transport-Security', - 'max-age=31536000; includeSubDomains', - 'x-ms-correlation-request-id', - '719be534-7c8e-417a-8be7-25bd111391be' -]); diff --git a/sdk/purview/purview-account-rest/review/purview-account.api.md b/sdk/purview/purview-account-rest/review/purview-account.api.md deleted file mode 100644 index cfa50978c63e..000000000000 --- a/sdk/purview/purview-account-rest/review/purview-account.api.md +++ /dev/null @@ -1,806 +0,0 @@ -## API Report File for "@azure-rest/purview-account" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { Client } from '@azure-rest/core-client'; -import { ClientOptions } from '@azure-rest/core-client'; -import { HttpResponse } from '@azure-rest/core-client'; -import { PagedAsyncIterableIterator } from '@azure-rest/core-client-paging'; -import { PathUncheckedResponse } from '@azure-rest/core-client'; -import { RequestParameters } from '@azure-rest/core-client'; -import { TokenCredential } from '@azure/core-auth'; - -// @public (undocumented) -export interface AccessKeyOptions { - keyType?: "PrimaryAtlasKafkaKey" | "SecondaryAtlasKafkaKey"; -} - -// @public (undocumented) -export interface AccessKeys { - atlasKafkaPrimaryEndpoint?: string; - atlasKafkaSecondaryEndpoint?: string; -} - -// @public (undocumented) -export interface Account { - id?: string; - identity?: Identity; - location?: string; - name?: string; - properties?: AccountProperties; - sku?: AccountSku; - systemData?: AccountSystemData; - tags?: Record; - type?: string; -} - -// @public (undocumented) -export interface AccountEndpoints { - catalog?: string; - guardian?: string; - scan?: string; -} - -// @public (undocumented) -export interface AccountProperties { - cloudConnectors?: CloudConnectors; - createdAt?: Date; - createdBy?: string; - createdByObjectId?: string; - endpoints?: AccountPropertiesEndpoints; - friendlyName?: string; - managedResourceGroupName?: string; - managedResources?: AccountPropertiesManagedResources; - privateEndpointConnections?: Array; - provisioningState?: "Unknown" | "Creating" | "Moving" | "Deleting" | "SoftDeleting" | "SoftDeleted" | "Failed" | "Succeeded" | "Canceled"; - publicNetworkAccess?: "NotSpecified" | "Enabled" | "Disabled"; -} - -// @public (undocumented) -export interface AccountPropertiesEndpoints extends AccountEndpoints { -} - -// @public (undocumented) -export interface AccountPropertiesManagedResources extends ManagedResources { -} - -// @public (undocumented) -export interface AccountsGetAccessKeys { - post(options?: AccountsGetAccessKeysParameters): Promise; -} - -// @public -export interface AccountsGetAccessKeys200Response extends HttpResponse { - // (undocumented) - body: AccessKeys; - // (undocumented) - status: "200"; -} - -// @public -export interface AccountsGetAccessKeysdefaultResponse extends HttpResponse { - // (undocumented) - body: ErrorResponseModel; - // (undocumented) - status: "500"; -} - -// @public (undocumented) -export type AccountsGetAccessKeysParameters = RequestParameters; - -// @public (undocumented) -export interface AccountsGetAccountProperties { - get(options?: AccountsGetAccountPropertiesParameters): Promise; - patch(options: AccountsUpdateAccountPropertiesParameters): Promise; -} - -// @public -export interface AccountsGetAccountProperties200Response extends HttpResponse { - // (undocumented) - body: Account; - // (undocumented) - status: "200"; -} - -// @public -export interface AccountsGetAccountPropertiesdefaultResponse extends HttpResponse { - // (undocumented) - body: ErrorResponseModel; - // (undocumented) - status: "500"; -} - -// @public (undocumented) -export type AccountsGetAccountPropertiesParameters = RequestParameters; - -// @public (undocumented) -export interface AccountSku { - capacity?: number; - name?: "Standard"; -} - -// @public (undocumented) -export interface AccountsRegenerateAccessKey { - post(options: AccountsRegenerateAccessKeyParameters): Promise; -} - -// @public -export interface AccountsRegenerateAccessKey200Response extends HttpResponse { - // (undocumented) - body: AccessKeys; - // (undocumented) - status: "200"; -} - -// @public (undocumented) -export interface AccountsRegenerateAccessKeyBodyParam { - // (undocumented) - body: AccessKeyOptions; -} - -// @public -export interface AccountsRegenerateAccessKeydefaultResponse extends HttpResponse { - // (undocumented) - body: ErrorResponseModel; - // (undocumented) - status: "500"; -} - -// @public (undocumented) -export type AccountsRegenerateAccessKeyParameters = AccountsRegenerateAccessKeyBodyParam & RequestParameters; - -// @public -export interface AccountsUpdateAccountProperties200Response extends HttpResponse { - // (undocumented) - body: Account; - // (undocumented) - status: "200"; -} - -// @public (undocumented) -export interface AccountsUpdateAccountPropertiesBodyParam { - // (undocumented) - body: DataPlaneAccountUpdateParameters; -} - -// @public -export interface AccountsUpdateAccountPropertiesdefaultResponse extends HttpResponse { - // (undocumented) - body: ErrorResponseModel; - // (undocumented) - status: "500"; -} - -// @public (undocumented) -export type AccountsUpdateAccountPropertiesParameters = AccountsUpdateAccountPropertiesBodyParam & RequestParameters; - -// @public (undocumented) -export interface AccountSystemData extends SystemData { -} - -// @public (undocumented) -export interface AdvancedResourceSet { - modifiedAt?: Date; - resourceSetProcessing?: "Default" | "Advanced"; -} - -// @public (undocumented) -export interface CloudConnectors { - awsExternalId?: string; -} - -// @public (undocumented) -export interface Collection { - collectionProvisioningState?: "Unknown" | "Creating" | "Moving" | "Deleting" | "Failed" | "Succeeded"; - description?: string; - friendlyName?: string; - name?: string; - parentCollection?: CollectionReference; - systemData?: CollectionSystemData; -} - -// @public (undocumented) -export interface CollectionList { - count?: number; - nextLink?: string; - value: Array; -} - -// @public (undocumented) -export interface CollectionNameResponse { - friendlyName?: string; - name?: string; -} - -// @public (undocumented) -export interface CollectionNameResponseList { - count?: number; - nextLink?: string; - value: Array; -} - -// @public (undocumented) -export interface CollectionPathResponse { - parentFriendlyNameChain?: Array; - parentNameChain?: Array; -} - -// @public (undocumented) -export interface CollectionReference { - referenceName?: string; - type?: string; -} - -// @public -export interface CollectionsCreateOrUpdateCollection200Response extends HttpResponse { - // (undocumented) - body: Collection; - // (undocumented) - status: "200"; -} - -// @public (undocumented) -export interface CollectionsCreateOrUpdateCollectionBodyParam { - // (undocumented) - body: Collection; -} - -// @public -export interface CollectionsCreateOrUpdateCollectiondefaultResponse extends HttpResponse { - // (undocumented) - body: ErrorResponseModel; - // (undocumented) - status: "500"; -} - -// @public (undocumented) -export type CollectionsCreateOrUpdateCollectionParameters = CollectionsCreateOrUpdateCollectionBodyParam & RequestParameters; - -// @public -export interface CollectionsDeleteCollection204Response extends HttpResponse { - // (undocumented) - body: Record; - // (undocumented) - status: "204"; -} - -// @public -export interface CollectionsDeleteCollectiondefaultResponse extends HttpResponse { - // (undocumented) - body: ErrorResponseModel; - // (undocumented) - status: "500"; -} - -// @public (undocumented) -export type CollectionsDeleteCollectionParameters = RequestParameters; - -// @public (undocumented) -export interface CollectionsGetCollection { - delete(options?: CollectionsDeleteCollectionParameters): Promise; - get(options?: CollectionsGetCollectionParameters): Promise; - put(options: CollectionsCreateOrUpdateCollectionParameters): Promise; -} - -// @public -export interface CollectionsGetCollection200Response extends HttpResponse { - // (undocumented) - body: Collection; - // (undocumented) - status: "200"; -} - -// @public -export interface CollectionsGetCollectiondefaultResponse extends HttpResponse { - // (undocumented) - body: ErrorResponseModel; - // (undocumented) - status: "500"; -} - -// @public (undocumented) -export type CollectionsGetCollectionParameters = RequestParameters; - -// @public (undocumented) -export interface CollectionsGetCollectionPath { - get(options?: CollectionsGetCollectionPathParameters): Promise; -} - -// @public -export interface CollectionsGetCollectionPath200Response extends HttpResponse { - // (undocumented) - body: CollectionPathResponse; - // (undocumented) - status: "200"; -} - -// @public -export interface CollectionsGetCollectionPathdefaultResponse extends HttpResponse { - // (undocumented) - body: ErrorResponseModel; - // (undocumented) - status: "500"; -} - -// @public (undocumented) -export type CollectionsGetCollectionPathParameters = RequestParameters; - -// @public (undocumented) -export interface CollectionsListChildCollectionNames { - get(options?: CollectionsListChildCollectionNamesParameters): Promise; -} - -// @public -export interface CollectionsListChildCollectionNames200Response extends HttpResponse { - // (undocumented) - body: CollectionNameResponseList; - // (undocumented) - status: "200"; -} - -// @public -export interface CollectionsListChildCollectionNamesdefaultResponse extends HttpResponse { - // (undocumented) - body: ErrorResponseModel; - // (undocumented) - status: "500"; -} - -// @public (undocumented) -export type CollectionsListChildCollectionNamesParameters = CollectionsListChildCollectionNamesQueryParam & RequestParameters; - -// @public (undocumented) -export interface CollectionsListChildCollectionNamesQueryParam { - // (undocumented) - queryParameters?: CollectionsListChildCollectionNamesQueryParamProperties; -} - -// @public (undocumented) -export interface CollectionsListChildCollectionNamesQueryParamProperties { - // (undocumented) - $skipToken?: string; -} - -// @public (undocumented) -export interface CollectionsListCollections { - get(options?: CollectionsListCollectionsParameters): Promise; -} - -// @public -export interface CollectionsListCollections200Response extends HttpResponse { - // (undocumented) - body: CollectionList; - // (undocumented) - status: "200"; -} - -// @public -export interface CollectionsListCollectionsdefaultResponse extends HttpResponse { - // (undocumented) - body: ErrorResponseModel; - // (undocumented) - status: "500"; -} - -// @public (undocumented) -export type CollectionsListCollectionsParameters = CollectionsListCollectionsQueryParam & RequestParameters; - -// @public (undocumented) -export interface CollectionsListCollectionsQueryParam { - // (undocumented) - queryParameters?: CollectionsListCollectionsQueryParamProperties; -} - -// @public (undocumented) -export interface CollectionsListCollectionsQueryParamProperties { - // (undocumented) - $skipToken?: string; -} - -// @public (undocumented) -export interface CollectionSystemData extends SystemData { -} - -// @public (undocumented) -export interface ComplexReplacerConfig { - // (undocumented) - createdBy?: string; - // (undocumented) - description?: string; - // (undocumented) - disabled?: boolean; - // (undocumented) - disableRecursiveReplacerApplication?: boolean; - // (undocumented) - lastUpdatedTimestamp?: number; - // (undocumented) - modifiedBy?: string; - // (undocumented) - name?: string; - // (undocumented) - typeName?: string; -} - -// @public (undocumented) -export interface DataPlaneAccountUpdateParameters { - friendlyName?: string; -} - -// @public (undocumented) -export interface ErrorModel { - code?: string; - details?: Array; - message?: string; - target?: string; -} - -// @public (undocumented) -export interface ErrorResponseModel { - error?: ErrorResponseModelError; -} - -// @public (undocumented) -export interface ErrorResponseModelError extends ErrorModel { -} - -// @public (undocumented) -export interface FastRegex { - // (undocumented) - maxDigits?: number; - // (undocumented) - maxLetters?: number; - // (undocumented) - minDashes?: number; - // (undocumented) - minDigits?: number; - // (undocumented) - minDigitsOrLetters?: number; - // (undocumented) - minDots?: number; - // (undocumented) - minHex?: number; - // (undocumented) - minLetters?: number; - // (undocumented) - minUnderscores?: number; - // (undocumented) - options?: number; - // (undocumented) - regexStr?: string; -} - -// @public (undocumented) -export interface Filter { - // (undocumented) - createdBy?: string; - // (undocumented) - filterType?: "Pattern" | "Regex"; - // (undocumented) - lastUpdatedTimestamp?: number; - // (undocumented) - modifiedBy?: string; - // (undocumented) - name: string; - // (undocumented) - path: string; -} - -// @public -export type GetArrayType = T extends Array ? TData : never; - -// @public (undocumented) -export interface Identity { - principalId?: string; - tenantId?: string; - type?: "SystemAssigned"; -} - -// @public (undocumented) -export interface ManagedResources { - eventHubNamespace?: string; - resourceGroup?: string; - storageAccount?: string; -} - -// @public (undocumented) -export interface NormalizationRule { - // (undocumented) - description?: string; - // (undocumented) - disabled?: boolean; - // (undocumented) - dynamicReplacement?: boolean; - // (undocumented) - entityTypes?: Array; - // (undocumented) - lastUpdatedTimestamp?: number; - // (undocumented) - name?: string; - // (undocumented) - regex?: FastRegex; - // (undocumented) - replaceWith?: string; - // (undocumented) - version?: number; -} - -// @public -export function paginate(client: Client, initialResponse: TReturn): PagedAsyncIterableIterator, PaginateReturn[]>; - -// @public -export type PaginateReturn = TResult extends { - body: { - value?: infer TPage; - }; -} ? GetArrayType : Array; - -// @public (undocumented) -export interface PathPatternExtractorConfig { - // (undocumented) - acceptedPatterns?: Array; - // (undocumented) - complexReplacers?: Array; - // (undocumented) - createdBy: string; - // (undocumented) - enableDefaultPatterns: boolean; - // (undocumented) - lastUpdatedTimestamp?: number; - // (undocumented) - modifiedBy?: string; - // (undocumented) - normalizationRules?: Array; - // (undocumented) - regexReplacers?: Array; - // (undocumented) - rejectedPatterns?: Array; - // (undocumented) - scopedRules?: Array; - // (undocumented) - version?: number; -} - -// @public (undocumented) -export interface PrivateEndpoint { - id?: string; -} - -// @public (undocumented) -export interface PrivateEndpointConnection { - id?: string; - name?: string; - properties?: PrivateEndpointConnectionProperties; - type?: string; -} - -// @public (undocumented) -export interface PrivateEndpointConnectionProperties { - privateEndpoint?: PrivateEndpoint; - privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState; - provisioningState?: string; -} - -// @public (undocumented) -export interface PrivateLinkServiceConnectionState { - actionsRequired?: string; - description?: string; - status?: "Unknown" | "Pending" | "Approved" | "Rejected" | "Disconnected"; -} - -// @public (undocumented) -function PurviewAccount(endpoint: string, credentials: TokenCredential, options?: ClientOptions): PurviewAccountRestClient; - -export default PurviewAccount; - -// @public (undocumented) -export type PurviewAccountRestClient = Client & { - path: Routes; -}; - -// @public (undocumented) -export interface RegexReplacer { - // (undocumented) - condition?: string; - // (undocumented) - createdBy?: string; - // (undocumented) - description?: string; - // (undocumented) - disabled: boolean; - // (undocumented) - disableRecursiveReplacerApplication?: boolean; - // (undocumented) - doNotReplaceRegex?: FastRegex; - // (undocumented) - lastUpdatedTimestamp?: number; - // (undocumented) - modifiedBy?: string; - // (undocumented) - name: string; - // (undocumented) - regex?: FastRegex; - // (undocumented) - replaceWith?: string; -} - -// @public (undocumented) -export interface ResourceSetRuleConfig { - advancedResourceSet?: AdvancedResourceSet; - name?: string; - pathPatternConfig?: PathPatternExtractorConfig; -} - -// @public (undocumented) -export interface ResourceSetRuleConfigList { - count?: number; - nextLink?: string; - value: Array; -} - -// @public -export interface ResourceSetRulesCreateOrUpdateResourceSetRule200Response extends HttpResponse { - // (undocumented) - body: ResourceSetRuleConfig; - // (undocumented) - status: "200"; -} - -// @public (undocumented) -export interface ResourceSetRulesCreateOrUpdateResourceSetRuleBodyParam { - // (undocumented) - body: ResourceSetRuleConfig; -} - -// @public -export interface ResourceSetRulesCreateOrUpdateResourceSetRuledefaultResponse extends HttpResponse { - // (undocumented) - body: ErrorResponseModel; - // (undocumented) - status: "500"; -} - -// @public (undocumented) -export type ResourceSetRulesCreateOrUpdateResourceSetRuleParameters = ResourceSetRulesCreateOrUpdateResourceSetRuleBodyParam & RequestParameters; - -// @public -export interface ResourceSetRulesDeleteResourceSetRule200Response extends HttpResponse { - // (undocumented) - body: Record; - // (undocumented) - status: "200"; -} - -// @public -export interface ResourceSetRulesDeleteResourceSetRule204Response extends HttpResponse { - // (undocumented) - body: Record; - // (undocumented) - status: "204"; -} - -// @public -export interface ResourceSetRulesDeleteResourceSetRuledefaultResponse extends HttpResponse { - // (undocumented) - body: ErrorResponseModel; - // (undocumented) - status: "500"; -} - -// @public (undocumented) -export type ResourceSetRulesDeleteResourceSetRuleParameters = RequestParameters; - -// @public (undocumented) -export interface ResourceSetRulesGetResourceSetRule { - delete(options?: ResourceSetRulesDeleteResourceSetRuleParameters): Promise; - get(options?: ResourceSetRulesGetResourceSetRuleParameters): Promise; - put(options: ResourceSetRulesCreateOrUpdateResourceSetRuleParameters): Promise; -} - -// @public -export interface ResourceSetRulesGetResourceSetRule200Response extends HttpResponse { - // (undocumented) - body: ResourceSetRuleConfig; - // (undocumented) - status: "200"; -} - -// @public -export interface ResourceSetRulesGetResourceSetRuledefaultResponse extends HttpResponse { - // (undocumented) - body: ErrorResponseModel; - // (undocumented) - status: "500"; -} - -// @public (undocumented) -export type ResourceSetRulesGetResourceSetRuleParameters = RequestParameters; - -// @public (undocumented) -export interface ResourceSetRulesListResourceSetRules { - get(options?: ResourceSetRulesListResourceSetRulesParameters): Promise; -} - -// @public -export interface ResourceSetRulesListResourceSetRules200Response extends HttpResponse { - // (undocumented) - body: ResourceSetRuleConfigList; - // (undocumented) - status: "200"; -} - -// @public -export interface ResourceSetRulesListResourceSetRulesdefaultResponse extends HttpResponse { - // (undocumented) - body: ErrorResponseModel; - // (undocumented) - status: "500"; -} - -// @public (undocumented) -export type ResourceSetRulesListResourceSetRulesParameters = ResourceSetRulesListResourceSetRulesQueryParam & RequestParameters; - -// @public (undocumented) -export interface ResourceSetRulesListResourceSetRulesQueryParam { - // (undocumented) - queryParameters?: ResourceSetRulesListResourceSetRulesQueryParamProperties; -} - -// @public (undocumented) -export interface ResourceSetRulesListResourceSetRulesQueryParamProperties { - // (undocumented) - $skipToken?: string; -} - -// @public (undocumented) -export interface Routes { - (path: "/"): AccountsGetAccountProperties; - (path: "/listkeys"): AccountsGetAccessKeys; - (path: "/regeneratekeys"): AccountsRegenerateAccessKey; - (path: "/collections/{collectionName}", collectionName: string): CollectionsGetCollection; - (path: "/collections"): CollectionsListCollections; - (path: "/collections/{collectionName}/getChildCollectionNames", collectionName: string): CollectionsListChildCollectionNames; - (path: "/collections/{collectionName}/getCollectionPath", collectionName: string): CollectionsGetCollectionPath; - (path: "/resourceSetRuleConfigs/defaultResourceSetRuleConfig"): ResourceSetRulesGetResourceSetRule; - (path: "/resourceSetRuleConfigs"): ResourceSetRulesListResourceSetRules; -} - -// @public (undocumented) -export interface Rule { - // (undocumented) - displayName?: string; - // (undocumented) - isResourceSet?: boolean; - // (undocumented) - lastUpdatedTimestamp?: number; - // (undocumented) - name?: string; - // (undocumented) - qualifiedName: string; -} - -// @public (undocumented) -export interface ScopedRule { - // (undocumented) - bindingUrl: string; - // (undocumented) - rules?: Array; - // (undocumented) - storeType: string; -} - -// @public (undocumented) -export interface SystemData { - createdAt?: Date; - createdBy?: string; - createdByType?: "User" | "Application" | "ManagedIdentity" | "Key"; - lastModifiedAt?: Date; - lastModifiedBy?: string; - lastModifiedByType?: "User" | "Application" | "ManagedIdentity" | "Key"; -} - - -// (No @packageDocumentation comment for this package) - -``` diff --git a/sdk/purview/purview-account-rest/rollup.config.js b/sdk/purview/purview-account-rest/rollup.config.js deleted file mode 100644 index 5d7deee44c14..000000000000 --- a/sdk/purview/purview-account-rest/rollup.config.js +++ /dev/null @@ -1,3 +0,0 @@ -import { makeConfig } from "@azure/dev-tool/shared-config/rollup"; - -export default makeConfig(require("./package.json")); diff --git a/sdk/purview/purview-account-rest/sample.env b/sdk/purview/purview-account-rest/sample.env deleted file mode 100644 index 5c39228ebdd0..000000000000 --- a/sdk/purview/purview-account-rest/sample.env +++ /dev/null @@ -1,7 +0,0 @@ -# Purview Scanning resource endpoint -ENDPOINT= - -# App registration secret for AAD authentication -AZURE_CLIENT_SECRET= -AZURE_CLIENT_ID= -AZURE_TENANT_ID= diff --git a/sdk/purview/purview-account-rest/samples-dev/collections.ts b/sdk/purview/purview-account-rest/samples-dev/collections.ts deleted file mode 100644 index 724a968d5858..000000000000 --- a/sdk/purview/purview-account-rest/samples-dev/collections.ts +++ /dev/null @@ -1,36 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -/** - * This sample demonstrates how get a list of collections - * - * @summary gets a list of collections - * @azsdk-weight 40 - */ - -import PurviewAccount, { paginate } from "@azure-rest/purview-account"; -import { DefaultAzureCredential } from "@azure/identity"; -import dotenv from "dotenv"; - -dotenv.config(); - -const endpoint = process.env["ENDPOINT"] || ""; - -async function main() { - console.log("== List collections sample =="); - const client = PurviewAccount(endpoint, new DefaultAzureCredential()); - - const response = await client.path("/collections").get(); - - if (response.status !== "200") { - console.log(`GET "/collections" failed with ${response.status}`); - } - - const dataSources = paginate(client, response); - - for await (const dataSource of dataSources) { - console.log(dataSource); - } -} - -main().catch(console.error); diff --git a/sdk/purview/purview-account-rest/samples/v1/javascript/README.md b/sdk/purview/purview-account-rest/samples/v1/javascript/README.md deleted file mode 100644 index 2f5ea127846d..000000000000 --- a/sdk/purview/purview-account-rest/samples/v1/javascript/README.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -page_type: sample -languages: - - javascript -products: - - azure -urlFragment: purview-account-javascript -disableDocsMs: true ---- - -# Azure Purview Account rest client library samples for JavaScript - -These sample programs show how to use the JavaScript client libraries for Azure Purview Account rest in some common scenarios. - -| **File Name** | **Description** | -| ----------------------------- | -------------------------- | -| [collections.js][collections] | gets a list of collections | - -## Prerequisites - -The sample programs are compatible with Node.js >=14.0.0. - -You need [an Azure subscription][freesub] and the following Azure resources to run these sample programs: - -- [Azure Purview Account][createpurviewaccount_portal] - -Samples retrieve credentials to access the service endpoint from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function. - -Adapting the samples to run in the browser may require some additional consideration. For details, please see the [package README][package]. - -## Setup - -To run the samples using the published version of the package: - -1. Install the dependencies using `npm`: - -```bash -npm install -``` - -2. Edit the file `sample.env`, adding the correct credentials to access the Azure service and run the samples. Then rename the file from `sample.env` to just `.env`. The sample programs will read this file automatically. - -3. Run whichever samples you like (note that some samples may require additional setup, see the table above): - -```bash -node collections.js -``` - -Alternatively, run a single sample with the correct environment variables set (setting up the `.env` file is not required if you do this), for example (cross-platform): - -```bash -npx cross-env ENDPOINT="" node collections.js -``` - -## Next Steps - -Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients. - -[collections]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/purview/purview-account-rest/samples/v1/javascript/collections.js -[apiref]: https://docs.microsoft.com/azure/purview/tutorial-using-rest-apis -[freesub]: https://azure.microsoft.com/free/ -[createpurviewaccount_portal]: https://docs.microsoft.com/azure/purview/create-catalog-portal -[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/purview/purview-account-rest/README.md diff --git a/sdk/purview/purview-account-rest/samples/v1/javascript/collections.js b/sdk/purview/purview-account-rest/samples/v1/javascript/collections.js deleted file mode 100644 index be2177c1a8d4..000000000000 --- a/sdk/purview/purview-account-rest/samples/v1/javascript/collections.js +++ /dev/null @@ -1,31 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -/** - * This sample demonstrates how get a list of collections - * - * @summary gets a list of collections - */ - -const PurviewAccount = require("@azure-rest/purview-Account"); -const { DefaultAzureCredential } = require("@azure/identity"); -const dotenv = require("dotenv"); - -dotenv.config(); - -const endpoint = process.env["ENDPOINT"] || ""; - -async function main() { - console.log("== List collections sample =="); - const client = PurviewAccount(endpoint, new DefaultAzureCredential()); - - const response = await client.path("/collections").get(); - - if (response.status !== "200") { - console.log(`GET "/collections" failed with ${response.status}`); - } - - console.log(response.body); -} - -main().catch(console.error); diff --git a/sdk/purview/purview-account-rest/samples/v1/javascript/package.json b/sdk/purview/purview-account-rest/samples/v1/javascript/package.json deleted file mode 100644 index 1155b5936bd6..000000000000 --- a/sdk/purview/purview-account-rest/samples/v1/javascript/package.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "name": "azure-purview-account-samples-js", - "private": true, - "version": "1.0.0", - "description": "Azure Purview Scanning rest client library samples for JavaScript", - "engine": { - "node": ">=12.0.0" - }, - "repository": { - "type": "git", - "url": "git+https://github.com/Azure/azure-sdk-for-js.git", - "directory": "sdk/purview/purview-account-rest" - }, - "keywords": [ - "node", - "azure", - "cloud", - "typescript", - "browser", - "isomorphic" - ], - "author": "Microsoft Corporation", - "license": "MIT", - "bugs": { - "url": "https://github.com/Azure/azure-sdk-for-js/issues" - }, - "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/purview/purview-account-rest", - "dependencies": { - "@azure-rest/purview-account": "next", - "dotenv": "latest", - "@azure/identity": "^2.0.1" - } -} diff --git a/sdk/purview/purview-account-rest/samples/v1/javascript/sample.env b/sdk/purview/purview-account-rest/samples/v1/javascript/sample.env deleted file mode 100644 index 5c39228ebdd0..000000000000 --- a/sdk/purview/purview-account-rest/samples/v1/javascript/sample.env +++ /dev/null @@ -1,7 +0,0 @@ -# Purview Scanning resource endpoint -ENDPOINT= - -# App registration secret for AAD authentication -AZURE_CLIENT_SECRET= -AZURE_CLIENT_ID= -AZURE_TENANT_ID= diff --git a/sdk/purview/purview-account-rest/samples/v1/typescript/README.md b/sdk/purview/purview-account-rest/samples/v1/typescript/README.md deleted file mode 100644 index f186f7bf8ab6..000000000000 --- a/sdk/purview/purview-account-rest/samples/v1/typescript/README.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -page_type: sample -languages: - - typescript -products: - - azure -urlFragment: purview-account-typescript -disableDocsMs: true ---- - -# Azure Purview Scanning rest client library samples for TypeScript - -These sample programs show how to use the TypeScript client libraries for Azure Purview Scanning rest in some common scenarios. - -| **File Name** | **Description** | -| ----------------------------- | -------------------------- | -| [collections.ts][collections] | gets a list of collections | - -## Prerequisites - -The sample programs are compatible with Node.js >=14.0.0. - -Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript]. Install the TypeScript compiler using: - -```bash -npm install -g typescript -``` - -You need [an Azure subscription][freesub] and the following Azure resources to run these sample programs: - -- [Azure Purview Account][createpurviewaccount_portal] - -Samples retrieve credentials to access the service endpoint from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function. - -Adapting the samples to run in the browser may require some additional consideration. For details, please see the [package README][package]. - -## Setup - -To run the samples using the published version of the package: - -1. Install the dependencies using `npm`: - -```bash -npm install -``` - -2. Compile the samples: - -```bash -npm run build -``` - -3. Edit the file `sample.env`, adding the correct credentials to access the Azure service and run the samples. Then rename the file from `sample.env` to just `.env`. The sample programs will read this file automatically. - -4. Run whichever samples you like (note that some samples may require additional setup, see the table above): - -```bash -node dist/collections.js -``` - -Alternatively, run a single sample with the correct environment variables set (setting up the `.env` file is not required if you do this), for example (cross-platform): - -```bash -npx cross-env ENDPOINT="" node dist/collections.js -``` - -## Next Steps - -Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients. - -[collections]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/purview/purview-account-rest/samples/v1/javascript/collections.js -[apiref]: https://docs.microsoft.com/azure/purview/tutorial-using-rest-apis -[freesub]: https://azure.microsoft.com/free/ -[createpurviewaccount_portal]: https://docs.microsoft.com/azure/purview/create-catalog-portal -[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/purview/purview-account-rest/README.md -[typescript]: https://www.typescriptlang.org/docs/home.html diff --git a/sdk/purview/purview-account-rest/samples/v1/typescript/package.json b/sdk/purview/purview-account-rest/samples/v1/typescript/package.json deleted file mode 100644 index 32c9b89b7e21..000000000000 --- a/sdk/purview/purview-account-rest/samples/v1/typescript/package.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "name": "azure-purview-account-samples-ts", - "private": true, - "version": "1.0.0", - "description": "Azure Purview Scanning rest client library samples for TypeScript", - "engine": { - "node": ">=12.0.0" - }, - "scripts": { - "build": "tsc", - "prebuild": "rimraf dist/" - }, - "repository": { - "type": "git", - "url": "git+https://github.com/Azure/azure-sdk-for-js.git", - "directory": "sdk/purview/purview-account-rest" - }, - "keywords": [ - "node", - "azure", - "cloud", - "typescript", - "browser", - "isomorphic" - ], - "author": "Microsoft Corporation", - "license": "MIT", - "bugs": { - "url": "https://github.com/Azure/azure-sdk-for-js/issues" - }, - "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/purview/purview-account-rest", - "dependencies": { - "@azure-rest/purview-account": "next", - "dotenv": "latest", - "@azure/identity": "^2.0.1" - }, - "devDependencies": { - "typescript": "~4.2.0", - "rimraf": "latest" - } -} diff --git a/sdk/purview/purview-account-rest/samples/v1/typescript/sample.env b/sdk/purview/purview-account-rest/samples/v1/typescript/sample.env deleted file mode 100644 index 5c39228ebdd0..000000000000 --- a/sdk/purview/purview-account-rest/samples/v1/typescript/sample.env +++ /dev/null @@ -1,7 +0,0 @@ -# Purview Scanning resource endpoint -ENDPOINT= - -# App registration secret for AAD authentication -AZURE_CLIENT_SECRET= -AZURE_CLIENT_ID= -AZURE_TENANT_ID= diff --git a/sdk/purview/purview-account-rest/samples/v1/typescript/src/collections.ts b/sdk/purview/purview-account-rest/samples/v1/typescript/src/collections.ts deleted file mode 100644 index f63c9f8fecf3..000000000000 --- a/sdk/purview/purview-account-rest/samples/v1/typescript/src/collections.ts +++ /dev/null @@ -1,31 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT License. - -/** - * This sample demonstrates how get a list of collections - * - * @summary gets a list of collections - */ - -import PurviewAccount from "@azure-rest/purview-account"; -import { DefaultAzureCredential } from "@azure/identity"; -import dotenv from "dotenv"; - -dotenv.config(); - -const endpoint = process.env["ENDPOINT"] || ""; - -async function main() { - console.log("== List collections sample =="); - const client = PurviewAccount(endpoint, new DefaultAzureCredential()); - - const response = await client.path("/collections").get(); - - if (response.status !== "200") { - console.log(`GET "/collections" failed with ${response.status}`); - } - - console.log(response.body); -} - -main().catch(console.error); diff --git a/sdk/purview/purview-account-rest/samples/v1/typescript/tsconfig.json b/sdk/purview/purview-account-rest/samples/v1/typescript/tsconfig.json deleted file mode 100644 index 416c2dd82e00..000000000000 --- a/sdk/purview/purview-account-rest/samples/v1/typescript/tsconfig.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "compilerOptions": { - "target": "ES2018", - "module": "commonjs", - "moduleResolution": "node", - "resolveJsonModule": true, - "esModuleInterop": true, - "allowSyntheticDefaultImports": true, - "strict": true, - "alwaysStrict": true, - "outDir": "dist", - "rootDir": "src" - }, - "include": [ - "src/**.ts" - ] -} diff --git a/sdk/purview/purview-account-rest/src/index.ts b/sdk/purview/purview-account-rest/src/index.ts deleted file mode 100644 index 04978f588609..000000000000 --- a/sdk/purview/purview-account-rest/src/index.ts +++ /dev/null @@ -1,13 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -import PurviewAccount from "./purviewAccount"; - -export * from "./purviewAccount"; -export * from "./models"; -export * from "./parameters"; -export * from "./responses"; - -export { paginate, PaginateReturn, GetArrayType } from "./paginateHelper"; - -export default PurviewAccount; diff --git a/sdk/purview/purview-account-rest/src/models.ts b/sdk/purview/purview-account-rest/src/models.ts deleted file mode 100644 index de4b9b9277de..000000000000 --- a/sdk/purview/purview-account-rest/src/models.ts +++ /dev/null @@ -1,367 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -export interface Account { - /** Gets or sets the identifier. */ - id?: string; - /** Identity Info on the tracked resource */ - identity?: Identity; - /** Gets or sets the location. */ - location?: string; - /** Gets or sets the name. */ - name?: string; - /** Gets or sets the properties. */ - properties?: AccountProperties; - /** Gets or sets the Sku. */ - sku?: AccountSku; - /** Metadata pertaining to creation and last modification of the resource. */ - systemData?: AccountSystemData; - /** Tags on the azure resource. */ - tags?: Record; - /** Gets or sets the type. */ - type?: string; -} - -export interface Identity { - /** Service principal object Id */ - principalId?: string; - /** Tenant Id */ - tenantId?: string; - /** Identity Type */ - type?: "SystemAssigned"; -} - -export interface AccountProperties { - /** - * Cloud connectors. - * External cloud identifier used as part of scanning configuration. - */ - cloudConnectors?: CloudConnectors; - /** Gets the time at which the entity was created. */ - createdAt?: Date; - /** Gets the creator of the entity. */ - createdBy?: string; - /** Gets the creators of the entity's object id. */ - createdByObjectId?: string; - /** The URIs that are the public endpoints of the account. */ - endpoints?: AccountPropertiesEndpoints; - /** Gets or sets the friendly name. */ - friendlyName?: string; - /** Gets or sets the managed resource group name */ - managedResourceGroupName?: string; - /** Gets the resource identifiers of the managed resources. */ - managedResources?: AccountPropertiesManagedResources; - /** Gets the private endpoint connections information. */ - privateEndpointConnections?: Array; - /** Gets or sets the state of the provisioning. */ - provisioningState?: - | "Unknown" - | "Creating" - | "Moving" - | "Deleting" - | "SoftDeleting" - | "SoftDeleted" - | "Failed" - | "Succeeded" - | "Canceled"; - /** Gets or sets the public network access. */ - publicNetworkAccess?: "NotSpecified" | "Enabled" | "Disabled"; -} - -export interface CloudConnectors { - /** - * AWS external identifier. - * Configured in AWS to allow use of the role arn used for scanning - */ - awsExternalId?: string; -} - -export interface AccountEndpoints { - /** Gets the catalog endpoint. */ - catalog?: string; - /** Gets the guardian endpoint. */ - guardian?: string; - /** Gets the scan endpoint. */ - scan?: string; -} - -export interface AccountPropertiesEndpoints extends AccountEndpoints {} - -export interface ManagedResources { - /** Gets the managed event hub namespace resource identifier. */ - eventHubNamespace?: string; - /** Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account. */ - resourceGroup?: string; - /** Gets the managed storage account resource identifier. */ - storageAccount?: string; -} - -export interface AccountPropertiesManagedResources extends ManagedResources {} - -export interface PrivateEndpointConnection { - /** Gets or sets the identifier. */ - id?: string; - /** Gets or sets the name. */ - name?: string; - /** The connection identifier. */ - properties?: PrivateEndpointConnectionProperties; - /** Gets or sets the type. */ - type?: string; -} - -export interface PrivateEndpointConnectionProperties { - /** The private endpoint information. */ - privateEndpoint?: PrivateEndpoint; - /** The private link service connection state. */ - privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState; - /** The provisioning state. */ - provisioningState?: string; -} - -export interface PrivateEndpoint { - /** The private endpoint identifier. */ - id?: string; -} - -export interface PrivateLinkServiceConnectionState { - /** The required actions. */ - actionsRequired?: string; - /** The description. */ - description?: string; - /** The status. */ - status?: "Unknown" | "Pending" | "Approved" | "Rejected" | "Disconnected"; -} - -export interface AccountSku { - /** Gets or sets the sku capacity. Possible values include: 4, 16 */ - capacity?: number; - /** Gets or sets the sku name. */ - name?: "Standard"; -} - -export interface SystemData { - /** The timestamp of resource creation (UTC). */ - createdAt?: Date; - /** The identity that created the resource. */ - createdBy?: string; - /** The type of identity that created the resource. */ - createdByType?: "User" | "Application" | "ManagedIdentity" | "Key"; - /** The timestamp of the last modification the resource (UTC). */ - lastModifiedAt?: Date; - /** The identity that last modified the resource. */ - lastModifiedBy?: string; - /** The type of identity that last modified the resource. */ - lastModifiedByType?: "User" | "Application" | "ManagedIdentity" | "Key"; -} - -export interface AccountSystemData extends SystemData {} - -export interface ErrorResponseModel { - /** Gets or sets the error. */ - error?: ErrorResponseModelError; -} - -export interface ErrorModel { - /** Gets or sets the code. */ - code?: string; - /** Gets or sets the details. */ - details?: Array; - /** Gets or sets the messages. */ - message?: string; - /** Gets or sets the target. */ - target?: string; -} - -export interface ErrorResponseModelError extends ErrorModel {} - -export interface DataPlaneAccountUpdateParameters { - /** The friendly name for the azure resource. */ - friendlyName?: string; -} - -export interface AccessKeys { - /** Gets or sets the primary connection string. */ - atlasKafkaPrimaryEndpoint?: string; - /** Gets or sets the secondary connection string. */ - atlasKafkaSecondaryEndpoint?: string; -} - -export interface AccessKeyOptions { - /** The access key type. */ - keyType?: "PrimaryAtlasKafkaKey" | "SecondaryAtlasKafkaKey"; -} - -export interface Collection { - /** Gets the state of the provisioning. */ - collectionProvisioningState?: - | "Unknown" - | "Creating" - | "Moving" - | "Deleting" - | "Failed" - | "Succeeded"; - /** Gets or sets the description. */ - description?: string; - /** Gets or sets the friendly name of the collection. */ - friendlyName?: string; - /** Gets the name. */ - name?: string; - /** Gets or sets the parent collection reference. */ - parentCollection?: CollectionReference; - /** Gets the system data that contains information about who and when created and updated the resource. */ - systemData?: CollectionSystemData; -} - -export interface CollectionReference { - /** Gets or sets the reference name. */ - referenceName?: string; - /** Gets the reference type property. */ - type?: string; -} - -export interface CollectionSystemData extends SystemData {} - -export interface CollectionList { - /** Total item count. */ - count?: number; - /** The Url of next result page. */ - nextLink?: string; - /** Collection of items of type results. */ - value: Array; -} - -export interface CollectionNameResponseList { - /** Total item count. */ - count?: number; - /** The Url of next result page. */ - nextLink?: string; - /** Collection of items of type results. */ - value: Array; -} - -export interface CollectionNameResponse { - /** Gets or sets the friendly name of the collection. */ - friendlyName?: string; - /** Gets the name. */ - name?: string; -} - -export interface CollectionPathResponse { - /** The friendly names of ancestors starting from the default (root) collection and ending with the immediate parent. */ - parentFriendlyNameChain?: Array; - /** The names of ancestors starting from the default (root) collection and ending with the immediate parent. */ - parentNameChain?: Array; -} - -export interface ResourceSetRuleConfig { - /** Gets or sets the advanced resource set property of the account. */ - advancedResourceSet?: AdvancedResourceSet; - /** The name of the rule */ - name?: string; - /** The configuration rules for path pattern extraction. */ - pathPatternConfig?: PathPatternExtractorConfig; -} - -export interface AdvancedResourceSet { - /** Date at which ResourceSetProcessing property of the account is updated. */ - modifiedAt?: Date; - /** The advanced resource property of the account. */ - resourceSetProcessing?: "Default" | "Advanced"; -} - -export interface PathPatternExtractorConfig { - acceptedPatterns?: Array; - complexReplacers?: Array; - createdBy: string; - enableDefaultPatterns: boolean; - lastUpdatedTimestamp?: number; - modifiedBy?: string; - normalizationRules?: Array; - regexReplacers?: Array; - rejectedPatterns?: Array; - scopedRules?: Array; - version?: number; -} - -export interface Filter { - createdBy?: string; - filterType?: "Pattern" | "Regex"; - lastUpdatedTimestamp?: number; - modifiedBy?: string; - name: string; - path: string; -} - -export interface ComplexReplacerConfig { - createdBy?: string; - description?: string; - disabled?: boolean; - disableRecursiveReplacerApplication?: boolean; - lastUpdatedTimestamp?: number; - modifiedBy?: string; - name?: string; - typeName?: string; -} - -export interface NormalizationRule { - description?: string; - disabled?: boolean; - dynamicReplacement?: boolean; - entityTypes?: Array; - lastUpdatedTimestamp?: number; - name?: string; - regex?: FastRegex; - replaceWith?: string; - version?: number; -} - -export interface FastRegex { - maxDigits?: number; - maxLetters?: number; - minDashes?: number; - minDigits?: number; - minDigitsOrLetters?: number; - minDots?: number; - minHex?: number; - minLetters?: number; - minUnderscores?: number; - options?: number; - regexStr?: string; -} - -export interface RegexReplacer { - condition?: string; - createdBy?: string; - description?: string; - disabled: boolean; - disableRecursiveReplacerApplication?: boolean; - doNotReplaceRegex?: FastRegex; - lastUpdatedTimestamp?: number; - modifiedBy?: string; - name: string; - regex?: FastRegex; - replaceWith?: string; -} - -export interface ScopedRule { - bindingUrl: string; - rules?: Array; - storeType: string; -} - -export interface Rule { - displayName?: string; - isResourceSet?: boolean; - lastUpdatedTimestamp?: number; - name?: string; - qualifiedName: string; -} - -export interface ResourceSetRuleConfigList { - /** Total item count. */ - count?: number; - /** The Url of next result page. */ - nextLink?: string; - /** Collection of items of type results. */ - value: Array; -} diff --git a/sdk/purview/purview-account-rest/src/paginateHelper.ts b/sdk/purview/purview-account-rest/src/paginateHelper.ts deleted file mode 100644 index c41ee6075407..000000000000 --- a/sdk/purview/purview-account-rest/src/paginateHelper.ts +++ /dev/null @@ -1,36 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -import { paginateResponse, PagedAsyncIterableIterator } from "@azure-rest/core-client-paging"; -import { Client, PathUncheckedResponse } from "@azure-rest/core-client"; - -/** - * Helper type to extract the type of an array - */ -export type GetArrayType = T extends Array ? TData : never; - -/** - * Helper type to infer the Type of the paged elements from the response type - * This type is generated based on the swagger information for x-ms-pageable - * specifically on the itemName property which indicates the property of the response - * where the page items are found. The default value is `value`. - * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter - */ -export type PaginateReturn = TResult extends { - body: { value?: infer TPage }; -} - ? GetArrayType - : Array; - -/** - * Helper function to get PagedAsyncIterableIterator to paginate results starting from a given response. - * @param client - Client to use for sending the next page requests - * @param initialResponse - Initial response containing the nextLink and current page of elements - * @returns - PagedAsyncIterableIterator to iterate the elements - */ -export function paginate( - client: Client, - initialResponse: TReturn -): PagedAsyncIterableIterator, PaginateReturn[]> { - return paginateResponse>(client, initialResponse); -} diff --git a/sdk/purview/purview-account-rest/src/parameters.ts b/sdk/purview/purview-account-rest/src/parameters.ts deleted file mode 100644 index e2e9a5258fb4..000000000000 --- a/sdk/purview/purview-account-rest/src/parameters.ts +++ /dev/null @@ -1,79 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -import { RequestParameters } from "@azure-rest/core-client"; -import { - DataPlaneAccountUpdateParameters, - AccessKeyOptions, - Collection, - ResourceSetRuleConfig, -} from "./models"; - -export type AccountsGetAccountPropertiesParameters = RequestParameters; - -export interface AccountsUpdateAccountPropertiesBodyParam { - body: DataPlaneAccountUpdateParameters; -} - -export type AccountsUpdateAccountPropertiesParameters = AccountsUpdateAccountPropertiesBodyParam & - RequestParameters; -export type AccountsGetAccessKeysParameters = RequestParameters; - -export interface AccountsRegenerateAccessKeyBodyParam { - body: AccessKeyOptions; -} - -export type AccountsRegenerateAccessKeyParameters = AccountsRegenerateAccessKeyBodyParam & - RequestParameters; -export type CollectionsGetCollectionParameters = RequestParameters; - -export interface CollectionsCreateOrUpdateCollectionBodyParam { - body: Collection; -} - -export type CollectionsCreateOrUpdateCollectionParameters = - CollectionsCreateOrUpdateCollectionBodyParam & RequestParameters; -export type CollectionsDeleteCollectionParameters = RequestParameters; - -export interface CollectionsListCollectionsQueryParamProperties { - $skipToken?: string; -} - -export interface CollectionsListCollectionsQueryParam { - queryParameters?: CollectionsListCollectionsQueryParamProperties; -} - -export type CollectionsListCollectionsParameters = CollectionsListCollectionsQueryParam & - RequestParameters; - -export interface CollectionsListChildCollectionNamesQueryParamProperties { - $skipToken?: string; -} - -export interface CollectionsListChildCollectionNamesQueryParam { - queryParameters?: CollectionsListChildCollectionNamesQueryParamProperties; -} - -export type CollectionsListChildCollectionNamesParameters = - CollectionsListChildCollectionNamesQueryParam & RequestParameters; -export type CollectionsGetCollectionPathParameters = RequestParameters; -export type ResourceSetRulesGetResourceSetRuleParameters = RequestParameters; - -export interface ResourceSetRulesCreateOrUpdateResourceSetRuleBodyParam { - body: ResourceSetRuleConfig; -} - -export type ResourceSetRulesCreateOrUpdateResourceSetRuleParameters = - ResourceSetRulesCreateOrUpdateResourceSetRuleBodyParam & RequestParameters; -export type ResourceSetRulesDeleteResourceSetRuleParameters = RequestParameters; - -export interface ResourceSetRulesListResourceSetRulesQueryParamProperties { - $skipToken?: string; -} - -export interface ResourceSetRulesListResourceSetRulesQueryParam { - queryParameters?: ResourceSetRulesListResourceSetRulesQueryParamProperties; -} - -export type ResourceSetRulesListResourceSetRulesParameters = - ResourceSetRulesListResourceSetRulesQueryParam & RequestParameters; diff --git a/sdk/purview/purview-account-rest/src/purviewAccount.ts b/sdk/purview/purview-account-rest/src/purviewAccount.ts deleted file mode 100644 index c9e35fc16059..000000000000 --- a/sdk/purview/purview-account-rest/src/purviewAccount.ts +++ /dev/null @@ -1,206 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -import { - AccountsGetAccountPropertiesParameters, - AccountsUpdateAccountPropertiesParameters, - AccountsGetAccessKeysParameters, - AccountsRegenerateAccessKeyParameters, - CollectionsGetCollectionParameters, - CollectionsCreateOrUpdateCollectionParameters, - CollectionsDeleteCollectionParameters, - CollectionsListCollectionsParameters, - CollectionsListChildCollectionNamesParameters, - CollectionsGetCollectionPathParameters, - ResourceSetRulesGetResourceSetRuleParameters, - ResourceSetRulesCreateOrUpdateResourceSetRuleParameters, - ResourceSetRulesDeleteResourceSetRuleParameters, - ResourceSetRulesListResourceSetRulesParameters, -} from "./parameters"; -import { - AccountsGetAccountProperties200Response, - AccountsGetAccountPropertiesdefaultResponse, - AccountsUpdateAccountProperties200Response, - AccountsUpdateAccountPropertiesdefaultResponse, - AccountsGetAccessKeys200Response, - AccountsGetAccessKeysdefaultResponse, - AccountsRegenerateAccessKey200Response, - AccountsRegenerateAccessKeydefaultResponse, - CollectionsGetCollection200Response, - CollectionsGetCollectiondefaultResponse, - CollectionsCreateOrUpdateCollection200Response, - CollectionsCreateOrUpdateCollectiondefaultResponse, - CollectionsDeleteCollection204Response, - CollectionsDeleteCollectiondefaultResponse, - CollectionsListCollections200Response, - CollectionsListCollectionsdefaultResponse, - CollectionsListChildCollectionNames200Response, - CollectionsListChildCollectionNamesdefaultResponse, - CollectionsGetCollectionPath200Response, - CollectionsGetCollectionPathdefaultResponse, - ResourceSetRulesGetResourceSetRule200Response, - ResourceSetRulesGetResourceSetRuledefaultResponse, - ResourceSetRulesCreateOrUpdateResourceSetRule200Response, - ResourceSetRulesCreateOrUpdateResourceSetRuledefaultResponse, - ResourceSetRulesDeleteResourceSetRule200Response, - ResourceSetRulesDeleteResourceSetRule204Response, - ResourceSetRulesDeleteResourceSetRuledefaultResponse, - ResourceSetRulesListResourceSetRules200Response, - ResourceSetRulesListResourceSetRulesdefaultResponse, -} from "./responses"; -import { getClient, ClientOptions, Client } from "@azure-rest/core-client"; -import { TokenCredential } from "@azure/core-auth"; - -export interface AccountsGetAccountProperties { - /** Get an account */ - get( - options?: AccountsGetAccountPropertiesParameters - ): Promise; - /** Updates an account */ - patch( - options: AccountsUpdateAccountPropertiesParameters - ): Promise< - AccountsUpdateAccountProperties200Response | AccountsUpdateAccountPropertiesdefaultResponse - >; -} - -export interface AccountsGetAccessKeys { - /** List the authorization keys associated with this account. */ - post( - options?: AccountsGetAccessKeysParameters - ): Promise; -} - -export interface AccountsRegenerateAccessKey { - /** Regenerate the authorization keys associated with this data catalog. */ - post( - options: AccountsRegenerateAccessKeyParameters - ): Promise; -} - -export interface CollectionsGetCollection { - /** Get a collection */ - get( - options?: CollectionsGetCollectionParameters - ): Promise; - /** Creates or updates a collection entity. */ - put( - options: CollectionsCreateOrUpdateCollectionParameters - ): Promise< - | CollectionsCreateOrUpdateCollection200Response - | CollectionsCreateOrUpdateCollectiondefaultResponse - >; - /** Deletes a Collection entity. */ - delete( - options?: CollectionsDeleteCollectionParameters - ): Promise; -} - -export interface CollectionsListCollections { - /** List the collections in the account. */ - get( - options?: CollectionsListCollectionsParameters - ): Promise; -} - -export interface CollectionsListChildCollectionNames { - /** Lists the child collections names in the collection. */ - get( - options?: CollectionsListChildCollectionNamesParameters - ): Promise< - | CollectionsListChildCollectionNames200Response - | CollectionsListChildCollectionNamesdefaultResponse - >; -} - -export interface CollectionsGetCollectionPath { - /** Gets the parent name and parent friendly name chains that represent the collection path. */ - get( - options?: CollectionsGetCollectionPathParameters - ): Promise; -} - -export interface ResourceSetRulesGetResourceSetRule { - /** Get a resource set config service model. */ - get( - options?: ResourceSetRulesGetResourceSetRuleParameters - ): Promise< - | ResourceSetRulesGetResourceSetRule200Response - | ResourceSetRulesGetResourceSetRuledefaultResponse - >; - /** Creates or updates an resource set config. */ - put( - options: ResourceSetRulesCreateOrUpdateResourceSetRuleParameters - ): Promise< - | ResourceSetRulesCreateOrUpdateResourceSetRule200Response - | ResourceSetRulesCreateOrUpdateResourceSetRuledefaultResponse - >; - /** Deletes a ResourceSetRuleConfig resource. */ - delete( - options?: ResourceSetRulesDeleteResourceSetRuleParameters - ): Promise< - | ResourceSetRulesDeleteResourceSetRule200Response - | ResourceSetRulesDeleteResourceSetRule204Response - | ResourceSetRulesDeleteResourceSetRuledefaultResponse - >; -} - -export interface ResourceSetRulesListResourceSetRules { - /** Get a resource set config service model. */ - get( - options?: ResourceSetRulesListResourceSetRulesParameters - ): Promise< - | ResourceSetRulesListResourceSetRules200Response - | ResourceSetRulesListResourceSetRulesdefaultResponse - >; -} - -export interface Routes { - /** Resource for '/' has methods for the following verbs: get, patch */ - (path: "/"): AccountsGetAccountProperties; - /** Resource for '/listkeys' has methods for the following verbs: post */ - (path: "/listkeys"): AccountsGetAccessKeys; - /** Resource for '/regeneratekeys' has methods for the following verbs: post */ - (path: "/regeneratekeys"): AccountsRegenerateAccessKey; - /** Resource for '/collections/\{collectionName\}' has methods for the following verbs: get, put, delete */ - (path: "/collections/{collectionName}", collectionName: string): CollectionsGetCollection; - /** Resource for '/collections' has methods for the following verbs: get */ - (path: "/collections"): CollectionsListCollections; - /** Resource for '/collections/\{collectionName\}/getChildCollectionNames' has methods for the following verbs: get */ - ( - path: "/collections/{collectionName}/getChildCollectionNames", - collectionName: string - ): CollectionsListChildCollectionNames; - /** Resource for '/collections/\{collectionName\}/getCollectionPath' has methods for the following verbs: get */ - ( - path: "/collections/{collectionName}/getCollectionPath", - collectionName: string - ): CollectionsGetCollectionPath; - /** Resource for '/resourceSetRuleConfigs/defaultResourceSetRuleConfig' has methods for the following verbs: get, put, delete */ - ( - path: "/resourceSetRuleConfigs/defaultResourceSetRuleConfig" - ): ResourceSetRulesGetResourceSetRule; - /** Resource for '/resourceSetRuleConfigs' has methods for the following verbs: get */ - (path: "/resourceSetRuleConfigs"): ResourceSetRulesListResourceSetRules; -} - -export type PurviewAccountRestClient = Client & { - path: Routes; -}; - -export default function PurviewAccount( - endpoint: string, - credentials: TokenCredential, - options: ClientOptions = {} -): PurviewAccountRestClient { - const baseUrl = options.baseUrl ?? `${endpoint}`; - options.apiVersion = options.apiVersion ?? "2019-11-01-preview"; - options = { - ...options, - credentials: { - scopes: ["https://purview.azure.net/.default"], - }, - }; - - return getClient(baseUrl, credentials, options) as PurviewAccountRestClient; -} diff --git a/sdk/purview/purview-account-rest/src/responses.ts b/sdk/purview/purview-account-rest/src/responses.ts deleted file mode 100644 index 301387efb7c2..000000000000 --- a/sdk/purview/purview-account-rest/src/responses.ts +++ /dev/null @@ -1,189 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -import { HttpResponse } from "@azure-rest/core-client"; -import { - Account, - ErrorResponseModel, - AccessKeys, - Collection, - CollectionList, - CollectionNameResponseList, - CollectionPathResponse, - ResourceSetRuleConfig, - ResourceSetRuleConfigList, -} from "./models"; - -/** Get an account */ -export interface AccountsGetAccountProperties200Response extends HttpResponse { - status: "200"; - body: Account; -} - -/** Get an account */ -export interface AccountsGetAccountPropertiesdefaultResponse extends HttpResponse { - status: "500"; - body: ErrorResponseModel; -} - -/** Updates an account */ -export interface AccountsUpdateAccountProperties200Response extends HttpResponse { - status: "200"; - body: Account; -} - -/** Updates an account */ -export interface AccountsUpdateAccountPropertiesdefaultResponse extends HttpResponse { - status: "500"; - body: ErrorResponseModel; -} - -/** List the authorization keys associated with this account. */ -export interface AccountsGetAccessKeys200Response extends HttpResponse { - status: "200"; - body: AccessKeys; -} - -/** List the authorization keys associated with this account. */ -export interface AccountsGetAccessKeysdefaultResponse extends HttpResponse { - status: "500"; - body: ErrorResponseModel; -} - -/** Regenerate the authorization keys associated with this data catalog. */ -export interface AccountsRegenerateAccessKey200Response extends HttpResponse { - status: "200"; - body: AccessKeys; -} - -/** Regenerate the authorization keys associated with this data catalog. */ -export interface AccountsRegenerateAccessKeydefaultResponse extends HttpResponse { - status: "500"; - body: ErrorResponseModel; -} - -/** Get a collection */ -export interface CollectionsGetCollection200Response extends HttpResponse { - status: "200"; - body: Collection; -} - -/** Get a collection */ -export interface CollectionsGetCollectiondefaultResponse extends HttpResponse { - status: "500"; - body: ErrorResponseModel; -} - -/** Creates or updates a collection entity. */ -export interface CollectionsCreateOrUpdateCollection200Response extends HttpResponse { - status: "200"; - body: Collection; -} - -/** Creates or updates a collection entity. */ -export interface CollectionsCreateOrUpdateCollectiondefaultResponse extends HttpResponse { - status: "500"; - body: ErrorResponseModel; -} - -/** Deletes a Collection entity. */ -export interface CollectionsDeleteCollection204Response extends HttpResponse { - status: "204"; - body: Record; -} - -/** Deletes a Collection entity. */ -export interface CollectionsDeleteCollectiondefaultResponse extends HttpResponse { - status: "500"; - body: ErrorResponseModel; -} - -/** List the collections in the account. */ -export interface CollectionsListCollections200Response extends HttpResponse { - status: "200"; - body: CollectionList; -} - -/** List the collections in the account. */ -export interface CollectionsListCollectionsdefaultResponse extends HttpResponse { - status: "500"; - body: ErrorResponseModel; -} - -/** Lists the child collections names in the collection. */ -export interface CollectionsListChildCollectionNames200Response extends HttpResponse { - status: "200"; - body: CollectionNameResponseList; -} - -/** Lists the child collections names in the collection. */ -export interface CollectionsListChildCollectionNamesdefaultResponse extends HttpResponse { - status: "500"; - body: ErrorResponseModel; -} - -/** Gets the parent name and parent friendly name chains that represent the collection path. */ -export interface CollectionsGetCollectionPath200Response extends HttpResponse { - status: "200"; - body: CollectionPathResponse; -} - -/** Gets the parent name and parent friendly name chains that represent the collection path. */ -export interface CollectionsGetCollectionPathdefaultResponse extends HttpResponse { - status: "500"; - body: ErrorResponseModel; -} - -/** Get a resource set config service model. */ -export interface ResourceSetRulesGetResourceSetRule200Response extends HttpResponse { - status: "200"; - body: ResourceSetRuleConfig; -} - -/** Get a resource set config service model. */ -export interface ResourceSetRulesGetResourceSetRuledefaultResponse extends HttpResponse { - status: "500"; - body: ErrorResponseModel; -} - -/** Creates or updates an resource set config. */ -export interface ResourceSetRulesCreateOrUpdateResourceSetRule200Response extends HttpResponse { - status: "200"; - body: ResourceSetRuleConfig; -} - -/** Creates or updates an resource set config. */ -export interface ResourceSetRulesCreateOrUpdateResourceSetRuledefaultResponse extends HttpResponse { - status: "500"; - body: ErrorResponseModel; -} - -/** Deletes a ResourceSetRuleConfig resource. */ -export interface ResourceSetRulesDeleteResourceSetRule200Response extends HttpResponse { - status: "200"; - body: Record; -} - -/** Deletes a ResourceSetRuleConfig resource. */ -export interface ResourceSetRulesDeleteResourceSetRule204Response extends HttpResponse { - status: "204"; - body: Record; -} - -/** Deletes a ResourceSetRuleConfig resource. */ -export interface ResourceSetRulesDeleteResourceSetRuledefaultResponse extends HttpResponse { - status: "500"; - body: ErrorResponseModel; -} - -/** Get a resource set config service model. */ -export interface ResourceSetRulesListResourceSetRules200Response extends HttpResponse { - status: "200"; - body: ResourceSetRuleConfigList; -} - -/** Get a resource set config service model. */ -export interface ResourceSetRulesListResourceSetRulesdefaultResponse extends HttpResponse { - status: "500"; - body: ErrorResponseModel; -} diff --git a/sdk/purview/purview-account-rest/swagger/README.md b/sdk/purview/purview-account-rest/swagger/README.md deleted file mode 100644 index d003ff6d1c81..000000000000 --- a/sdk/purview/purview-account-rest/swagger/README.md +++ /dev/null @@ -1,22 +0,0 @@ -# Azure Purview Catalog TypeScript Protocol Layer - -> see https://aka.ms/autorest - -## Configuration - -```yaml -package-name: "@azure-rest/purview-account" -title: PurviewAccount -description: Purview Account Client -generate-metadata: false -license-header: MICROSOFT_MIT_NO_VERSION -output-folder: ../ -source-code-folder-path: ./src -input-file: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/purview/data-plane/Azure.Analytics.Purview.Account/preview/2019-11-01-preview/account.json -package-version: 1.0.0-beta.1 -rest-level-client: true -add-credentials: true -credential-scopes: "https://purview.azure.net/.default" -use-extension: - "@autorest/typescript": "6.0.0-alpha.8.20210810.1" -``` diff --git a/sdk/purview/purview-account-rest/test/public/account.spec.ts b/sdk/purview/purview-account-rest/test/public/account.spec.ts deleted file mode 100644 index 6962452dfcea..000000000000 --- a/sdk/purview/purview-account-rest/test/public/account.spec.ts +++ /dev/null @@ -1,32 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. -import { PurviewAccountRestClient } from "../../src"; -import { Recorder } from "@azure-tools/test-recorder"; - -import { assert } from "chai"; -import { createClient, createRecorder } from "./utils/recordedClient"; -import { Context } from "mocha"; - -describe("Get account info", () => { - let recorder: Recorder; - let client: PurviewAccountRestClient; - - beforeEach(function (this: Context) { - recorder = createRecorder(this); - client = createClient(); - }); - - afterEach(async function () { - await recorder.stop(); - }); - - it("should get the account info", async () => { - const result = await client.path("/").get(); - - if (result.status !== "200") { - assert.fail(`GET "/" failed with ${result.status}`); - } - - assert.isDefined(result.body); - }); -}); diff --git a/sdk/purview/purview-account-rest/test/public/collections.spec.ts b/sdk/purview/purview-account-rest/test/public/collections.spec.ts deleted file mode 100644 index 6554b5376de0..000000000000 --- a/sdk/purview/purview-account-rest/test/public/collections.spec.ts +++ /dev/null @@ -1,33 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. -import { PurviewAccountRestClient } from "../../src"; -import { Recorder } from "@azure-tools/test-recorder"; - -import { assert } from "chai"; -import { createClient, createRecorder } from "./utils/recordedClient"; -import { Context } from "mocha"; - -describe("List collections", () => { - let recorder: Recorder; - let client: PurviewAccountRestClient; - - beforeEach(function (this: Context) { - recorder = createRecorder(this); - client = createClient(); - }); - - afterEach(async function () { - await recorder.stop(); - }); - - it("should list all available collections", async () => { - const result = await client.path("/collections").get(); - - if (result.status !== "200") { - assert.fail(`GET "/collections" failed with ${result.status}`); - } - - assert.isDefined(result.body.count); - // assert(client); - }); -}); diff --git a/sdk/purview/purview-account-rest/test/public/utils/env.browser.ts b/sdk/purview/purview-account-rest/test/public/utils/env.browser.ts deleted file mode 100644 index fd2aca680c7b..000000000000 --- a/sdk/purview/purview-account-rest/test/public/utils/env.browser.ts +++ /dev/null @@ -1,2 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. diff --git a/sdk/purview/purview-account-rest/test/public/utils/env.ts b/sdk/purview/purview-account-rest/test/public/utils/env.ts deleted file mode 100644 index 0e06855b73ae..000000000000 --- a/sdk/purview/purview-account-rest/test/public/utils/env.ts +++ /dev/null @@ -1,6 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -import * as dotenv from "dotenv"; - -dotenv.config(); diff --git a/sdk/purview/purview-account-rest/test/public/utils/recordedClient.ts b/sdk/purview/purview-account-rest/test/public/utils/recordedClient.ts deleted file mode 100644 index edd0ee9fa900..000000000000 --- a/sdk/purview/purview-account-rest/test/public/utils/recordedClient.ts +++ /dev/null @@ -1,55 +0,0 @@ -// Copyright (c) Microsoft Corporation. -// Licensed under the MIT license. - -/// - -import { Context } from "mocha"; - -import { env, Recorder, record, RecorderEnvironmentSetup } from "@azure-tools/test-recorder"; -import PurviewAccount, { PurviewAccountRestClient } from "../../../src"; -import { ClientSecretCredential } from "@azure/identity"; - -import "./env"; -import { ClientOptions } from "@azure-rest/core-client"; - -const replaceableVariables: { [k: string]: string } = { - ENDPOINT: "https://endpoint", - AZURE_CLIENT_ID: "azure_client_id", - AZURE_CLIENT_SECRET: "azure_client_secret", - AZURE_TENANT_ID: "88888888-8888-8888-8888-888888888888", -}; - -export const environmentSetup: RecorderEnvironmentSetup = { - replaceableVariables, - customizationsOnRecordings: [ - (recording: string): string => - recording.replace(/"access_token"\s?:\s?"[^"]*"/g, `"access_token":"access_token"`), - // If we put ENDPOINT in replaceableVariables above, it will not capture - // the endpoint string used with nock, which will be expanded to - // https://:443/ and therefore will not match, so we have to do - // this instead. - (recording: string): string => { - const replaced = recording.replace("endpoint:443", "endpoint"); - return replaced; - }, - ], - queryParametersToSkip: [], -}; - -export function createClient(options?: ClientOptions): PurviewAccountRestClient { - const credential = new ClientSecretCredential( - env.AZURE_TENANT_ID, - env.AZURE_CLIENT_ID, - env.AZURE_CLIENT_SECRET - ); - return PurviewAccount(env.ENDPOINT, credential, options); -} - -/** - * creates the recorder and reads the environment variables from the `.env` file. - * Should be called first in the test suite to make sure environment variables are - * read before they are being used. - */ -export function createRecorder(context: Context): Recorder { - return record(context, environmentSetup); -} diff --git a/sdk/purview/purview-account-rest/tsconfig.json b/sdk/purview/purview-account-rest/tsconfig.json deleted file mode 100644 index a2d81bc97e1a..000000000000 --- a/sdk/purview/purview-account-rest/tsconfig.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "extends": "../../../tsconfig.package", - "compilerOptions": { - "outDir": "./dist-esm", - "declarationDir": "./types", - "paths": { - "@azure-rest/purview-account": ["./src/index"] - } - }, - "include": ["src/**/*.ts", "test/**/*.ts", "samples-dev/**/*.ts"] -}