From b12218ecef880b45969b3b64207f3e7519598168 Mon Sep 17 00:00:00 2001 From: Lucano Vera Date: Thu, 20 Nov 2025 15:48:34 -0300 Subject: [PATCH 1/8] WIP --- clients/admin-ui/openapi-ts-api.config.ts | 11 + .../admin-ui/openapi-ts-dictionary.config.ts | 11 + clients/admin-ui/package.json | 6 +- clients/admin-ui/src/types/api/README.md | 4 +- clients/package-lock.json | 492 +++++++++++++++++- 5 files changed, 515 insertions(+), 9 deletions(-) create mode 100644 clients/admin-ui/openapi-ts-api.config.ts create mode 100644 clients/admin-ui/openapi-ts-dictionary.config.ts diff --git a/clients/admin-ui/openapi-ts-api.config.ts b/clients/admin-ui/openapi-ts-api.config.ts new file mode 100644 index 00000000000..565842d9c71 --- /dev/null +++ b/clients/admin-ui/openapi-ts-api.config.ts @@ -0,0 +1,11 @@ +// eslint-disable-next-line import/no-extraneous-dependencies +import { defineConfig } from "@hey-api/openapi-ts"; + +export default defineConfig({ + input: "http://localhost:8080/openapi.json", + output: { + path: "./src/types/api", + format: "prettier", + }, + plugins: ["@hey-api/typescript"], +}); diff --git a/clients/admin-ui/openapi-ts-dictionary.config.ts b/clients/admin-ui/openapi-ts-dictionary.config.ts new file mode 100644 index 00000000000..deded913a63 --- /dev/null +++ b/clients/admin-ui/openapi-ts-dictionary.config.ts @@ -0,0 +1,11 @@ +// eslint-disable-next-line import/no-extraneous-dependencies +import { defineConfig } from "@hey-api/openapi-ts"; + +export default defineConfig({ + input: "http://localhost:8081/openapi.json", + output: { + path: "./src/types/dictionary-api", + format: "prettier", + }, + plugins: ["@hey-api/typescript"], +}); diff --git a/clients/admin-ui/package.json b/clients/admin-ui/package.json index 4ae2cfce2cf..ec19e94a02f 100644 --- a/clients/admin-ui/package.json +++ b/clients/admin-ui/package.json @@ -24,8 +24,8 @@ "lint": "next lint && eslint ./cypress/e2e/**/*.ts ./cypress/support/**/*.ts", "lint:fix": "next lint --fix && eslint --fix ./cypress/e2e/**/*.ts ./cypress/support/**/*.ts", "lint-staged:fix": "lint-staged --diff=main", - "openapi:generate": "openapi --input http://localhost:8080/openapi.json --output ./src/types/api --exportCore false --exportServices false --indent 2 && prettier --write .", - "openapi:generate-dictionary": "openapi --input http://localhost:8081/openapi.json --output ./src/types/dictionary-api --exportCore false --exportServices false --indent 2", + "openapi:generate": "openapi-ts --file openapi-ts-api.config.ts && prettier --write .", + "openapi:generate-dictionary": "openapi-ts --file openapi-ts-dictionary.config.ts", "start": "next start", "test": "jest", "test:watch": "jest --watchAll", @@ -78,6 +78,7 @@ "yup": "^1.4.0" }, "devDependencies": { + "@hey-api/openapi-ts": "^0.88.0", "@jest/globals": "^29.7.0", "@next/bundle-analyzer": "^13.2.4", "@testing-library/cypress": "^10.0.3", @@ -121,7 +122,6 @@ "jest-environment-jsdom": "^29.7.0", "lint-staged": "^13.2.0", "msw": "^1.2.1", - "openapi-typescript-codegen": "^0.23.0", "postcss": "^8.4.41", "prettier": "^3.3.3", "sass": "^1.80.6", diff --git a/clients/admin-ui/src/types/api/README.md b/clients/admin-ui/src/types/api/README.md index 2d036368900..c88c421fac9 100644 --- a/clients/admin-ui/src/types/api/README.md +++ b/clients/admin-ui/src/types/api/README.md @@ -28,5 +28,5 @@ turbo run format ## Resources -- [FastAPI Client Generation](https://fastapi.tiangolo.com/advanced/generate-clients/?h=typescript#install-openapi-typescript-codegen) -- [OpenAPI Typescript Codegen](https://github.com/ferdikoomen/openapi-typescript-codegen) +- [FastAPI Client Generation](https://fastapi.tiangolo.com/advanced/generate-clients/) +- [@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) diff --git a/clients/package-lock.json b/clients/package-lock.json index be47c83cfed..8b7eaa8d43d 100644 --- a/clients/package-lock.json +++ b/clients/package-lock.json @@ -69,6 +69,7 @@ "yup": "^1.4.0" }, "devDependencies": { + "@hey-api/openapi-ts": "^0.88.0", "@jest/globals": "^29.7.0", "@next/bundle-analyzer": "^13.2.4", "@testing-library/cypress": "^10.0.3", @@ -112,7 +113,6 @@ "jest-environment-jsdom": "^29.7.0", "lint-staged": "^13.2.0", "msw": "^1.2.1", - "openapi-typescript-codegen": "^0.23.0", "postcss": "^8.4.41", "prettier": "^3.3.3", "sass": "^1.80.6", @@ -2490,6 +2490,114 @@ "@shikijs/vscode-textmate": "^10.0.1" } }, + "node_modules/@hey-api/codegen-core": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/@hey-api/codegen-core/-/codegen-core-0.3.3.tgz", + "integrity": "sha512-vArVDtrvdzFewu1hnjUm4jX1NBITlSCeO81EdWq676MxQbyxsGcDPAgohaSA+Wvr4HjPSvsg2/1s2zYxUtXebg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=20.19.0" + }, + "funding": { + "url": "https://github.com/sponsors/hey-api" + }, + "peerDependencies": { + "typescript": ">=5.5.3" + } + }, + "node_modules/@hey-api/json-schema-ref-parser": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@hey-api/json-schema-ref-parser/-/json-schema-ref-parser-1.2.1.tgz", + "integrity": "sha512-inPeksRLq+j3ArnuGOzQPQE//YrhezQG0+9Y9yizScBN2qatJ78fIByhEgKdNAbtguDCn4RPxmEhcrePwHxs4A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jsdevtools/ono": "^7.1.3", + "@types/json-schema": "^7.0.15", + "js-yaml": "^4.1.0", + "lodash": "^4.17.21" + }, + "engines": { + "node": ">= 16" + }, + "funding": { + "url": "https://github.com/sponsors/hey-api" + } + }, + "node_modules/@hey-api/openapi-ts": { + "version": "0.88.0", + "resolved": "https://registry.npmjs.org/@hey-api/openapi-ts/-/openapi-ts-0.88.0.tgz", + "integrity": "sha512-ZrvmDfmVf+N4ry786LAhS/DoH+xkIjIJIeDnj2aL1qnMTIDsdRIXXvr80EnAZVBgunzu1wTBbHb3H9OfyDQ2EQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@hey-api/codegen-core": "^0.3.3", + "@hey-api/json-schema-ref-parser": "1.2.1", + "ansi-colors": "4.1.3", + "c12": "3.3.2", + "color-support": "1.1.3", + "commander": "14.0.2", + "open": "11.0.0", + "semver": "7.7.2" + }, + "bin": { + "openapi-ts": "bin/run.js" + }, + "engines": { + "node": ">=20.19.0" + }, + "funding": { + "url": "https://github.com/sponsors/hey-api" + }, + "peerDependencies": { + "typescript": ">=5.5.3" + } + }, + "node_modules/@hey-api/openapi-ts/node_modules/commander": { + "version": "14.0.2", + "resolved": "https://registry.npmjs.org/commander/-/commander-14.0.2.tgz", + "integrity": "sha512-TywoWNNRbhoD0BXs1P3ZEScW8W5iKrnbithIl0YH+uCmBd0QpPOA8yc82DS3BIE5Ma6FnBVUsJ7wVUDz4dvOWQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=20" + } + }, + "node_modules/@hey-api/openapi-ts/node_modules/define-lazy-prop": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/define-lazy-prop/-/define-lazy-prop-3.0.0.tgz", + "integrity": "sha512-N+MeXYoqr3pOgn8xfyRPREN7gHakLYjhsHhWGT3fWAiL4IkAt0iDw14QiiEm2bE30c5XX5q0FtAA3CK5f9/BUg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@hey-api/openapi-ts/node_modules/open": { + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/open/-/open-11.0.0.tgz", + "integrity": "sha512-smsWv2LzFjP03xmvFoJ331ss6h+jixfA4UUV/Bsiyuu4YJPfN+FIQGOIiv4w9/+MoHkfkJ22UIaQWRVFRfH6Vw==", + "dev": true, + "license": "MIT", + "dependencies": { + "default-browser": "^5.4.0", + "define-lazy-prop": "^3.0.0", + "is-in-ssh": "^1.0.0", + "is-inside-container": "^1.0.0", + "powershell-utils": "^0.1.0", + "wsl-utils": "^0.3.0" + }, + "engines": { + "node": ">=20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/@humanwhocodes/config-array": { "version": "0.13.0", "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.13.0.tgz", @@ -8180,6 +8288,22 @@ "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", "dev": true }, + "node_modules/bundle-name": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/bundle-name/-/bundle-name-4.1.0.tgz", + "integrity": "sha512-tjwM5exMg6BGRI+kNmTntNsvdZS1X8BFYS6tnJ2hdH0kVxM6/eVZ2xy+FqStSWvYmtfFMDLIxurorHwDKfDz5Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "run-applescript": "^7.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/busboy": { "version": "1.6.0", "resolved": "https://registry.npmjs.org/busboy/-/busboy-1.6.0.tgz", @@ -8191,6 +8315,88 @@ "node": ">=10.16.0" } }, + "node_modules/c12": { + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/c12/-/c12-3.3.2.tgz", + "integrity": "sha512-QkikB2X5voO1okL3QsES0N690Sn/K9WokXqUsDQsWy5SnYb+psYQFGA10iy1bZHj3fjISKsI67Q90gruvWWM3A==", + "dev": true, + "license": "MIT", + "dependencies": { + "chokidar": "^4.0.3", + "confbox": "^0.2.2", + "defu": "^6.1.4", + "dotenv": "^17.2.3", + "exsolve": "^1.0.8", + "giget": "^2.0.0", + "jiti": "^2.6.1", + "ohash": "^2.0.11", + "pathe": "^2.0.3", + "perfect-debounce": "^2.0.0", + "pkg-types": "^2.3.0", + "rc9": "^2.1.2" + }, + "peerDependencies": { + "magicast": "*" + }, + "peerDependenciesMeta": { + "magicast": { + "optional": true + } + } + }, + "node_modules/c12/node_modules/chokidar": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-4.0.3.tgz", + "integrity": "sha512-Qgzu8kfBvo+cA4962jnP1KkS6Dop5NS6g7R5LFYJr4b8Ub94PPQXUksCw9PvXoeXPRRddRNC5C1JQUR2SMGtnA==", + "dev": true, + "license": "MIT", + "dependencies": { + "readdirp": "^4.0.1" + }, + "engines": { + "node": ">= 14.16.0" + }, + "funding": { + "url": "https://paulmillr.com/funding/" + } + }, + "node_modules/c12/node_modules/dotenv": { + "version": "17.2.3", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-17.2.3.tgz", + "integrity": "sha512-JVUnt+DUIzu87TABbhPmNfVdBDt18BLOWjMUFJMSi/Qqg7NTYtabbvSNJGOJ7afbRuv9D/lngizHtP7QyLQ+9w==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://dotenvx.com" + } + }, + "node_modules/c12/node_modules/jiti": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/jiti/-/jiti-2.6.1.tgz", + "integrity": "sha512-ekilCSN1jwRvIbgeg/57YFh8qQDNbwDb9xT/qu2DAHbFFZUicIl4ygVaAvzveMhMVr3LnpSKTNnwt8PoOfmKhQ==", + "dev": true, + "license": "MIT", + "bin": { + "jiti": "lib/jiti-cli.mjs" + } + }, + "node_modules/c12/node_modules/readdirp": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-4.1.2.tgz", + "integrity": "sha512-GDhwkLfywWL2s6vEjyhri+eXmfH6j1L7JE27WhqLeYzoh/A3DBaYGEj2H/HFZCn/kMfim73FXxEJTw06WtxQwg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 14.18.0" + }, + "funding": { + "type": "individual", + "url": "https://paulmillr.com/funding/" + } + }, "node_modules/cacache": { "version": "17.1.4", "resolved": "https://registry.npmjs.org/cacache/-/cacache-17.1.4.tgz", @@ -8550,6 +8756,16 @@ "node": ">=8" } }, + "node_modules/citty": { + "version": "0.1.6", + "resolved": "https://registry.npmjs.org/citty/-/citty-0.1.6.tgz", + "integrity": "sha512-tskPPKEs8D2KPafUypv2gxwJP8h/OaJmC82QQGGDQcHvXX43xF2VDACcJVmZ0EuSxkpO9Kc4MlrA3q0+FG58AQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "consola": "^3.2.3" + } + }, "node_modules/cjs-module-lexer": { "version": "1.4.3", "resolved": "https://registry.npmjs.org/cjs-module-lexer/-/cjs-module-lexer-1.4.3.tgz", @@ -8864,12 +9080,29 @@ "node": ">=0.10.0" } }, + "node_modules/confbox": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/confbox/-/confbox-0.2.2.tgz", + "integrity": "sha512-1NB+BKqhtNipMsov4xI/NnhCKp9XG9NamYp5PVm9klAT0fsrNPjaFICsCFhNhwZJKNh7zB/3q8qXz0E9oaMNtQ==", + "dev": true, + "license": "MIT" + }, "node_modules/confusing-browser-globals": { "version": "1.0.11", "resolved": "https://registry.npmjs.org/confusing-browser-globals/-/confusing-browser-globals-1.0.11.tgz", "integrity": "sha512-JsPKdmh8ZkmnHxDk55FZ1TqVLvEQTvoByJZRN9jzI0UjxK/QgAmsphz7PGtqgPieQZ/CQcHWXCR7ATDNhGe+YA==", "dev": true }, + "node_modules/consola": { + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/consola/-/consola-3.4.2.tgz", + "integrity": "sha512-5IKcdX0nnYavi6G7TtOhwkYzyjfJlatbjMjuLSfE2kYT5pMDOilZ4OvMhi637CcDICTmz3wARPoyhqyX1Y+XvA==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^14.18.0 || >=16.10.0" + } + }, "node_modules/console-control-strings": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/console-control-strings/-/console-control-strings-1.1.0.tgz", @@ -9985,6 +10218,36 @@ "node": ">=0.10.0" } }, + "node_modules/default-browser": { + "version": "5.4.0", + "resolved": "https://registry.npmjs.org/default-browser/-/default-browser-5.4.0.tgz", + "integrity": "sha512-XDuvSq38Hr1MdN47EDvYtx3U0MTqpCEn+F6ft8z2vYDzMrvQhVp0ui9oQdqW3MvK3vqUETglt1tVGgjLuJ5izg==", + "dev": true, + "license": "MIT", + "dependencies": { + "bundle-name": "^4.1.0", + "default-browser-id": "^5.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/default-browser-id": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/default-browser-id/-/default-browser-id-5.0.1.tgz", + "integrity": "sha512-x1VCxdX4t+8wVfd1so/9w+vQ4vx7lKd2Qp5tDRutErwmR85OgmfX7RlLRMWafRMY7hbEiXIbudNrjOAPa/hL8Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/defaults": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/defaults/-/defaults-1.0.4.tgz", @@ -10040,6 +10303,13 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/defu": { + "version": "6.1.4", + "resolved": "https://registry.npmjs.org/defu/-/defu-6.1.4.tgz", + "integrity": "sha512-mEQCMmwJu317oSz8CwdIOdwf3xMif1ttiM8LTufzc3g6kR+9Pe236twL8j3IYT1F7GfRgGcW6MWxzZjLIkuHIg==", + "dev": true, + "license": "MIT" + }, "node_modules/delayed-stream": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", @@ -10072,6 +10342,13 @@ "node": ">=6" } }, + "node_modules/destr": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/destr/-/destr-2.0.5.tgz", + "integrity": "sha512-ugFTXCtDZunbzasqBxrK93Ik/DRYsO6S/fedkWEMKqt04xZ4csmnmwGDBAb07QWNaGMAmnTIemsYZCksjATwsA==", + "dev": true, + "license": "MIT" + }, "node_modules/detect-libc": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-1.0.3.tgz", @@ -11935,6 +12212,13 @@ "integrity": "sha512-8QxYTVXUkuy7fIIoitQkPwGonB8F3Zj8eEO8Sqg9Zv/bkI7RJAzowee4gr81Hak/dUTpA2Z7VfQgoijjPNlUZA==", "dev": true }, + "node_modules/exsolve": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/exsolve/-/exsolve-1.0.8.tgz", + "integrity": "sha512-LmDxfWXwcTArk8fUEnOfSZpHOJ6zOMUJKOtFLFqJLoKJetuQG874Uc7/Kki7zFLzYybmZhp1M7+98pfMqeX8yA==", + "dev": true, + "license": "MIT" + }, "node_modules/extend": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", @@ -12745,6 +13029,24 @@ "assert-plus": "^1.0.0" } }, + "node_modules/giget": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/giget/-/giget-2.0.0.tgz", + "integrity": "sha512-L5bGsVkxJbJgdnwyuheIunkGatUF/zssUoxxjACCseZYAVbaqdh9Tsmmlkl8vYan09H7sbvKt4pS8GqKLBrEzA==", + "dev": true, + "license": "MIT", + "dependencies": { + "citty": "^0.1.6", + "consola": "^3.4.0", + "defu": "^6.1.4", + "node-fetch-native": "^1.6.6", + "nypm": "^0.6.0", + "pathe": "^2.0.3" + }, + "bin": { + "giget": "dist/cli.mjs" + } + }, "node_modules/glob": { "version": "7.1.7", "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.7.tgz", @@ -13941,6 +14243,54 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/is-in-ssh": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-in-ssh/-/is-in-ssh-1.0.0.tgz", + "integrity": "sha512-jYa6Q9rH90kR1vKB6NM7qqd1mge3Fx4Dhw5TVlK1MUBqhEOuCagrEHMevNuCcbECmXZ0ThXkRm+Ymr51HwEPAw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-inside-container": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-inside-container/-/is-inside-container-1.0.0.tgz", + "integrity": "sha512-KIYLCCJghfHZxqjYBE7rEy0OBuTd5xCHS7tHVgvCLkx7StIoaxwNW3hCALgEUjFfeRk+MG/Qxmp/vtETEF3tRA==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-docker": "^3.0.0" + }, + "bin": { + "is-inside-container": "cli.js" + }, + "engines": { + "node": ">=14.16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-inside-container/node_modules/is-docker": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-3.0.0.tgz", + "integrity": "sha512-eljcgEDlEns/7AXFosB5K/2nCM4P7FQPkGc/DWLy5rmFEWvZayGrik1d9/QIY5nJ4f9YsVvBkA6kJpHn9rISdQ==", + "dev": true, + "license": "MIT", + "bin": { + "is-docker": "cli.js" + }, + "engines": { + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/is-installed-globally": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/is-installed-globally/-/is-installed-globally-0.4.0.tgz", @@ -17517,6 +17867,13 @@ "url": "https://opencollective.com/node-fetch" } }, + "node_modules/node-fetch-native": { + "version": "1.6.7", + "resolved": "https://registry.npmjs.org/node-fetch-native/-/node-fetch-native-1.6.7.tgz", + "integrity": "sha512-g9yhqoedzIUm0nTnTqAQvueMPVOuIY16bqgAJJC8XOOubYFNwz6IER9qs0Gq2Xd0+CecCKFjtdDTMA4u4xG06Q==", + "dev": true, + "license": "MIT" + }, "node_modules/node-fetch/node_modules/tr46": { "version": "0.0.3", "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", @@ -17913,6 +18270,26 @@ "integrity": "sha512-p1TRH/edngVEHVbwqWnxUViEmq5znDvyB+Sik5cmuLpGOIfDf/39zLiq3swPF8Vakqn+gvNiOQAZu8djYlQILA==", "dev": true }, + "node_modules/nypm": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/nypm/-/nypm-0.6.2.tgz", + "integrity": "sha512-7eM+hpOtrKrBDCh7Ypu2lJ9Z7PNZBdi/8AT3AX8xoCj43BBVHD0hPSTEvMtkMpfs8FCqBGhxB+uToIQimA111g==", + "dev": true, + "license": "MIT", + "dependencies": { + "citty": "^0.1.6", + "consola": "^3.4.2", + "pathe": "^2.0.3", + "pkg-types": "^2.3.0", + "tinyexec": "^1.0.1" + }, + "bin": { + "nypm": "dist/cli.mjs" + }, + "engines": { + "node": "^14.16.0 || >=16.10.0" + } + }, "node_modules/object-assign": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", @@ -18035,6 +18412,13 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/ohash": { + "version": "2.0.11", + "resolved": "https://registry.npmjs.org/ohash/-/ohash-2.0.11.tgz", + "integrity": "sha512-RdR9FQrFwNBNXAr4GixM8YaRZRJ5PUWbKYbE5eOsrwAjJW0q2REGcf79oYPsLyskQCZG1PLN+S/K1V00joZAoQ==", + "dev": true, + "license": "MIT" + }, "node_modules/on-exit-leak-free": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/on-exit-leak-free/-/on-exit-leak-free-2.1.2.tgz", @@ -18600,6 +18984,13 @@ "integrity": "sha512-F3asv42UuXchdzt+xXqfW1OGlVBe+mxa2mqI0pg5yAHZPvFmY3Y6drSf/GQ1A86WgWEN9Kzh/WrgKa6iGcHXLg==", "dev": true }, + "node_modules/perfect-debounce": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/perfect-debounce/-/perfect-debounce-2.0.0.tgz", + "integrity": "sha512-fkEH/OBiKrqqI/yIgjR92lMfs2K8105zt/VT6+7eTjNwisrsh47CeIED9z58zI7DfKdH3uHAn25ziRZn3kgAow==", + "dev": true, + "license": "MIT" + }, "node_modules/performance-now": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz", @@ -18727,6 +19118,18 @@ "node": ">=8" } }, + "node_modules/pkg-types": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/pkg-types/-/pkg-types-2.3.0.tgz", + "integrity": "sha512-SIqCzDRg0s9npO5XQ3tNZioRY1uK06lA41ynBC1YmFTmnY6FjUjVt6s4LoADmwoig1qqD0oK8h1p/8mlMx8Oig==", + "dev": true, + "license": "MIT", + "dependencies": { + "confbox": "^0.2.2", + "exsolve": "^1.0.7", + "pathe": "^2.0.3" + } + }, "node_modules/possible-typed-array-names": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.1.0.tgz", @@ -19381,6 +19784,19 @@ "integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==", "dev": true }, + "node_modules/powershell-utils": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/powershell-utils/-/powershell-utils-0.1.0.tgz", + "integrity": "sha512-dM0jVuXJPsDN6DvRpea484tCUaMiXWjuCn++HGTqUWzGDjv5tZkEZldAJ/UMlqRYGFrD/etByo4/xOuC/snX2A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/preact": { "version": "10.22.1", "resolved": "https://registry.npmjs.org/preact/-/preact-10.22.1.tgz", @@ -20359,6 +20775,17 @@ "react-dom": ">=16.9.0" } }, + "node_modules/rc9": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/rc9/-/rc9-2.1.2.tgz", + "integrity": "sha512-btXCnMmRIBINM2LDZoEmOogIZU7Qe7zn4BpomSKZ/ykbLObuBdvG+mFq11DL6fjH1DRwHhrlgtYWG96bJiC7Cg==", + "dev": true, + "license": "MIT", + "dependencies": { + "defu": "^6.1.4", + "destr": "^2.0.3" + } + }, "node_modules/react": { "version": "18.3.1", "resolved": "https://registry.npmjs.org/react/-/react-18.3.1.tgz", @@ -21471,6 +21898,19 @@ "integrity": "sha512-SqmZANLWS0mnatqbSfRP5g8OXZC12Fgg1IwNtLsyHDzJizORW4khDfjPqJZsemPWBB2uqykUah5YpQ6epsqC/w==", "dev": true }, + "node_modules/run-applescript": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/run-applescript/-/run-applescript-7.1.0.tgz", + "integrity": "sha512-DPe5pVFaAsinSaV6QjQ6gdiedWDcRCbUuiQfQa2wmWV7+xC9bGulGI8+TdRmoFkAPaBXk8CrAbnlY2ISniJ47Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/run-async": { "version": "2.4.1", "resolved": "https://registry.npmjs.org/run-async/-/run-async-2.4.1.tgz", @@ -21719,10 +22159,11 @@ "license": "BSD-3-Clause" }, "node_modules/semver": { - "version": "7.7.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.1.tgz", - "integrity": "sha512-hlq8tAfn0m/61p4BVRcPzIGr6LKiMwo4VM6dGi6pt4qcRkmNzTcWq6eCEjEh+qXjkMDvPlOFFSGwQjoEa6gyMA==", + "version": "7.7.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.2.tgz", + "integrity": "sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA==", "devOptional": true, + "license": "ISC", "bin": { "semver": "bin/semver.js" }, @@ -23481,6 +23922,16 @@ "resolved": "https://registry.npmjs.org/tiny-warning/-/tiny-warning-1.0.3.tgz", "integrity": "sha512-lBN9zLN/oAf68o3zNXYrdCt1kP8WsiGW8Oo2ka41b2IM5JL/S1CTyX1rW0mb/zSuJun0ZUrDxx4sqvYS2FWzPA==" }, + "node_modules/tinyexec": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-1.0.2.tgz", + "integrity": "sha512-W/KYk+NFhkmsYpuHq5JykngiOCnxeVL8v8dFnqxSD8qEEdRfXk1SDM6JzNqcERbcGYj9tMrDQBYV9cjgnunFIg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + } + }, "node_modules/tinyglobby": { "version": "0.2.14", "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.14.tgz", @@ -24936,6 +25387,39 @@ } } }, + "node_modules/wsl-utils": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/wsl-utils/-/wsl-utils-0.3.0.tgz", + "integrity": "sha512-3sFIGLiaDP7rTO4xh3g+b3AzhYDIUGGywE/WsmqzJWDxus5aJXVnPTNC/6L+r2WzrwXqVOdD262OaO+cEyPMSQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-wsl": "^3.1.0", + "powershell-utils": "^0.1.0" + }, + "engines": { + "node": ">=20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/wsl-utils/node_modules/is-wsl": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-3.1.0.tgz", + "integrity": "sha512-UcVfVfaK4Sc4m7X3dUSoHoozQGBEFeDC+zVo06t98xe8CzHSZZBekNXH+tu0NalHolcJ/QAGqS46Hef7QXBIMw==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-inside-container": "^1.0.0" + }, + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/xml": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/xml/-/xml-1.0.1.tgz", From 71797d7e6f9b722267ba7cbd9bf8b6741784a8ef Mon Sep 17 00:00:00 2001 From: Lucano Vera Date: Fri, 21 Nov 2025 11:56:54 -0300 Subject: [PATCH 2/8] new library config --- clients/admin-ui/openapi-ts-api.config.ts | 23 ++++++++++++++++++- .../admin-ui/openapi-ts-dictionary.config.ts | 5 +++- clients/admin-ui/package.json | 2 +- 3 files changed, 27 insertions(+), 3 deletions(-) diff --git a/clients/admin-ui/openapi-ts-api.config.ts b/clients/admin-ui/openapi-ts-api.config.ts index 565842d9c71..1a5c384175c 100644 --- a/clients/admin-ui/openapi-ts-api.config.ts +++ b/clients/admin-ui/openapi-ts-api.config.ts @@ -7,5 +7,26 @@ export default defineConfig({ path: "./src/types/api", format: "prettier", }, - plugins: ["@hey-api/typescript"], + parser: { + patch: { + schemas: { + ScopeRegistryEnum: (schema) => { + // Add x-enum-varnames to replace colons with underscores in enum keys + if (schema.enum && Array.isArray(schema.enum)) { + // eslint-disable-next-line no-param-reassign + schema["x-enum-varnames"] = schema.enum.map((value: string) => + value.toUpperCase().replace(/:/g, "_").replace(/-/g, "_"), + ); + } + }, + }, + }, + }, + plugins: [ + { + name: "@hey-api/typescript", + enums: "typescript", + case: "preserve", + }, + ], }); diff --git a/clients/admin-ui/openapi-ts-dictionary.config.ts b/clients/admin-ui/openapi-ts-dictionary.config.ts index deded913a63..81ae61d01eb 100644 --- a/clients/admin-ui/openapi-ts-dictionary.config.ts +++ b/clients/admin-ui/openapi-ts-dictionary.config.ts @@ -7,5 +7,8 @@ export default defineConfig({ path: "./src/types/dictionary-api", format: "prettier", }, - plugins: ["@hey-api/typescript"], + types: { + enums: "typescript", + identifierCase: "preserve", + }, }); diff --git a/clients/admin-ui/package.json b/clients/admin-ui/package.json index ec19e94a02f..279ee97fcb2 100644 --- a/clients/admin-ui/package.json +++ b/clients/admin-ui/package.json @@ -24,7 +24,7 @@ "lint": "next lint && eslint ./cypress/e2e/**/*.ts ./cypress/support/**/*.ts", "lint:fix": "next lint --fix && eslint --fix ./cypress/e2e/**/*.ts ./cypress/support/**/*.ts", "lint-staged:fix": "lint-staged --diff=main", - "openapi:generate": "openapi-ts --file openapi-ts-api.config.ts && prettier --write .", + "openapi:generate": "openapi-ts --file openapi-ts-api.config.ts", "openapi:generate-dictionary": "openapi-ts --file openapi-ts-dictionary.config.ts", "start": "next start", "test": "jest", From 391ebd496200a05ef75fc874a423f8a3c173e050 Mon Sep 17 00:00:00 2001 From: Lucano Vera Date: Tue, 10 Mar 2026 00:18:53 -0400 Subject: [PATCH 3/8] configure openapi to do separate files --- clients/admin-ui/openapi-ts-api.config.ts | 28 +++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/clients/admin-ui/openapi-ts-api.config.ts b/clients/admin-ui/openapi-ts-api.config.ts index 1a5c384175c..fb11ed52d5c 100644 --- a/clients/admin-ui/openapi-ts-api.config.ts +++ b/clients/admin-ui/openapi-ts-api.config.ts @@ -6,6 +6,9 @@ export default defineConfig({ output: { path: "./src/types/api", format: "prettier", + fileName: { + suffix: null, + }, }, parser: { patch: { @@ -21,6 +24,31 @@ export default defineConfig({ }, }, }, + hooks: { + symbols: { + getFilePath: (symbol) => { + // Skip endpoint-specific types (camelCase pattern: operationNameApiV1PathMethodData/Response/Errors/etc) + // These are auto-generated for each endpoint and bloat the output + if ( + symbol.name && + /Api[A-Z].*(?:Data|Response|Responses|Error|Errors)$/.test( + symbol.name, + ) + ) { + // Return undefined to skip this symbol entirely + return undefined; + } + + // Keep one type/enum per file in models/ directory + // Note: enums have kind: undefined, only types have kind: "type" + // So we match on any symbol with a name (enums, types, interfaces all get split) + if (symbol.name) { + return `models/${symbol.name}`; + } + // Let other symbols use default placement + }, + }, + }, }, plugins: [ { From 1b7ecbc3e4cbdac456448b08be96b7c4538e046f Mon Sep 17 00:00:00 2001 From: Lucano Vera Date: Tue, 10 Mar 2026 00:21:49 -0400 Subject: [PATCH 4/8] generate types --- clients/admin-ui/src/types/api/README.md | 32 - clients/admin-ui/src/types/api/index.ts | 1574 +- .../src/types/api/models/APIMonitorType.ts | 12 + .../src/types/api/models/AWSAuthMethod.ts | 7 +- .../src/types/api/models/AWSConfig.ts | 18 +- .../src/types/api/models/AccessLevel.ts | 6 +- .../api/models/AccessManualWebhookResponse.ts | 12 +- .../types/api/models/AccessManualWebhooks.ts | 9 +- .../src/types/api/models/AccessToken.ts | 23 +- .../src/types/api/models/AccuracyMetrics.ts | 30 +- .../src/types/api/models/ActionType.ts | 6 +- .../models/ActionValidationErrorResponse.ts | 27 + .../src/types/api/models/AdminUIConfig.ts | 15 +- .../src/types/api/models/AdvancedSettings.ts | 7 +- ...vancedSettingsWithExtendedIdentityTypes.ts | 6 +- .../types/api/models/AesDecryptionRequest.ts | 15 +- .../types/api/models/AesDecryptionResponse.ts | 9 +- .../types/api/models/AesEncryptionRequest.ts | 12 +- .../types/api/models/AesEncryptionResponse.ts | 12 +- .../src/types/api/models/AlertLevel.ts | 7 +- .../src/types/api/models/AllowList.ts | 19 +- .../src/types/api/models/AllowListUpdate.ts | 19 +- .../api/models/AllowedActionsResponse.ts | 22 +- .../src/types/api/models/AllowedTypes.ts | 8 +- .../src/types/api/models/ApplicationStatus.ts | 6 +- .../types/api/models/AssessmentResponse.ts | 57 +- .../api/models/AssessmentTaskResponse.ts | 75 + .../api/models/AssessmentTaskSystemInfo.ts | 17 + .../admin-ui/src/types/api/models/Asset.ts | 54 +- .../src/types/api/models/AssetCreate.ts | 29 +- .../types/api/models/AssetReportingFilters.ts | 29 + .../src/types/api/models/AssetUpdate.ts | 23 +- .../types/api/models/AssignStewardRequest.ts | 17 + .../types/api/models/AssignedUserSummary.ts | 14 +- .../src/types/api/models/AsyncConfig.ts | 13 - .../src/types/api/models/AsyncStrategy.ts | 11 - .../types/api/models/AttachmentResponse.ts | 30 +- .../src/types/api/models/AttachmentType.ts | 6 +- .../src/types/api/models/AuditLogAction.ts | 7 +- .../types/api/models/AuthenticationMethods.ts | 12 +- .../api/models/AuthenticationProtocol.ts | 6 +- .../src/types/api/models/BackfillRequest.ts | 21 + .../api/models/BackfillStatusResponse.ts | 23 + .../api/models/BaseStagedResourcesRequest.ts | 8 +- .../models/BasicMessagingTemplateRequest.ts | 17 +- .../models/BasicMessagingTemplateResponse.ts | 20 +- .../api/models/BasicSystemResponseExtended.ts | 96 +- .../models/BedrockConnectionTestRequest.ts | 35 + .../models/BedrockConnectionTestResponse.ts | 47 + .../src/types/api/models/BenchmarkStatus.ts | 12 + .../src/types/api/models/BigQueryConfig.ts | 9 +- .../types/api/models/BigQueryDocsSchema.ts | 10 +- .../types/api/models/BigQueryMonitorConfig.ts | 30 + .../types/api/models/BigQueryMonitorParams.ts | 9 +- ...__fides_key__tagging_instructions_patch.ts | 12 + ...re_access_token_api_v1_oauth_token_post.ts | 19 +- ...y__comment__comment_id__attachment_post.ts | 14 +- ...d__comment__comment_id__attachment_post.ts | 14 +- ...y__comment__comment_id__attachment_post.ts | 14 +- ...ebhook__connection_key__attachment_post.ts | 14 +- ...st__privacy_request_id__attachment_post.ts | 14 +- ...ebhook__connection_key__attachment_post.ts | 14 +- ...l_webhook__connection_key__comment_post.ts | 19 +- ...quest__privacy_request_id__comment_post.ts | 19 +- ...l_webhook__connection_key__comment_post.ts | 19 +- ...us_datamap_minimal__export_format__post.ts | 7 +- ...anual_field__manual_field_id__skip_post.ts | 13 +- ...l_field__manual_field_id__complete_post.ts | 20 +- ...d_data_api_v1_storage__request_id__post.ts | 17 +- .../api/models/BulkConditionAssignment.ts | 29 + .../api/models/BulkCustomFieldRequest.ts | 22 +- .../api/models/BulkDatasetPropertyResponse.ts | 21 + .../api/models/BulkPostPrivacyRequests.ts | 12 +- .../api/models/BulkPropertyAssignment.ts | 19 + .../types/api/models/BulkPropertyRemoval.ts | 19 + .../BulkPutBasicMessagingTemplateResponse.ts | 13 +- .../models/BulkPutConnectionConfiguration.ts | 12 +- .../src/types/api/models/BulkPutDataset.ts | 12 +- .../types/api/models/BulkPutPolicyResponse.ts | 12 +- .../types/api/models/BulkPutRuleResponse.ts | 12 +- .../api/models/BulkPutRuleTargetResponse.ts | 12 +- .../models/BulkPutStorageConfigResponse.ts | 12 +- .../types/api/models/BulkReviewResponse.ts | 12 +- .../models/BulkSoftDeletePrivacyRequests.ts | 13 +- .../src/types/api/models/BulkUpdateFailed.ts | 16 +- .../types/api/models/BulkUserAssignment.ts | 26 + .../models/CancelPrivacyRequestSelection.ts | 31 + .../types/api/models/CategoryDistribution.ts | 27 + .../types/api/models/ChatChannelsResponse.ts | 9 +- .../src/types/api/models/ChatConfigCreate.ts | 23 +- .../api/models/ChatConfigListResponse.ts | 16 +- .../types/api/models/ChatConfigResponse.ts | 53 + .../src/types/api/models/ChatConfigSecrets.ts | 17 + .../api/models/ChatConfigTestResponse.ts | 17 + .../src/types/api/models/ChatConfigUpdate.ts | 23 +- .../types/api/models/ChatProviderSecrets.ts | 11 - .../models/ChatProviderSettingsResponse.ts | 20 - .../api/models/ChatProviderTestResponse.ts | 11 - .../models/CheckpointActionRequiredDetails.ts | 15 +- .../src/types/api/models/Classification.ts | 30 +- .../models/ClassificationBenchmarkRequest.ts | 27 + .../models/ClassificationBenchmarkResponse.ts | 27 + .../models/ClassificationBenchmarkSummary.ts | 56 + .../api/models/ClassificationCoverage.ts | 39 + .../api/models/ClassificationErrorSchema.ts | 17 + .../api/models/ClassificationResponse.ts | 10 +- .../types/api/models/ClassificationStatus.ts | 6 +- .../models/ClassificationWithConfidence.ts | 32 +- .../types/api/models/ClassifyCollection.ts | 13 +- .../src/types/api/models/ClassifyDataFlow.ts | 13 +- .../src/types/api/models/ClassifyDataset.ts | 18 +- .../api/models/ClassifyDatasetResponse.ts | 17 +- .../src/types/api/models/ClassifyEmpty.ts | 10 +- .../src/types/api/models/ClassifyField.ts | 13 +- .../src/types/api/models/ClassifyInput.ts | 22 + .../models/ClassifyInstanceResponseValues.ts | 35 +- .../src/types/api/models/ClassifyLabel.ts | 39 + .../src/types/api/models/ClassifyLlmParams.ts | 54 +- .../ClassifyLlmPromptTemplateOptions.ts | 6 +- .../src/types/api/models/ClassifyOutput.ts | 25 + .../src/types/api/models/ClassifyParams.ts | 24 +- .../api/models/ClassifyRequestPayload.ts | 10 +- .../api/models/ClassifyResourcesResponse.ts | 10 - .../src/types/api/models/ClassifyResult.ts | 21 + .../api/models/ClassifyStatusUpdatePayload.ts | 12 +- .../src/types/api/models/ClassifySystem.ts | 21 +- .../src/types/api/models/ClientConfig.ts | 12 +- .../types/api/models/ClientCreatedResponse.ts | 12 +- .../src/types/api/models/ClientOptions.ts | 5 + .../src/types/api/models/CloudConfig.ts | 13 +- .../src/types/api/models/ClusterHealth.ts | 6 +- .../api/models/CollectionAddressResponse.ts | 12 +- .../src/types/api/models/CollectionMeta.ts | 33 +- .../src/types/api/models/ColumnInfo.ts | 21 + .../src/types/api/models/ColumnMapItem.ts | 10 +- .../src/types/api/models/ColumnSort.ts | 7 +- .../src/types/api/models/CommentResponse.ts | 26 +- .../src/types/api/models/CommentType.ts | 8 +- .../src/types/api/models/ComponentType.ts | 6 +- .../src/types/api/models/ConditionGroup.ts | 11 +- .../src/types/api/models/ConditionLeaf.ts | 21 +- ...tionalTotalPage_ConsentReportingSchema_.ts | 29 + .../src/types/api/models/ConditionalValue.ts | 13 +- .../src/types/api/models/ConfidenceBucket.ts | 11 +- .../api/models/ConfidenceDistribution.ts | 27 + .../types/api/models/ConfigConsentOption.ts | 31 +- .../api/models/ConfirmResourcesResponse.ts | 19 +- .../types/api/models/ConnectionCategory.ts | 6 +- .../models/ConnectionConfigurationResponse.ts | 53 +- ...ctionConfigurationResponseWithSystemKey.ts | 59 +- .../api/models/ConnectionDatahubSyncDetail.ts | 14 +- .../ConnectionDatahubSyncDetailStatus.ts | 6 +- .../models/ConnectionDatahubSyncPayload.ts | 9 +- .../models/ConnectionDatahubSyncResponse.ts | 15 +- .../api/models/ConnectionSystemTypeMap.ts | 46 +- .../types/api/models/ConnectionTestStatus.ts | 6 +- .../src/types/api/models/ConnectionType.ts | 7 +- .../src/types/api/models/ConnectorParam.ts | 35 +- .../models/ConnectorTemplateListResponse.ts | 34 + .../admin-ui/src/types/api/models/Consent.ts | 21 +- .../src/types/api/models/ConsentAlertInfo.ts | 10 +- .../src/types/api/models/ConsentBreakdown.ts | 14 +- .../types/api/models/ConsentConfigButton.ts | 41 +- .../src/types/api/models/ConsentConfigPage.ts | 22 +- .../src/types/api/models/ConsentCreate.ts | 8 +- .../src/types/api/models/ConsentInfo.ts | 32 +- .../src/types/api/models/ConsentMechanism.ts | 6 +- .../src/types/api/models/ConsentMetaCreate.ts | 7 +- .../types/api/models/ConsentMetaResponse.ts | 7 +- .../src/types/api/models/ConsentMethod.ts | 7 +- .../types/api/models/ConsentOptionCreate.ts | 11 +- .../api/models/ConsentPreferenceCreate.ts | 14 +- .../api/models/ConsentPreferenceResponse.ts | 18 +- .../types/api/models/ConsentPreferences.ts | 9 +- .../ConsentPreferencesWithVerificationCode.ts | 22 +- .../src/types/api/models/ConsentReport.ts | 34 +- .../api/models/ConsentReportingSchema.ts | 105 +- .../models/ConsentRequestCreateExtended.ts | 25 +- .../src/types/api/models/ConsentRequestMap.ts | 12 +- .../api/models/ConsentRequestResponse.ts | 9 +- .../src/types/api/models/ConsentResponse.ts | 15 +- .../types/api/models/ConsentScopeCreate.ts | 6 +- .../types/api/models/ConsentScopeResponse.ts | 12 +- .../src/types/api/models/ConsentStatus.ts | 6 +- .../types/api/models/ConsentStatusDetail.ts | 8 +- .../types/api/models/ConsentStatusReason.ts | 13 +- .../api/models/ConsentWithExecutableStatus.ts | 12 +- .../src/types/api/models/ConsentableItem.ts | 24 +- .../src/types/api/models/Constraint.ts | 14 +- .../src/types/api/models/ConstraintType.ts | 6 +- .../src/types/api/models/ContactDetails.ts | 14 +- .../src/types/api/models/Continent.ts | 6 +- .../src/types/api/models/CoreHealthCheck.ts | 25 +- .../api/models/CreateAssessmentRequest.ts | 28 - .../api/models/CreateAssessmentTaskRequest.ts | 50 + .../models/CreateAssessmentTaskResponse.ts | 21 + ...reateConnectionConfigurationWithSecrets.ts | 832 +- ...nectionConfigurationWithSecretsExtended.ts | 837 +- ...reateExportPrivacyPreferencesJobRequest.ts | 19 + ...eateExportPrivacyPreferencesJobResponse.ts | 11 + ...teIngestionPrivacyPreferencesJobRequest.ts | 13 + ...eIngestionPrivacyPreferencesJobResponse.ts | 11 + .../src/types/api/models/CurrentStep.ts | 7 +- ...DatastoreStagedResourceTreeAPIResponse_.ts | 21 +- .../src/types/api/models/CustomAssetType.ts | 7 +- .../src/types/api/models/CustomField.ts | 16 +- .../types/api/models/CustomFieldDefinition.ts | 32 +- .../models/CustomFieldDefinitionResponse.ts | 38 +- .../api/models/CustomFieldDefinitionWithId.ts | 35 +- .../src/types/api/models/CustomFieldWithId.ts | 19 +- .../types/api/models/CustomReportConfig.ts | 18 +- .../types/api/models/CustomReportCreate.ts | 11 +- .../types/api/models/CustomReportResponse.ts | 14 +- .../api/models/CustomReportResponseMinimal.ts | 14 +- .../types/api/models/CustomTaxonomyColor.ts | 7 +- .../src/types/api/models/DATAMAP_GROUPING.ts | 10 +- .../src/types/api/models/DBActions.ts | 6 +- .../src/types/api/models/DataCategory.ts | 37 +- .../api/models/DataCategoryCreateOrUpdate.ts | 42 +- .../admin-ui/src/types/api/models/DataFlow.ts | 12 +- .../api/models/DataResponsibilityTitle.ts | 6 +- .../src/types/api/models/DataSectionConfig.ts | 45 + .../src/types/api/models/DataSubject.ts | 30 +- .../api/models/DataSubjectCreateOrUpdate.ts | 36 +- .../src/types/api/models/DataSubjectRights.ts | 12 +- .../types/api/models/DataSubjectRightsEnum.ts | 6 +- .../src/types/api/models/DataUpload.ts | 9 +- .../admin-ui/src/types/api/models/DataUse.ts | 31 +- .../types/api/models/DataUseCreateOrUpdate.ts | 36 +- .../admin-ui/src/types/api/models/Database.ts | 81 +- .../src/types/api/models/DatabaseConfig.ts | 9 +- .../types/api/models/DatabaseHealthCheck.ts | 12 +- .../src/types/api/models/DatahubDocsSchema.ts | 16 +- .../src/types/api/models/DatamapReport.ts | 221 +- .../admin-ui/src/types/api/models/Dataset.ts | 27 +- .../src/types/api/models/DatasetCollection.ts | 14 +- .../api/models/DatasetConfigCtlDataset.ts | 17 +- .../types/api/models/DatasetConfigSchema.ts | 9 +- .../src/types/api/models/DatasetField.ts | 14 +- .../src/types/api/models/DatasetMetadata.ts | 25 +- .../api/models/DatasetPropertyResponse.ts | 17 + .../types/api/models/DatasetReachability.ts | 19 +- .../src/types/api/models/DatasetResponse.ts | 27 +- .../src/types/api/models/DatasetSchema.ts | 13 +- .../types/api/models/DatasetTestRequest.ts | 9 +- .../api/models/DatasetTraversalDetails.ts | 12 +- ...DatastoreMonitorResourcesDynamicFilters.ts | 18 +- .../api/models/DatastoreMonitorUpdates.ts | 30 +- .../api/models/DatastoreStagedResource.ts | 76 +- .../DatastoreStagedResourceAPIResponse.ts | 31 +- .../DatastoreStagedResourceTreeAPIResponse.ts | 21 +- .../api/models/DefaultPolicyConfigRequest.ts | 21 + .../api/models/DefaultPolicyConfigResponse.ts | 27 + .../api/models/DeletedResourcesResponse.ts | 8 +- .../api/models/DenyPrivacyRequestSelection.ts | 31 + .../types/api/models/DenyPrivacyRequests.ts | 11 - .../src/types/api/models/DictionaryStatus.ts | 14 +- .../src/types/api/models/DiffStatus.ts | 9 +- .../api/models/DiffStatusDistribution.ts | 27 + .../types/api/models/DigestConditionType.ts | 6 +- .../api/models/DigestConfigListResponse.ts | 15 - .../types/api/models/DigestConfigRequest.ts | 28 +- .../types/api/models/DigestConfigResponse.ts | 59 +- .../src/types/api/models/DigestType.ts | 6 +- .../api/models/DiscoveryMonitorsConfig.ts | 40 + .../src/types/api/models/DrpAction.ts | 14 +- .../types/api/models/DrpDataRightsResponse.ts | 20 +- .../admin-ui/src/types/api/models/DrpMeta.ts | 9 +- .../api/models/DrpPrivacyRequestCreate.ts | 22 +- .../src/types/api/models/DrpRegime.ts | 6 +- .../src/types/api/models/DrpRevokeRequest.ts | 12 +- .../types/api/models/DryRunDatasetResponse.ts | 11 +- .../DuplicateDetectionApplicationConfig.ts | 12 +- .../models/DynamicErasureEmailDocsSchema.ts | 13 +- .../types/api/models/DynamoDBDocsSchema.ts | 18 +- .../types/api/models/DynamoDBMonitorParams.ts | 9 +- .../src/types/api/models/EdgeDirection.ts | 6 +- .../types/api/models/EditableMonitorConfig.ts | 35 +- .../src/types/api/models/EmailDocsSchema.ts | 15 +- .../src/types/api/models/EmbeddedLineItem.ts | 12 +- .../models/EmbeddedPrivacyNoticeResponse.ts | 12 +- .../src/types/api/models/EmbeddedPurpose.ts | 15 +- .../src/types/api/models/EmbeddedVendor.ts | 12 +- .../admin-ui/src/types/api/models/Endpoint.ts | 18 +- .../src/types/api/models/EnforcementLevel.ts | 6 +- .../types/api/models/ErrorNotificationMode.ts | 7 +- .../src/types/api/models/ErrorType.ts | 6 +- .../src/types/api/models/Evaluation.ts | 14 +- .../types/api/models/EventAuditResponse.ts | 37 +- .../types/api/models/ExecutePromptRequest.ts | 20 + .../types/api/models/ExecutePromptResponse.ts | 23 + .../models/ExecutionAndAuditLogResponse.ts | 33 +- .../api/models/ExecutionApplicationConfig.ts | 21 +- .../api/models/ExecutionLogDetailResponse.ts | 28 +- .../types/api/models/ExecutionLogResponse.ts | 25 +- .../types/api/models/ExecutionLogStatus.ts | 7 +- .../api/models/ExperienceConfigCreate.ts | 61 +- .../ExperienceConfigDisabledResponse.ts | 12 +- .../models/ExperienceConfigDisabledUpdate.ts | 9 +- .../ExperienceConfigListViewResponse.ts | 28 +- .../api/models/ExperienceConfigResponse.ts | 73 +- .../ExperienceConfigResponseNoNotices.ts | 67 +- .../api/models/ExperienceConfigUpdate.ts | 59 +- .../src/types/api/models/ExperienceMeta.ts | 18 +- .../types/api/models/ExperienceMinimalMeta.ts | 8 +- .../types/api/models/ExperienceTranslation.ts | 46 +- .../api/models/ExperienceTranslationCreate.ts | 48 +- .../models/ExperienceTranslationResponse.ts | 48 +- .../src/types/api/models/ExportFormat.ts | 11 + .../types/api/models/ExtendedIdentityTypes.ts | 15 +- .../api/models/ExternalDatasetReference.ts | 16 +- .../api/models/ExternalLoginOTPRequest.ts | 13 +- .../api/models/ExternalLoginOTPResponse.ts | 13 +- .../api/models/ExternalLoginVerifyRequest.ts | 13 +- .../api/models/ExternalUserCreateRequest.ts | 18 +- .../src/types/api/models/FidesCloudStatus.ts | 10 +- .../api/models/FidesConsentMetaCreate.ts | 24 +- .../api/models/FidesConsentMetaResponse.ts | 26 +- .../types/api/models/FidesConsentScopes.ts | 8 +- .../types/api/models/FidesDatasetReference.ts | 14 +- .../src/types/api/models/FidesDocsSchema.ts | 21 +- .../src/types/api/models/FidesMeta.ts | 26 +- .../admin-ui/src/types/api/models/Field.ts | 124 +- .../types/api/models/FieldAccuracyDetail.ts | 63 + .../src/types/api/models/FieldActionType.ts | 6 +- .../models/FieldMaskingStrategyOverride.ts | 16 +- .../api/models/FieldsAffectedResponse.ts | 15 +- .../api/models/FilteredFieldActionRequest.ts | 8 +- .../models/FilteredPrivacyRequestResults.ts | 20 +- .../src/types/api/models/GCSAuthMethod.ts | 7 +- .../types/api/models/GPPApplicationConfig.ts | 21 +- .../src/types/api/models/GPPFieldMapping.ts | 15 +- .../types/api/models/GPPFieldMappingCreate.ts | 15 +- .../types/api/models/GPPMechanismMapping.ts | 19 +- .../src/types/api/models/GPPMobileData.ts | 15 +- .../src/types/api/models/GPPUSApproach.ts | 7 +- .../admin-ui/src/types/api/models/Generate.ts | 13 +- .../api/models/GenerateRequestPayload.ts | 9 +- .../src/types/api/models/GenerateResponse.ts | 14 +- .../api/models/GenerateTestDataRequest.ts | 90 + .../src/types/api/models/GenerateTypes.ts | 6 +- .../models/GetRegistrationStatusResponse.ts | 9 +- .../types/api/models/GoogleCloudSQLIPType.ts | 6 +- .../models/GoogleCloudSQLMySQLDocsSchema.ts | 19 +- .../GoogleCloudSQLPostgresDocsSchema.ts | 21 +- .../src/types/api/models/GroupOperator.ts | 7 +- .../src/types/api/models/HTTPMethod.ts | 6 +- .../types/api/models/HTTPValidationError.ts | 10 +- .../admin-ui/src/types/api/models/Header.ts | 13 +- .../src/types/api/models/HealthCheck.ts | 15 +- .../src/types/api/models/IDPActionType.ts | 12 + .../IDPActionValidationErrorResponse.ts | 36 + .../api/models/IDPAllowedActionsResponse.ts | 32 + .../types/api/models/IDPBulkActionResponse.ts | 41 + .../api/models/IDPMonitorBulkSelection.ts | 40 + .../IDPMonitorResourcesDynamicFilters.ts | 21 + .../api/models/IDPMonitorResourcesFilter.ts | 33 + .../admin-ui/src/types/api/models/Identity.ts | 15 - .../src/types/api/models/IdentityBase.ts | 17 + .../api/models/IdentityDefinitionCreate.ts | 24 + .../api/models/IdentityDefinitionEntity.ts | 42 + .../api/models/IdentityDefinitionType.ts | 14 + .../src/types/api/models/IdentityInputs.ts | 31 +- .../src/types/api/models/IdentityProvider.ts | 10 + .../IdentityProviderApplicationMetadata.ts | 18 +- .../models/IdentityProviderMonitorConfig.ts | 90 + .../src/types/api/models/IdentityTypes.ts | 13 +- .../src/types/api/models/IdentityValue.ts | 8 - .../IdentityVerificationConfigResponse.ts | 15 +- .../types/api/models/IncludeExcludeEnum.ts | 6 +- .../src/types/api/models/IndexStatus.ts | 16 + .../models/InfrastructureMonitorUpdates.ts | 16 +- .../types/api/models/IntegrationFeature.ts | 6 +- .../src/types/api/models/JiraIssueType.ts | 36 + .../api/models/JiraOAuthInitiateRequest.ts | 15 + .../api/models/JiraOAuthInitiateResponse.ts | 13 + .../types/api/models/JiraPreviewRequest.ts | 30 + .../src/types/api/models/JiraProject.ts | 30 + .../types/api/models/JiraStatusCategory.ts | 37 + .../src/types/api/models/JiraTicketData.ts | 42 + .../types/api/models/JiraTicketDocsSchema.ts | 29 + .../src/types/api/models/LLMChatRequest.ts | 15 + .../types/api/models/LLMClassifyRequest.ts | 15 + .../admin-ui/src/types/api/models/Language.ts | 13 +- .../types/api/models/Layer1ButtonOption.ts | 6 +- .../api/models/LegalBasisForProcessingEnum.ts | 6 +- .../api/models/LegalBasisForProfilingEnum.ts | 6 +- .../LimitedPrivacyNoticeResponseSchema.ts | 35 +- .../src/types/api/models/LinkedDatasetInfo.ts | 21 + .../src/types/api/models/LinkedSystemInfo.ts | 12 +- .../api/models/LlmClassificationSample.ts | 75 + .../src/types/api/models/LoadingContext.ts | 6 +- .../admin-ui/src/types/api/models/Location.ts | 29 +- .../LocationCustomPrivacyRequestField.ts | 35 +- .../src/types/api/models/LocationGroup.ts | 29 +- .../types/api/models/LocationIdentityField.ts | 14 - .../api/models/LocationRegulationBase.ts | 20 +- .../api/models/LocationRegulationResponse.ts | 16 +- .../models/LocationRegulationSelections.ts | 13 +- .../admin-ui/src/types/api/models/LogEntry.ts | 18 +- .../src/types/api/models/MSSQLDocsSchema.ts | 22 +- .../src/types/api/models/MailgunConfig.ts | 24 + .../src/types/api/models/ManualAction.ts | 23 +- .../src/types/api/models/ManualFieldCreate.ts | 16 +- .../types/api/models/ManualFieldListItem.ts | 39 +- .../api/models/ManualFieldPrivacyRequest.ts | 35 +- .../api/models/ManualFieldRequestType.ts | 6 +- .../types/api/models/ManualFieldResponse.ts | 18 +- .../models/ManualFieldSearchFilterOptions.ts | 12 +- .../api/models/ManualFieldSearchResponse.ts | 21 +- .../src/types/api/models/ManualFieldStatus.ts | 6 +- .../src/types/api/models/ManualFieldSystem.ts | 13 +- .../src/types/api/models/ManualFieldUpdate.ts | 14 +- .../src/types/api/models/ManualFieldUser.ts | 19 +- .../api/models/ManualTaskConfigCreate.ts | 13 +- .../api/models/ManualTaskConfigResponse.ts | 24 +- .../api/models/ManualTaskConfigUpdate.ts | 13 +- .../api/models/ManualTaskConfigurationType.ts | 11 - .../api/models/ManualTaskExportRequest.ts | 28 + .../types/api/models/ManualTaskFieldBase.ts | 15 +- .../api/models/ManualTaskFieldMetadata.ts | 23 +- .../types/api/models/ManualTaskFieldType.ts | 6 +- .../api/models/ManualTaskParentEntityType.ts | 6 +- .../types/api/models/ManualTaskResponse.ts | 53 +- .../src/types/api/models/ManualWebhookData.ts | 17 +- .../api/models/ManualWebhookDocsSchema.ts | 10 +- .../types/api/models/ManualWebhookField.ts | 18 +- .../src/types/api/models/MappedPurpose.ts | 16 +- .../src/types/api/models/MariaDBDocsSchema.ts | 16 +- .../src/types/api/models/MaskingAPIRequest.ts | 15 +- .../types/api/models/MaskingAPIResponse.ts | 14 +- .../src/types/api/models/MaskingStrategies.ts | 6 +- ...MaskingStrategyConfigurationDescription.ts | 15 +- .../api/models/MaskingStrategyDescription.ts | 15 +- .../api/models/MaskingStrategyOverride.ts | 8 +- .../src/types/api/models/MatchesEnum.ts | 6 +- .../types/api/models/MessagingActionType.ts | 7 +- .../api/models/MessagingConfigRequest.ts | 87 +- .../api/models/MessagingConfigRequestBase.ts | 11 +- .../api/models/MessagingConfigResponse.ts | 27 +- .../types/api/models/MessagingConfigStatus.ts | 6 +- .../models/MessagingConfigStatusMessage.ts | 11 +- .../models/MessagingConnectionTestStatus.ts | 7 +- .../src/types/api/models/MessagingMethod.ts | 6 +- .../api/models/MessagingSecretsMailgunDocs.ts | 9 +- .../models/MessagingSecretsTwilioEmailDocs.ts | 9 +- .../models/MessagingSecretsTwilioSMSDocs.ts | 18 +- .../models/MessagingServiceDetailsAWS_SES.ts | 15 +- ...ingServiceDetailsMailchimpTransactional.ts | 9 +- .../models/MessagingServiceDetailsMailgun.ts | 15 +- .../MessagingServiceDetailsTwilioEmail.ts | 9 +- .../MessagingServiceSecretsAWS_SESDocs.ts | 16 +- ...erviceSecretsMailchimpTransactionalDocs.ts | 9 +- .../types/api/models/MessagingServiceType.ts | 6 +- .../api/models/MessagingTemplateDefault.ts | 20 +- ...ssagingTemplateWithPropertiesBodyParams.ts | 20 +- .../MessagingTemplateWithPropertiesDetail.ts | 26 +- ...ngTemplateWithPropertiesPatchBodyParams.ts | 20 +- .../MessagingTemplateWithPropertiesSummary.ts | 19 +- .../api/models/MessagingTestBodyParams.ts | 12 + .../src/types/api/models/MinimalAsset.ts | 39 + .../types/api/models/MinimalClassifyParams.ts | 11 +- .../api/models/MinimalMessagingTemplate.ts | 12 +- .../models/MinimalPrivacyExperienceConfig.ts | 12 +- .../types/api/models/MinimalPrivacyNotice.ts | 12 +- .../src/types/api/models/MinimalProperty.ts | 13 +- .../api/models/MinimalTCFBannerTranslation.ts | 32 +- .../api/models/MinimalTCFExperienceConfig.ts | 30 +- .../src/types/api/models/MongoDBDocsSchema.ts | 26 +- .../types/api/models/MonitorActionResponse.ts | 9 +- .../types/api/models/MonitorClassifyParams.ts | 91 +- .../src/types/api/models/MonitorConfig.ts | 38 +- ...torConfigStagedResourcesAggregateRecord.ts | 39 +- .../types/api/models/MonitorDeletionImpact.ts | 37 + .../src/types/api/models/MonitorExecution.ts | 27 +- .../models/MonitorExecutionRequestResponse.ts | 12 +- .../api/models/MonitorExecutionStatus.ts | 7 +- .../src/types/api/models/MonitorFrequency.ts | 6 +- .../types/api/models/MonitorStatusResponse.ts | 46 +- .../api/models/MonitorStewardUserResponse.ts | 21 +- .../api/models/MonitorTaskDetailResponse.ts | 74 +- .../models/MonitorTaskInProgressResponse.ts | 22 - .../types/api/models/MonitorTaskResponse.ts | 55 +- .../src/types/api/models/MonitorTaskType.ts | 6 +- .../src/types/api/models/MySQLDocsSchema.ts | 22 +- .../src/types/api/models/MySQLSSLMode.ts | 8 +- .../src/types/api/models/NestedFieldDict.ts | 15 + .../src/types/api/models/NoticeTranslation.ts | 14 +- .../api/models/NoticeTranslationCreate.ts | 14 +- .../api/models/NoticeTranslationResponse.ts | 16 +- .../models/NotificationApplicationConfig.ts | 24 +- .../src/types/api/models/OAuthConfigSchema.ts | 28 + .../src/types/api/models/OAuthGrantType.ts | 10 + .../src/types/api/models/OktaConfig.ts | 22 +- .../src/types/api/models/OktaDocsSchema.ts | 26 +- .../src/types/api/models/OktaMonitorConfig.ts | 42 + .../src/types/api/models/OpenIDProvider.ts | 47 +- .../types/api/models/OpenIDProviderCreate.ts | 44 +- .../types/api/models/OpenIDProviderSimple.ts | 14 +- .../admin-ui/src/types/api/models/Operator.ts | 7 +- .../models/OptionalStagedResourcesRequest.ts | 15 + .../src/types/api/models/Organization.ts | 21 +- .../types/api/models/OrganizationMetadata.ts | 8 +- .../src/types/api/models/OverrideMode.ts | 12 - .../api/models/Page_AssessmentResponse_.ts | 22 +- .../models/Page_AssessmentTaskResponse_.ts | 29 + .../src/types/api/models/Page_Asset_.ts | 30 +- .../api/models/Page_AttachmentResponse_.ts | 30 +- .../Page_BasicSystemResponseExtended_.ts | 30 +- .../Page_ClassificationBenchmarkSummary_.ts | 29 + .../Page_ClassifyInstanceResponseValues_.ts | 30 +- .../types/api/models/Page_CommentResponse_.ts | 30 +- .../Page_ConnectionConfigurationResponse_.ts | 30 +- .../models/Page_ConnectionSystemTypeMap_.ts | 30 +- .../api/models/Page_ConsentBreakdown_.ts | 30 +- .../types/api/models/Page_ConsentReport_.ts | 30 +- .../models/Page_ConsentReportingSchema_.ts | 13 - .../Page_CustomReportResponseMinimal_.ts | 30 +- .../api/models/Page_CustomReportResponse_.ts | 30 +- .../types/api/models/Page_DatamapReport_.ts | 30 +- .../api/models/Page_DatasetConfigSchema_.ts | 30 +- .../types/api/models/Page_DatasetResponse_.ts | 30 +- .../src/types/api/models/Page_Dataset_.ts | 30 +- ...age_DatastoreStagedResourceAPIResponse_.ts | 30 +- ...DatastoreStagedResourceTreeAPIResponse_.ts | 13 - .../api/models/Page_DigestConfigResponse_.ts | 29 + .../api/models/Page_EventAuditResponse_.ts | 30 +- .../Page_ExecutionLogDetailResponse_.ts | 30 +- .../Page_ExperienceConfigListViewResponse_.ts | 30 +- .../api/models/Page_FieldAccuracyDetail_.ts | 29 + .../src/types/api/models/Page_Language_.ts | 30 +- ...age_LimitedPrivacyNoticeResponseSchema_.ts | 30 +- .../models/Page_ManualTaskConfigResponse_.ts | 30 +- .../api/models/Page_ManualTaskResponse_.ts | 30 +- .../models/Page_MessagingConfigResponse_.ts | 30 +- ...MessagingTemplateWithPropertiesSummary_.ts | 30 +- ...orConfigStagedResourcesAggregateRecord_.ts | 30 +- .../api/models/Page_MonitorExecution_.ts | 30 +- .../api/models/Page_MonitorStatusResponse_.ts | 30 +- .../api/models/Page_MonitorTaskResponse_.ts | 30 +- .../types/api/models/Page_PolicyResponse_.ts | 22 +- .../api/models/Page_PolicyWebhookResponse_.ts | 30 +- .../Page_PreApprovalWebhookResponse_.ts | 30 +- .../Page_PrivacyExperienceMetaResponse_.ts | 30 +- .../src/types/api/models/Page_Property_.ts | 30 +- .../models/Page_RuleResponseWithTargets_.ts | 30 +- .../src/types/api/models/Page_RuleTarget_.ts | 30 +- .../api/models/Page_SharedMonitorConfig_.ts | 30 +- .../models/Page_StagedResourceAPIResponse_.ts | 30 +- .../Page_StorageDestinationResponse_.ts | 30 +- .../api/models/Page_SystemHistoryResponse_.ts | 30 +- ...e_SystemStagedResourcesAggregateRecord_.ts | 30 +- .../types/api/models/Page_SystemSummary_.ts | 30 +- .../api/models/Page_SystemWithMonitorKeys_.ts | 30 +- .../models/Page_TCFConfigurationResponse_.ts | 30 +- .../Page_TCFPublisherRestrictionResponse_.ts | 30 +- .../api/models/Page_TemplateResponse_.ts | 22 +- ...e__TCFBannerExperienceMinimalResponse__.ts | 30 +- ...rboseResponse__PrivacyRequestResponse__.ts | 30 +- .../types/api/models/Page_UserResponse_.ts | 30 +- .../src/types/api/models/Page_str_.ts | 30 +- .../PaginatedResponse_ConsentResponse_.ts | 25 + .../api/models/PaginationFilterParams.ts | 37 + .../src/types/api/models/ParamValue.ts | 25 +- .../admin-ui/src/types/api/models/Params.ts | 19 + .../api/models/PartialPrivacyCenterConfig.ts | 9 +- .../api/models/PartialPrivacyRequestOption.ts | 26 +- .../models/PeriodicIntegrationFrequency.ts | 6 +- .../types/api/models/PlusApplicationConfig.ts | 13 +- .../PlusConsentSettingsApplicationConfig.ts | 10 +- .../api/models/PolicyConditionRequest.ts | 8 +- .../api/models/PolicyConditionResponse.ts | 8 +- .../src/types/api/models/PolicyMaskingSpec.ts | 16 +- .../api/models/PolicyMaskingSpecResponse.ts | 9 +- .../src/types/api/models/PolicyResponse.ts | 29 +- .../src/types/api/models/PolicyRule.ts | 9 +- .../api/models/PolicyUnavailableMessages.ts | 21 +- .../types/api/models/PolicyWebhookCreate.ts | 17 +- .../api/models/PolicyWebhookDeleteResponse.ts | 9 +- .../types/api/models/PolicyWebhookResponse.ts | 17 +- .../types/api/models/PolicyWebhookUpdate.ts | 17 +- .../api/models/PolicyWebhookUpdateResponse.ts | 9 +- .../types/api/models/PostgreSQLDocsSchema.ts | 23 +- .../api/models/PreApprovalWebhookCreate.ts | 15 +- .../api/models/PreApprovalWebhookResponse.ts | 12 +- .../api/models/PreApprovalWebhookUpdate.ts | 12 +- .../PreVerifiedPrivacyPreferencesRequest.ts | 68 +- .../types/api/models/PreferenceFidesMeta.ts | 19 +- .../api/models/PreferenceFidesMetaCreate.ts | 10 +- .../src/types/api/models/PreferenceMeta.ts | 15 - .../types/api/models/PreferenceMetaCreate.ts | 7 +- .../api/models/PreferenceMetaResponse.ts | 18 + .../src/types/api/models/PreferenceSource.ts | 12 - .../src/types/api/models/PreferenceType.ts | 6 +- .../models/PreferenceWithNoticeInformation.ts | 23 +- .../src/types/api/models/PreferencesSaved.ts | 36 +- .../api/models/PreferencesSavedExtended.ts | 36 +- .../models/PrivacyAssessmentConfigDefaults.ts | 21 + .../models/PrivacyAssessmentConfigResponse.ts | 53 + .../models/PrivacyAssessmentConfigUpdate.ts | 33 + .../types/api/models/PrivacyDeclaration.ts | 40 +- .../api/models/PrivacyDeclarationResponse.ts | 42 +- .../models/PrivacyExperienceGPPSettings.ts | 26 +- .../models/PrivacyExperienceMetaResponse.ts | 15 +- .../api/models/PrivacyExperienceResponse.ts | 79 +- .../types/api/models/PrivacyNoticeCreation.ts | 39 +- .../models/PrivacyNoticeDisabledResponse.ts | 12 +- .../api/models/PrivacyNoticeDisabledUpdate.ts | 9 +- .../api/models/PrivacyNoticeFramework.ts | 7 +- .../types/api/models/PrivacyNoticeRegion.ts | 7 +- .../types/api/models/PrivacyNoticeResponse.ts | 63 +- .../PrivacyNoticeResponseWithRegions.ts | 46 +- .../types/api/models/PrivacyNoticeUpdate.ts | 39 +- .../api/models/PrivacyPreferenceStats.ts | 9 +- .../api/models/PrivacyPreferencesRequest.ts | 71 +- .../api/models/PrivacyRequestAccessResults.ts | 9 +- .../api/models/PrivacyRequestBulkSelection.ts | 34 + .../types/api/models/PrivacyRequestCreate.ts | 30 - .../models/PrivacyRequestCreateExtended.ts | 75 + .../api/models/PrivacyRequestDRPStatus.ts | 6 +- .../models/PrivacyRequestDRPStatusResponse.ts | 26 +- ...PrivacyRequestDiagnosticsExportResponse.ts | 18 +- .../models/PrivacyRequestFieldDefinition.ts | 35 + .../models/PrivacyRequestFieldsResponse.ts | 18 + .../types/api/models/PrivacyRequestFilter.ts | 93 +- .../models/PrivacyRequestNotificationInfo.ts | 13 +- .../types/api/models/PrivacyRequestOption.ts | 46 +- .../PrivacyRequestRedactionPatternsRequest.ts | 15 + ...PrivacyRequestRedactionPatternsResponse.ts | 15 + .../api/models/PrivacyRequestResponse.ts | 94 +- .../api/models/PrivacyRequestResumeFormat.ts | 10 +- .../types/api/models/PrivacyRequestSource.ts | 6 +- .../types/api/models/PrivacyRequestStatus.ts | 7 +- .../api/models/PrivacyRequestTaskSchema.ts | 28 +- .../types/api/models/PrivacyRequestUser.ts | 12 +- .../models/PrivacyRequestVerboseResponse.ts | 96 +- .../src/types/api/models/PrivacyRule.ts | 10 +- .../src/types/api/models/PromoteErrorInfo.ts | 21 + .../api/models/PromoteResourcesResponse.ts | 8 +- .../src/types/api/models/PromoteResponse.ts | 27 + .../src/types/api/models/PromoteSummary.ts | 27 + .../types/api/models/PromotedSystemInfo.ts | 33 + .../src/types/api/models/PromptCategory.ts | 11 + .../src/types/api/models/PromptInfo.ts | 38 + .../src/types/api/models/PromptType.ts | 14 + .../types/api/models/PropagationPolicyKey.ts | 7 +- .../admin-ui/src/types/api/models/Property.ts | 30 +- .../src/types/api/models/PropertyCreate.ts | 28 +- .../models/PropertyNameResolutionRequest.ts | 13 + .../models/PropertyNameResolutionResponse.ts | 13 + .../src/types/api/models/PropertyType.ts | 7 +- .../src/types/api/models/ProviderEnum.ts | 7 +- .../api/models/PublicPropertyResponse.ts | 30 +- .../src/types/api/models/PurposesResponse.ts | 21 +- .../src/types/api/models/QueryParam.ts | 13 +- .../types/api/models/QuestionProgressItem.ts | 29 + .../api/models/QuestionnaireStatusResponse.ts | 59 + .../src/types/api/models/QueueInfo.ts | 10 +- .../types/api/models/RDSMySQLDocsSchema.ts | 20 +- .../types/api/models/RDSPostgresDocsSchema.ts | 20 +- .../src/types/api/models/RangeEntry.ts | 10 +- .../src/types/api/models/RateLimit.ts | 14 +- .../src/types/api/models/RateLimitConfig.ts | 12 +- .../src/types/api/models/RateLimitPeriod.ts | 6 +- .../src/types/api/models/ReadSaaSRequest.ts | 55 +- .../api/models/RecalculateConsentResponse.ts | 8 +- .../api/models/RecordConsentServedRequest.ts | 63 +- .../types/api/models/RecordsServedResponse.ts | 39 +- .../types/api/models/RedshiftDocsSchema.ts | 20 +- .../src/types/api/models/Registration.ts | 18 +- .../types/api/models/RejectAllMechanism.ts | 6 +- .../types/api/models/RenderPromptRequest.ts | 32 + .../types/api/models/RenderPromptResponse.ts | 28 + .../types/api/models/ReportExportFormat.ts | 7 +- .../src/types/api/models/ReportType.ts | 6 +- .../src/types/api/models/RequestOrigin.ts | 7 +- .../api/models/RequestTaskCallbackRequest.ts | 14 +- .../src/types/api/models/ResourceError.ts | 20 +- .../src/types/api/models/ResourceFilter.ts | 10 +- .../src/types/api/models/ResourceTypes.ts | 6 +- .../src/types/api/models/ResponseFormat.ts | 6 +- .../types/api/models/ResponseWithMessage.ts | 9 +- .../src/types/api/models/ResultSetStats.ts | 25 + .../types/api/models/RevertAnswerRequest.ts | 8 +- .../api/models/ReviewPrivacyRequestIds.ts | 10 - .../src/types/api/models/RoleRegistryEnum.ts | 6 +- .../src/types/api/models/RuleCreate.ts | 17 +- .../types/api/models/RuleCreateWithTargets.ts | 31 + .../src/types/api/models/RuleResponse.ts | 14 +- .../api/models/RuleResponseWithTargets.ts | 17 +- .../src/types/api/models/RuleTarget.ts | 15 +- .../admin-ui/src/types/api/models/S3Config.ts | 30 + .../src/types/api/models/S3DocsSchema.ts | 16 +- .../src/types/api/models/S3MonitorParams.ts | 9 +- .../src/types/api/models/SaaSConfig.ts | 34 +- .../src/types/api/models/SaaSConfigBase.ts | 15 +- .../api/models/SaaSConfigValidationDetails.ts | 9 +- .../src/types/api/models/SaaSDisplayInfo.ts | 16 +- .../src/types/api/models/SaaSRequest.ts | 50 +- .../src/types/api/models/SaaSRequestMap.ts | 9 +- .../src/types/api/models/SaaSSchema.ts | 10 +- .../models/SaasConnectionTemplateResponse.ts | 7 +- .../models/SaasConnectionTemplateValues.ts | 825 +- .../SaasConnectionTemplateValuesExtended.ts | 831 +- .../admin-ui/src/types/api/models/Schema.ts | 97 +- .../src/types/api/models/ScopeRegistryEnum.ts | 682 +- .../src/types/api/models/ScyllaDocsSchema.ts | 16 +- .../api/models/SecurityApplicationConfig.ts | 9 +- .../types/api/models/SeedExecutionStatus.ts | 13 + .../src/types/api/models/SeedRequest.ts | 33 + .../src/types/api/models/SeedResponse.ts | 21 + .../types/api/models/SeedStatusResponse.ts | 48 + .../src/types/api/models/SeedStepStatus.ts | 33 + .../src/types/api/models/SeedTaskStatus.ts | 14 + .../src/types/api/models/SeedTasksConfig.ts | 63 + .../src/types/api/models/Selection.ts | 12 +- .../types/api/models/SendMessageRequest.ts | 12 +- .../types/api/models/SendMessageResponse.ts | 12 +- .../api/models/SendQuestionnaireRequest.ts | 27 + .../api/models/SendQuestionnaireResponse.ts | 25 + .../types/api/models/SendReminderRequest.ts | 15 + .../types/api/models/SendReminderResponse.ts | 25 + .../src/types/api/models/ServiceHealth.ts | 6 +- .../src/types/api/models/ServingComponent.ts | 6 +- .../types/api/models/SetSystemLinksRequest.ts | 13 + .../types/api/models/SharedMonitorConfig.ts | 15 +- .../models/SingleFieldSubmissionResponse.ts | 49 +- .../src/types/api/models/SlackChannel.ts | 12 +- .../types/api/models/SnowflakeDocsSchema.ts | 24 +- .../src/types/api/models/SourcePreference.ts | 21 + .../src/types/api/models/SovrnDocsSchema.ts | 15 +- .../models/SpecialCategoryLegalBasisEnum.ts | 16 +- .../src/types/api/models/SqlDryRunMode.ts | 6 +- .../src/types/api/models/StagedResource.ts | 45 +- .../api/models/StagedResourceAPIResponse.ts | 145 +- .../api/models/StagedResourceTypeValue.ts | 6 +- .../api/models/StagedResourceUpdateRequest.ts | 17 +- .../src/types/api/models/StatusEnum.ts | 6 +- .../src/types/api/models/StatusType.ts | 6 +- .../api/models/StorageApplicationConfig.ts | 9 +- .../types/api/models/StorageConfigStatus.ts | 6 +- .../api/models/StorageConfigStatusMessage.ts | 11 +- .../types/api/models/StorageDestination.ts | 19 +- .../api/models/StorageDestinationBase.ts | 13 +- .../api/models/StorageDestinationResponse.ts | 27 +- .../src/types/api/models/StorageDetails.ts | 8 +- .../src/types/api/models/StorageDetailsGCS.ts | 17 +- .../types/api/models/StorageDetailsLocal.ts | 9 +- .../src/types/api/models/StorageDetailsS3.ts | 25 +- .../types/api/models/StorageSecretsGCSDocs.ts | 39 +- .../types/api/models/StorageSecretsS3Docs.ts | 18 +- .../src/types/api/models/StorageType.ts | 6 +- .../api/models/StorageTypeApiAccepted.ts | 6 +- .../admin-ui/src/types/api/models/Strategy.ts | 16 +- .../src/types/api/models/SupportedLanguage.ts | 7 +- .../admin-ui/src/types/api/models/System.ts | 89 +- .../src/types/api/models/SystemGroup.ts | 26 +- .../src/types/api/models/SystemGroupCreate.ts | 24 +- .../src/types/api/models/SystemGroupUpdate.ts | 24 +- .../types/api/models/SystemHistoryResponse.ts | 29 +- .../src/types/api/models/SystemLinkRequest.ts | 10 +- .../types/api/models/SystemLinkResponse.ts | 18 +- .../src/types/api/models/SystemMetadata.ts | 12 +- .../types/api/models/SystemPurposeSummary.ts | 27 +- .../src/types/api/models/SystemResponse.ts | 96 +- .../api/models/SystemResponseExtended.ts | 98 +- .../src/types/api/models/SystemScanHistory.ts | 22 +- .../types/api/models/SystemScanResponse.ts | 10 +- .../types/api/models/SystemScannerStatus.ts | 14 +- .../types/api/models/SystemSchemaExtended.ts | 91 +- .../SystemStagedResourcesAggregateRecord.ts | 31 +- .../src/types/api/models/SystemSummary.ts | 33 +- .../src/types/api/models/SystemType.ts | 7 +- .../types/api/models/SystemWithMonitorKeys.ts | 99 +- .../src/types/api/models/SystemsDiff.ts | 40 +- .../admin-ui/src/types/api/models/TCDecode.ts | 6 +- .../TCFBannerExperienceMinimalResponse.ts | 51 +- .../api/models/TCFConfigurationDetail.ts | 18 +- .../api/models/TCFConfigurationRequest.ts | 8 +- .../api/models/TCFConfigurationResponse.ts | 10 +- .../src/types/api/models/TCFFeatureRecord.ts | 20 +- .../src/types/api/models/TCFFeatureSave.ts | 11 +- .../src/types/api/models/TCFLegalBasisEnum.ts | 6 +- .../src/types/api/models/TCFPreferences.ts | 33 +- .../models/TCFPublisherRestrictionRequest.ts | 14 +- .../TCFPublisherRestrictionUpdateRequest.ts | 12 +- .../api/models/TCFPurposeConsentRecord.ts | 24 +- .../TCFPurposeLegitimateInterestsRecord.ts | 24 +- .../api/models/TCFPurposeOverrideSchema.ts | 14 +- .../src/types/api/models/TCFPurposeSave.ts | 11 +- .../types/api/models/TCFRestrictionType.ts | 6 +- .../api/models/TCFSpecialFeatureRecord.ts | 20 +- .../types/api/models/TCFSpecialFeatureSave.ts | 11 +- .../api/models/TCFSpecialPurposeRecord.ts | 27 +- .../types/api/models/TCFSpecialPurposeSave.ts | 11 +- .../src/types/api/models/TCFStatus.ts | 10 +- .../api/models/TCFVendorConsentRecord.ts | 26 +- .../TCFVendorLegitimateInterestsRecord.ts | 26 +- .../api/models/TCFVendorRelationships.ts | 48 +- .../types/api/models/TCFVendorRestriction.ts | 6 +- .../src/types/api/models/TCFVendorSave.ts | 11 +- .../src/types/api/models/TCMobileData.ts | 49 +- .../admin-ui/src/types/api/models/Table.ts | 101 +- .../src/types/api/models/TableContext.ts | 23 + .../src/types/api/models/TaskDetails.ts | 28 +- .../src/types/api/models/TaskRunType.ts | 6 +- .../src/types/api/models/TaxonomyCreate.ts | 17 +- .../src/types/api/models/TaxonomyElement.ts | 18 +- .../types/api/models/TaxonomyElementCreate.ts | 16 +- .../types/api/models/TaxonomyElementUpdate.ts | 14 +- .../src/types/api/models/TaxonomyResponse.ts | 14 +- .../src/types/api/models/TaxonomyUpdate.ts | 15 +- .../src/types/api/models/TemplateResponse.ts | 36 +- .../src/types/api/models/TemplateVariable.ts | 30 + .../api/models/TestMessagingStatusMessage.ts | 14 +- .../src/types/api/models/TestMonitorParams.ts | 36 +- .../types/api/models/TestPrivacyRequest.ts | 9 +- .../src/types/api/models/TestStatus.ts | 7 +- .../src/types/api/models/TestStatusMessage.ts | 14 +- .../api/models/TestWebsiteMonitorParams.ts | 50 +- .../types/api/models/TimeBasedPartitioning.ts | 14 +- .../src/types/api/models/TimeInclusivity.ts | 11 + .../types/api/models/TimescaleDocsSchema.ts | 23 +- .../src/types/api/models/ToneResponse.ts | 13 + .../src/types/api/models/ToneUpdate.ts | 13 + .../api/models/TreeResourceChangeIndicator.ts | 9 - .../types/api/models/UnlabeledIdentities.ts | 13 +- .../types/api/models/UnverifiedIdentity.ts | 29 +- .../UnverifiedPrivacyPreferencesRequest.ts | 63 +- .../types/api/models/UpdateAnswerRequest.ts | 8 +- .../models/UpdateMonitorStewardsRequest.ts | 8 +- .../types/api/models/UserConsentPreference.ts | 7 +- .../types/api/models/UserCreateExtended.ts | 26 +- .../types/api/models/UserCreateResponse.ts | 9 +- .../types/api/models/UserEmailInviteStatus.ts | 10 +- .../api/models/UserForcePasswordReset.ts | 9 +- .../src/types/api/models/UserLogin.ts | 12 +- .../src/types/api/models/UserLoginResponse.ts | 6 +- .../src/types/api/models/UserPasswordReset.ts | 12 +- .../types/api/models/UserPermissionsCreate.ts | 11 +- .../types/api/models/UserPermissionsEdit.ts | 14 +- .../api/models/UserPermissionsPlusResponse.ts | 22 +- .../src/types/api/models/UserResponse.ts | 30 +- .../types/api/models/UserResponseExtended.ts | 32 +- .../src/types/api/models/UserUpdate.ts | 15 +- .../src/types/api/models/ValidTargets.ts | 6 +- .../api/models/ValidateDatasetResponse.ts | 6 +- .../src/types/api/models/ValidateRequest.ts | 11 +- .../src/types/api/models/ValidateResponse.ts | 11 +- .../api/models/ValidateSaaSConfigResponse.ts | 6 +- .../src/types/api/models/ValidationError.ts | 16 +- .../api/models/ValidationErrorResponse.ts | 15 + .../src/types/api/models/ValidationStatus.ts | 6 +- .../src/types/api/models/ValidationTarget.ts | 6 +- .../src/types/api/models/ValuesList.ts | 10 +- .../src/types/api/models/VendorIds.ts | 10 +- .../types/api/models/VendorMatchConfidence.ts | 6 +- .../src/types/api/models/VendorMatchStats.ts | 39 + .../src/types/api/models/VerificationCode.ts | 9 +- .../src/types/api/models/Violation.ts | 8 +- .../types/api/models/ViolationAttributes.ts | 12 +- .../src/types/api/models/WebMonitorUpdates.ts | 22 +- .../src/types/api/models/WebhookDirection.ts | 6 +- .../src/types/api/models/WebhookOrder.ts | 12 +- .../api/models/WebsiteClassificationReport.ts | 69 + .../types/api/models/WebsiteMonitorConfig.ts | 36 + .../types/api/models/WebsiteMonitorParams.ts | 13 +- .../models/WebsiteMonitorResourcesFilters.ts | 21 +- .../src/types/api/models/WebsiteSchema.ts | 9 +- .../src/types/api/models/WorkerHealthCheck.ts | 19 +- .../src/types/api/models/WorkerInfo.ts | 13 +- .../src/types/api/models/WorkerStats.ts | 21 +- .../databaseHealthHealthDatabaseGetData.ts | 8 + .../databaseHealthHealthDatabaseGetErrors.ts | 8 + ...databaseHealthHealthDatabaseGetResponse.ts | 6 + ...atabaseHealthHealthDatabaseGetResponses.ts | 10 + ...emas__application_config__ConsentConfig.ts | 10 +- ...application_config__PrivacyCenterConfig.ts | 10 +- ...nnection_secrets_bigquery__KeyfileCreds.ts | 36 +- ...ts_google_cloud_sql_mysql__KeyfileCreds.ts | 39 +- ...google_cloud_sql_postgres__KeyfileCreds.ts | 39 +- .../fides__api__schemas__policy__Policy.ts | 24 +- ...s__privacy_center_config__ConsentConfig.ts | 7 +- ...enter_config__CustomPrivacyRequestField.ts | 32 +- ...acy_center_config__PrivacyCenterConfig.ts} | 47 +- ...schemas__privacy_request__IdentityValue.ts | 25 + ..._redis_cache__CustomPrivacyRequestField.ts | 14 +- ...es__api__schemas__redis_cache__Identity.ts | 48 + ...fides__connectors__models__KeyfileCreds.ts | 36 +- .../api/models/fideslang__models__Policy.ts | 19 +- ...ctions__TCFPublisherRestrictionResponse.ts | 18 +- ...nnection_secrets_bigquery__KeyfileCreds.ts | 50 + ...rience__TCFPublisherRestrictionResponse.ts | 15 +- ...esplus__v3__schemas__identity__Identity.ts | 13 +- ...s__v3__schemas__identity__IdentityValue.ts | 19 +- .../types/api/models/healthHealthGetData.ts | 13 + .../types/api/models/healthHealthGetError.ts | 6 + .../types/api/models/healthHealthGetErrors.ts | 14 + .../api/models/healthHealthGetResponse.ts | 6 + .../api/models/healthHealthGetResponses.ts | 10 + .../src/types/api/models/readIndexGetData.ts | 8 + .../types/api/models/readIndexGetResponses.ts | 8 + .../models/readOtherPathsCatchallGetData.ts | 8 + .../readOtherPathsCatchallGetResponses.ts | 8 + .../workersHealthHealthWorkersGetData.ts | 8 + .../workersHealthHealthWorkersGetErrors.ts | 8 + .../workersHealthHealthWorkersGetResponse.ts | 6 + .../workersHealthHealthWorkersGetResponses.ts | 10 + clients/admin-ui/src/types/api/types.ts | 25224 ++++++++++++++++ 909 files changed, 46312 insertions(+), 4159 deletions(-) delete mode 100644 clients/admin-ui/src/types/api/README.md create mode 100644 clients/admin-ui/src/types/api/models/APIMonitorType.ts create mode 100644 clients/admin-ui/src/types/api/models/ActionValidationErrorResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/AssessmentTaskResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/AssessmentTaskSystemInfo.ts create mode 100644 clients/admin-ui/src/types/api/models/AssetReportingFilters.ts create mode 100644 clients/admin-ui/src/types/api/models/AssignStewardRequest.ts delete mode 100644 clients/admin-ui/src/types/api/models/AsyncConfig.ts delete mode 100644 clients/admin-ui/src/types/api/models/AsyncStrategy.ts create mode 100644 clients/admin-ui/src/types/api/models/BackfillRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/BackfillStatusResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/BedrockConnectionTestRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/BedrockConnectionTestResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/BenchmarkStatus.ts create mode 100644 clients/admin-ui/src/types/api/models/BigQueryMonitorConfig.ts create mode 100644 clients/admin-ui/src/types/api/models/Body_Update_tagging_instructions_api_v1_data_category__fides_key__tagging_instructions_patch.ts create mode 100644 clients/admin-ui/src/types/api/models/BulkConditionAssignment.ts create mode 100644 clients/admin-ui/src/types/api/models/BulkDatasetPropertyResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/BulkPropertyAssignment.ts create mode 100644 clients/admin-ui/src/types/api/models/BulkPropertyRemoval.ts create mode 100644 clients/admin-ui/src/types/api/models/BulkUserAssignment.ts create mode 100644 clients/admin-ui/src/types/api/models/CancelPrivacyRequestSelection.ts create mode 100644 clients/admin-ui/src/types/api/models/CategoryDistribution.ts create mode 100644 clients/admin-ui/src/types/api/models/ChatConfigResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/ChatConfigSecrets.ts create mode 100644 clients/admin-ui/src/types/api/models/ChatConfigTestResponse.ts delete mode 100644 clients/admin-ui/src/types/api/models/ChatProviderSecrets.ts delete mode 100644 clients/admin-ui/src/types/api/models/ChatProviderSettingsResponse.ts delete mode 100644 clients/admin-ui/src/types/api/models/ChatProviderTestResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/ClassificationBenchmarkRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/ClassificationBenchmarkResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/ClassificationBenchmarkSummary.ts create mode 100644 clients/admin-ui/src/types/api/models/ClassificationCoverage.ts create mode 100644 clients/admin-ui/src/types/api/models/ClassificationErrorSchema.ts create mode 100644 clients/admin-ui/src/types/api/models/ClassifyInput.ts create mode 100644 clients/admin-ui/src/types/api/models/ClassifyLabel.ts create mode 100644 clients/admin-ui/src/types/api/models/ClassifyOutput.ts delete mode 100644 clients/admin-ui/src/types/api/models/ClassifyResourcesResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/ClassifyResult.ts create mode 100644 clients/admin-ui/src/types/api/models/ClientOptions.ts create mode 100644 clients/admin-ui/src/types/api/models/ColumnInfo.ts create mode 100644 clients/admin-ui/src/types/api/models/ConditionalTotalPage_ConsentReportingSchema_.ts create mode 100644 clients/admin-ui/src/types/api/models/ConfidenceDistribution.ts create mode 100644 clients/admin-ui/src/types/api/models/ConnectorTemplateListResponse.ts delete mode 100644 clients/admin-ui/src/types/api/models/CreateAssessmentRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/CreateAssessmentTaskRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/CreateAssessmentTaskResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/CreateExportPrivacyPreferencesJobRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/CreateExportPrivacyPreferencesJobResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/CreateIngestionPrivacyPreferencesJobRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/CreateIngestionPrivacyPreferencesJobResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/DataSectionConfig.ts create mode 100644 clients/admin-ui/src/types/api/models/DatasetPropertyResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/DefaultPolicyConfigRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/DefaultPolicyConfigResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/DenyPrivacyRequestSelection.ts delete mode 100644 clients/admin-ui/src/types/api/models/DenyPrivacyRequests.ts create mode 100644 clients/admin-ui/src/types/api/models/DiffStatusDistribution.ts delete mode 100644 clients/admin-ui/src/types/api/models/DigestConfigListResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/DiscoveryMonitorsConfig.ts create mode 100644 clients/admin-ui/src/types/api/models/ExecutePromptRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/ExecutePromptResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/ExportFormat.ts create mode 100644 clients/admin-ui/src/types/api/models/FieldAccuracyDetail.ts create mode 100644 clients/admin-ui/src/types/api/models/GenerateTestDataRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/IDPActionType.ts create mode 100644 clients/admin-ui/src/types/api/models/IDPActionValidationErrorResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/IDPAllowedActionsResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/IDPBulkActionResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/IDPMonitorBulkSelection.ts create mode 100644 clients/admin-ui/src/types/api/models/IDPMonitorResourcesDynamicFilters.ts create mode 100644 clients/admin-ui/src/types/api/models/IDPMonitorResourcesFilter.ts delete mode 100644 clients/admin-ui/src/types/api/models/Identity.ts create mode 100644 clients/admin-ui/src/types/api/models/IdentityBase.ts create mode 100644 clients/admin-ui/src/types/api/models/IdentityDefinitionCreate.ts create mode 100644 clients/admin-ui/src/types/api/models/IdentityDefinitionEntity.ts create mode 100644 clients/admin-ui/src/types/api/models/IdentityDefinitionType.ts create mode 100644 clients/admin-ui/src/types/api/models/IdentityProvider.ts create mode 100644 clients/admin-ui/src/types/api/models/IdentityProviderMonitorConfig.ts delete mode 100644 clients/admin-ui/src/types/api/models/IdentityValue.ts create mode 100644 clients/admin-ui/src/types/api/models/IndexStatus.ts create mode 100644 clients/admin-ui/src/types/api/models/JiraIssueType.ts create mode 100644 clients/admin-ui/src/types/api/models/JiraOAuthInitiateRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/JiraOAuthInitiateResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/JiraPreviewRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/JiraProject.ts create mode 100644 clients/admin-ui/src/types/api/models/JiraStatusCategory.ts create mode 100644 clients/admin-ui/src/types/api/models/JiraTicketData.ts create mode 100644 clients/admin-ui/src/types/api/models/JiraTicketDocsSchema.ts create mode 100644 clients/admin-ui/src/types/api/models/LLMChatRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/LLMClassifyRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/LinkedDatasetInfo.ts create mode 100644 clients/admin-ui/src/types/api/models/LlmClassificationSample.ts delete mode 100644 clients/admin-ui/src/types/api/models/LocationIdentityField.ts create mode 100644 clients/admin-ui/src/types/api/models/MailgunConfig.ts delete mode 100644 clients/admin-ui/src/types/api/models/ManualTaskConfigurationType.ts create mode 100644 clients/admin-ui/src/types/api/models/ManualTaskExportRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/MessagingTestBodyParams.ts create mode 100644 clients/admin-ui/src/types/api/models/MinimalAsset.ts create mode 100644 clients/admin-ui/src/types/api/models/MonitorDeletionImpact.ts delete mode 100644 clients/admin-ui/src/types/api/models/MonitorTaskInProgressResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/NestedFieldDict.ts create mode 100644 clients/admin-ui/src/types/api/models/OAuthConfigSchema.ts create mode 100644 clients/admin-ui/src/types/api/models/OAuthGrantType.ts create mode 100644 clients/admin-ui/src/types/api/models/OktaMonitorConfig.ts create mode 100644 clients/admin-ui/src/types/api/models/OptionalStagedResourcesRequest.ts delete mode 100644 clients/admin-ui/src/types/api/models/OverrideMode.ts create mode 100644 clients/admin-ui/src/types/api/models/Page_AssessmentTaskResponse_.ts create mode 100644 clients/admin-ui/src/types/api/models/Page_ClassificationBenchmarkSummary_.ts delete mode 100644 clients/admin-ui/src/types/api/models/Page_ConsentReportingSchema_.ts delete mode 100644 clients/admin-ui/src/types/api/models/Page_DatastoreStagedResourceTreeAPIResponse_.ts create mode 100644 clients/admin-ui/src/types/api/models/Page_DigestConfigResponse_.ts create mode 100644 clients/admin-ui/src/types/api/models/Page_FieldAccuracyDetail_.ts create mode 100644 clients/admin-ui/src/types/api/models/PaginatedResponse_ConsentResponse_.ts create mode 100644 clients/admin-ui/src/types/api/models/PaginationFilterParams.ts create mode 100644 clients/admin-ui/src/types/api/models/Params.ts delete mode 100644 clients/admin-ui/src/types/api/models/PreferenceMeta.ts create mode 100644 clients/admin-ui/src/types/api/models/PreferenceMetaResponse.ts delete mode 100644 clients/admin-ui/src/types/api/models/PreferenceSource.ts create mode 100644 clients/admin-ui/src/types/api/models/PrivacyAssessmentConfigDefaults.ts create mode 100644 clients/admin-ui/src/types/api/models/PrivacyAssessmentConfigResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/PrivacyAssessmentConfigUpdate.ts create mode 100644 clients/admin-ui/src/types/api/models/PrivacyRequestBulkSelection.ts delete mode 100644 clients/admin-ui/src/types/api/models/PrivacyRequestCreate.ts create mode 100644 clients/admin-ui/src/types/api/models/PrivacyRequestCreateExtended.ts create mode 100644 clients/admin-ui/src/types/api/models/PrivacyRequestFieldDefinition.ts create mode 100644 clients/admin-ui/src/types/api/models/PrivacyRequestFieldsResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/PrivacyRequestRedactionPatternsRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/PrivacyRequestRedactionPatternsResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/PromoteErrorInfo.ts create mode 100644 clients/admin-ui/src/types/api/models/PromoteResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/PromoteSummary.ts create mode 100644 clients/admin-ui/src/types/api/models/PromotedSystemInfo.ts create mode 100644 clients/admin-ui/src/types/api/models/PromptCategory.ts create mode 100644 clients/admin-ui/src/types/api/models/PromptInfo.ts create mode 100644 clients/admin-ui/src/types/api/models/PromptType.ts create mode 100644 clients/admin-ui/src/types/api/models/PropertyNameResolutionRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/PropertyNameResolutionResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/QuestionProgressItem.ts create mode 100644 clients/admin-ui/src/types/api/models/QuestionnaireStatusResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/RenderPromptRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/RenderPromptResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/ResultSetStats.ts delete mode 100644 clients/admin-ui/src/types/api/models/ReviewPrivacyRequestIds.ts create mode 100644 clients/admin-ui/src/types/api/models/RuleCreateWithTargets.ts create mode 100644 clients/admin-ui/src/types/api/models/S3Config.ts create mode 100644 clients/admin-ui/src/types/api/models/SeedExecutionStatus.ts create mode 100644 clients/admin-ui/src/types/api/models/SeedRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/SeedResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/SeedStatusResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/SeedStepStatus.ts create mode 100644 clients/admin-ui/src/types/api/models/SeedTaskStatus.ts create mode 100644 clients/admin-ui/src/types/api/models/SeedTasksConfig.ts create mode 100644 clients/admin-ui/src/types/api/models/SendQuestionnaireRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/SendQuestionnaireResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/SendReminderRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/SendReminderResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/SetSystemLinksRequest.ts create mode 100644 clients/admin-ui/src/types/api/models/SourcePreference.ts create mode 100644 clients/admin-ui/src/types/api/models/TableContext.ts create mode 100644 clients/admin-ui/src/types/api/models/TemplateVariable.ts create mode 100644 clients/admin-ui/src/types/api/models/TimeInclusivity.ts create mode 100644 clients/admin-ui/src/types/api/models/ToneResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/ToneUpdate.ts delete mode 100644 clients/admin-ui/src/types/api/models/TreeResourceChangeIndicator.ts create mode 100644 clients/admin-ui/src/types/api/models/ValidationErrorResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/VendorMatchStats.ts create mode 100644 clients/admin-ui/src/types/api/models/WebsiteClassificationReport.ts create mode 100644 clients/admin-ui/src/types/api/models/WebsiteMonitorConfig.ts create mode 100644 clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetData.ts create mode 100644 clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetErrors.ts create mode 100644 clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetResponses.ts rename clients/admin-ui/src/types/api/models/{PrivacyCenterConfig.ts => fides__api__schemas__privacy_center_config__PrivacyCenterConfig.ts} (66%) create mode 100644 clients/admin-ui/src/types/api/models/fides__api__schemas__privacy_request__IdentityValue.ts create mode 100644 clients/admin-ui/src/types/api/models/fides__api__schemas__redis_cache__Identity.ts create mode 100644 clients/admin-ui/src/types/api/models/fidesplus__cls__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds.ts create mode 100644 clients/admin-ui/src/types/api/models/healthHealthGetData.ts create mode 100644 clients/admin-ui/src/types/api/models/healthHealthGetError.ts create mode 100644 clients/admin-ui/src/types/api/models/healthHealthGetErrors.ts create mode 100644 clients/admin-ui/src/types/api/models/healthHealthGetResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/healthHealthGetResponses.ts create mode 100644 clients/admin-ui/src/types/api/models/readIndexGetData.ts create mode 100644 clients/admin-ui/src/types/api/models/readIndexGetResponses.ts create mode 100644 clients/admin-ui/src/types/api/models/readOtherPathsCatchallGetData.ts create mode 100644 clients/admin-ui/src/types/api/models/readOtherPathsCatchallGetResponses.ts create mode 100644 clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetData.ts create mode 100644 clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetErrors.ts create mode 100644 clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetResponse.ts create mode 100644 clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetResponses.ts create mode 100644 clients/admin-ui/src/types/api/types.ts diff --git a/clients/admin-ui/src/types/api/README.md b/clients/admin-ui/src/types/api/README.md deleted file mode 100644 index c88c421fac9..00000000000 --- a/clients/admin-ui/src/types/api/README.md +++ /dev/null @@ -1,32 +0,0 @@ -# FidesCtl API Types - -**Do not manually edit these files.** - -The TypeScript files in this directory are auto-generated by OpenAPI. This ensures our frontend uses the same schema as the backend without needing to manually convert Python classes to TypeScript. Currently, we only generate model types. - -Use these types working with API requests & responses, for example: - -```ts -import { DatasetField } from "~/types/api"; -``` - -## Updating - -These files can by regenerated by running: - -``` -turbo run openapi:generate -``` - -**The Fides server must be running on `localhost:8080`**. This will read the schema hosted at and generate all TS files under `clients/admin-ui/src/types/api/`. - -You will also likely need to follow this by running `format`, in order to ensure the generated files are formatted correctly: - -``` -turbo run format -``` - -## Resources - -- [FastAPI Client Generation](https://fastapi.tiangolo.com/advanced/generate-clients/) -- [@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) diff --git a/clients/admin-ui/src/types/api/index.ts b/clients/admin-ui/src/types/api/index.ts index 12d2332e5b9..03f5e558e00 100644 --- a/clients/admin-ui/src/types/api/index.ts +++ b/clients/admin-ui/src/types/api/index.ts @@ -1,689 +1,887 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -export { AccessLevel } from "./models/AccessLevel"; -export type { AccessManualWebhookResponse } from "./models/AccessManualWebhookResponse"; -export type { AccessManualWebhooks } from "./models/AccessManualWebhooks"; -export type { AccessToken } from "./models/AccessToken"; -export type { AccuracyMetrics } from "./models/AccuracyMetrics"; -export { ActionType } from "./models/ActionType"; -export type { AdminUIConfig } from "./models/AdminUIConfig"; -export type { AdvancedSettings } from "./models/AdvancedSettings"; -export type { AdvancedSettingsWithExtendedIdentityTypes } from "./models/AdvancedSettingsWithExtendedIdentityTypes"; -export type { AesDecryptionRequest } from "./models/AesDecryptionRequest"; -export type { AesDecryptionResponse } from "./models/AesDecryptionResponse"; -export type { AesEncryptionRequest } from "./models/AesEncryptionRequest"; -export type { AesEncryptionResponse } from "./models/AesEncryptionResponse"; -export { AlertLevel } from "./models/AlertLevel"; -export { AllowedTypes } from "./models/AllowedTypes"; -export type { AllowList } from "./models/AllowList"; -export type { AllowListUpdate } from "./models/AllowListUpdate"; -export type { Asset } from "./models/Asset"; -export type { AssetCreate } from "./models/AssetCreate"; -export type { AssetUpdate } from "./models/AssetUpdate"; -export type { AssessmentResponse } from "./models/AssessmentResponse"; -export type { AssignedUserSummary } from "./models/AssignedUserSummary"; -export type { AsyncConfig } from "./models/AsyncConfig"; -export { AsyncStrategy } from "./models/AsyncStrategy"; -export type { AttachmentResponse } from "./models/AttachmentResponse"; -export { AttachmentType } from "./models/AttachmentType"; -export { AuditLogAction } from "./models/AuditLogAction"; -export type { AuthenticationMethods } from "./models/AuthenticationMethods"; -export { AWSAuthMethod } from "./models/AWSAuthMethod"; -export type { AWSConfig } from "./models/AWSConfig"; -export type { BasicMessagingTemplateRequest } from "./models/BasicMessagingTemplateRequest"; -export type { BasicMessagingTemplateResponse } from "./models/BasicMessagingTemplateResponse"; -export type { BasicSystemResponseExtended } from "./models/BasicSystemResponseExtended"; -export type { BigQueryConfig } from "./models/BigQueryConfig"; -export type { BigQueryDocsSchema } from "./models/BigQueryDocsSchema"; -export type { BigQueryMonitorParams } from "./models/BigQueryMonitorParams"; -export type { Body_acquire_access_token_api_v1_oauth_token_post } from "./models/Body_acquire_access_token_api_v1_oauth_token_post"; -export type { Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment__comment_id__attachment_post } from "./models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment__comment_id__attachment_post"; -export type { Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__comment__comment_id__attachment_post } from "./models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__comment__comment_id__attachment_post"; -export type { Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment__comment_id__attachment_post } from "./models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment__comment_id__attachment_post"; -export type { Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__attachment_post } from "./models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__attachment_post"; -export type { Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__attachment_post } from "./models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__attachment_post"; -export type { Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__attachment_post } from "./models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__attachment_post"; -export type { Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment_post } from "./models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment_post"; -export type { Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__comment_post } from "./models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__comment_post"; -export type { Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment_post } from "./models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment_post"; -export type { Body_export_minimal_datamap_with_format_api_v1_plus_datamap_minimal__export_format__post } from "./models/Body_export_minimal_datamap_with_format_api_v1_plus_datamap_minimal__export_format__post"; -export type { Body_skip_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__skip_post } from "./models/Body_skip_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__skip_post"; -export type { Body_submit_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__complete_post } from "./models/Body_submit_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__complete_post"; -export type { Body_upload_data_api_v1_storage__request_id__post } from "./models/Body_upload_data_api_v1_storage__request_id__post"; -export type { BulkCustomFieldRequest } from "./models/BulkCustomFieldRequest"; -export type { BulkPostPrivacyRequests } from "./models/BulkPostPrivacyRequests"; -export type { BulkPutBasicMessagingTemplateResponse } from "./models/BulkPutBasicMessagingTemplateResponse"; -export type { BulkPutConnectionConfiguration } from "./models/BulkPutConnectionConfiguration"; -export type { BulkPutDataset } from "./models/BulkPutDataset"; -export type { BulkPutPolicyResponse } from "./models/BulkPutPolicyResponse"; -export type { BulkPutRuleResponse } from "./models/BulkPutRuleResponse"; -export type { BulkPutRuleTargetResponse } from "./models/BulkPutRuleTargetResponse"; -export type { BulkPutStorageConfigResponse } from "./models/BulkPutStorageConfigResponse"; -export type { BulkReviewResponse } from "./models/BulkReviewResponse"; -export type { BulkSoftDeletePrivacyRequests } from "./models/BulkSoftDeletePrivacyRequests"; -export type { BulkUpdateFailed } from "./models/BulkUpdateFailed"; -export type { ChatChannelsResponse } from "./models/ChatChannelsResponse"; -export type { ChatConfigCreate } from "./models/ChatConfigCreate"; -export type { ChatConfigListResponse } from "./models/ChatConfigListResponse"; -export type { ChatConfigUpdate } from "./models/ChatConfigUpdate"; -export type { ChatProviderSecrets } from "./models/ChatProviderSecrets"; -export type { ChatProviderSettingsResponse } from "./models/ChatProviderSettingsResponse"; -export type { ChatProviderTestResponse } from "./models/ChatProviderTestResponse"; -export type { CheckpointActionRequiredDetails } from "./models/CheckpointActionRequiredDetails"; -export type { Classification } from "./models/Classification"; -export type { ClassificationResponse } from "./models/ClassificationResponse"; -export { ClassificationStatus } from "./models/ClassificationStatus"; -export type { ClassifyCollection } from "./models/ClassifyCollection"; -export type { ClassifyLlmParams } from "./models/ClassifyLlmParams"; -export { ClassifyLlmPromptTemplateOptions } from "./models/ClassifyLlmPromptTemplateOptions"; -export type { ClassifyDataFlow } from "./models/ClassifyDataFlow"; -export type { ClassifyDataset } from "./models/ClassifyDataset"; -export type { ClassifyDatasetResponse } from "./models/ClassifyDatasetResponse"; -export type { ClassifyEmpty } from "./models/ClassifyEmpty"; -export type { ClassifyField } from "./models/ClassifyField"; -export type { ClassifyInstanceResponseValues } from "./models/ClassifyInstanceResponseValues"; -export type { ClassifyParams } from "./models/ClassifyParams"; -export type { ClassifyRequestPayload } from "./models/ClassifyRequestPayload"; -export type { ClassifyStatusUpdatePayload } from "./models/ClassifyStatusUpdatePayload"; -export type { ClassifySystem } from "./models/ClassifySystem"; -export type { ClientConfig } from "./models/ClientConfig"; -export type { ClientCreatedResponse } from "./models/ClientCreatedResponse"; -export type { CloudConfig } from "./models/CloudConfig"; -export { ClusterHealth } from "./models/ClusterHealth"; -export type { CollectionAddressResponse } from "./models/CollectionAddressResponse"; -export type { CollectionMeta } from "./models/CollectionMeta"; -export type { ColumnMapItem } from "./models/ColumnMapItem"; -export { ColumnSort } from "./models/ColumnSort"; -export type { CommentResponse } from "./models/CommentResponse"; -export { CommentType } from "./models/CommentType"; -export { ComponentType } from "./models/ComponentType"; -export type { ConditionalValue } from "./models/ConditionalValue"; -export type { ConditionGroup } from "./models/ConditionGroup"; -export type { ConditionLeaf } from "./models/ConditionLeaf"; -export type { ConfigConsentOption } from "./models/ConfigConsentOption"; -export type { ConfirmResourcesResponse } from "./models/ConfirmResourcesResponse"; -export { ConnectionCategory } from "./models/ConnectionCategory"; -export type { ConnectionConfigurationResponse } from "./models/ConnectionConfigurationResponse"; -export type { ConnectionConfigurationResponseWithSystemKey } from "./models/ConnectionConfigurationResponseWithSystemKey"; -export type { ConnectionDatahubSyncDetail } from "./models/ConnectionDatahubSyncDetail"; -export { ConnectionDatahubSyncDetailStatus } from "./models/ConnectionDatahubSyncDetailStatus"; -export type { ConnectionDatahubSyncPayload } from "./models/ConnectionDatahubSyncPayload"; -export type { ConnectionDatahubSyncResponse } from "./models/ConnectionDatahubSyncResponse"; -export type { ConnectionSystemTypeMap } from "./models/ConnectionSystemTypeMap"; -export { ConnectionTestStatus } from "./models/ConnectionTestStatus"; -export { ConnectionType } from "./models/ConnectionType"; -export type { ConnectorParam } from "./models/ConnectorParam"; -export type { Consent } from "./models/Consent"; -export type { ConsentableItem } from "./models/ConsentableItem"; -export type { ConsentAlertInfo } from "./models/ConsentAlertInfo"; -export type { ConsentBreakdown } from "./models/ConsentBreakdown"; -export type { ConsentConfigButton } from "./models/ConsentConfigButton"; -export type { ConsentConfigPage } from "./models/ConsentConfigPage"; -export type { ConsentInfo } from "./models/ConsentInfo"; -export { ConsentMechanism } from "./models/ConsentMechanism"; -export { ConsentMethod } from "./models/ConsentMethod"; -export type { ConsentOptionCreate } from "./models/ConsentOptionCreate"; -export type { ConsentPreferences } from "./models/ConsentPreferences"; -export type { ConsentPreferencesWithVerificationCode } from "./models/ConsentPreferencesWithVerificationCode"; -export type { ConsentReport } from "./models/ConsentReport"; -export type { ConsentReportingSchema } from "./models/ConsentReportingSchema"; -export type { ConsentRequestCreateExtended } from "./models/ConsentRequestCreateExtended"; -export type { ConsentRequestMap } from "./models/ConsentRequestMap"; -export type { ConsentRequestResponse } from "./models/ConsentRequestResponse"; -export { ConsentStatus } from "./models/ConsentStatus"; -export type { ConsentStatusDetail } from "./models/ConsentStatusDetail"; -export type { ConsentStatusReason } from "./models/ConsentStatusReason"; -export type { ConsentWithExecutableStatus } from "./models/ConsentWithExecutableStatus"; -export type { Constraint } from "./models/Constraint"; -export { ConstraintType } from "./models/ConstraintType"; -export type { ContactDetails } from "./models/ContactDetails"; -export { Continent } from "./models/Continent"; -export { CoreHealthCheck } from "./models/CoreHealthCheck"; -export type { CreateAssessmentRequest } from "./models/CreateAssessmentRequest"; -export type { CreateConnectionConfigurationWithSecrets } from "./models/CreateConnectionConfigurationWithSecrets"; -export type { CreateConnectionConfigurationWithSecretsExtended } from "./models/CreateConnectionConfigurationWithSecretsExtended"; -export { CurrentStep } from "./models/CurrentStep"; -export { CustomAssetType } from "./models/CustomAssetType"; -export type { CustomField } from "./models/CustomField"; -export type { CustomFieldDefinition } from "./models/CustomFieldDefinition"; -export type { CustomFieldDefinitionResponse } from "./models/CustomFieldDefinitionResponse"; -export type { CustomFieldDefinitionWithId } from "./models/CustomFieldDefinitionWithId"; -export type { CustomFieldWithId } from "./models/CustomFieldWithId"; -export type { CustomReportConfig } from "./models/CustomReportConfig"; -export type { CustomReportCreate } from "./models/CustomReportCreate"; -export type { CustomReportResponse } from "./models/CustomReportResponse"; -export type { CustomReportResponseMinimal } from "./models/CustomReportResponseMinimal"; -export { CustomTaxonomyColor } from "./models/CustomTaxonomyColor"; -export type { Database } from "./models/Database"; -export type { DatabaseConfig } from "./models/DatabaseConfig"; -export type { DatabaseHealthCheck } from "./models/DatabaseHealthCheck"; -export type { DataCategory } from "./models/DataCategory"; -export type { DataCategoryCreateOrUpdate } from "./models/DataCategoryCreateOrUpdate"; -export type { DataFlow } from "./models/DataFlow"; -export type { DatahubDocsSchema } from "./models/DatahubDocsSchema"; -export { DATAMAP_GROUPING } from "./models/DATAMAP_GROUPING"; -export type { DatamapReport } from "./models/DatamapReport"; -export { DataResponsibilityTitle } from "./models/DataResponsibilityTitle"; -export type { Dataset } from "./models/Dataset"; -export type { DatasetCollection } from "./models/DatasetCollection"; -export type { DatasetConfigCtlDataset } from "./models/DatasetConfigCtlDataset"; -export type { DatasetConfigSchema } from "./models/DatasetConfigSchema"; -export type { DatasetField } from "./models/DatasetField"; -export type { DatasetMetadata } from "./models/DatasetMetadata"; -export type { DatasetReachability } from "./models/DatasetReachability"; -export type { DatasetResponse } from "./models/DatasetResponse"; -export type { DatasetSchema } from "./models/DatasetSchema"; -export type { DatasetTestRequest } from "./models/DatasetTestRequest"; -export type { DatasetTraversalDetails } from "./models/DatasetTraversalDetails"; -export type { DatastoreMonitorUpdates } from "./models/DatastoreMonitorUpdates"; -export type { DatastoreStagedResource } from "./models/DatastoreStagedResource"; -export type { DataSubject } from "./models/DataSubject"; -export type { DataSubjectCreateOrUpdate } from "./models/DataSubjectCreateOrUpdate"; -export type { DataSubjectRights } from "./models/DataSubjectRights"; -export { DataSubjectRightsEnum } from "./models/DataSubjectRightsEnum"; -export type { DataUpload } from "./models/DataUpload"; -export type { DataUse } from "./models/DataUse"; -export type { DataUseCreateOrUpdate } from "./models/DataUseCreateOrUpdate"; -export { DBActions } from "./models/DBActions"; -export type { DeletedResourcesResponse } from "./models/DeletedResourcesResponse"; -export type { DenyPrivacyRequests } from "./models/DenyPrivacyRequests"; -export type { DictionaryStatus } from "./models/DictionaryStatus"; -export { DiffStatus } from "./models/DiffStatus"; -export { DigestConditionType } from "./models/DigestConditionType"; -export type { DigestConfigListResponse } from "./models/DigestConfigListResponse"; -export type { DigestConfigRequest } from "./models/DigestConfigRequest"; -export type { DigestConfigResponse } from "./models/DigestConfigResponse"; -export { DigestType } from "./models/DigestType"; -export { DrpAction } from "./models/DrpAction"; -export type { DrpDataRightsResponse } from "./models/DrpDataRightsResponse"; -export type { DrpMeta } from "./models/DrpMeta"; -export type { DrpPrivacyRequestCreate } from "./models/DrpPrivacyRequestCreate"; -export { DrpRegime } from "./models/DrpRegime"; -export type { DrpRevokeRequest } from "./models/DrpRevokeRequest"; -export type { DryRunDatasetResponse } from "./models/DryRunDatasetResponse"; -export type { DuplicateDetectionApplicationConfig } from "./models/DuplicateDetectionApplicationConfig"; -export type { DynamicErasureEmailDocsSchema } from "./models/DynamicErasureEmailDocsSchema"; -export type { DynamoDBDocsSchema } from "./models/DynamoDBDocsSchema"; -export type { DynamoDBMonitorParams } from "./models/DynamoDBMonitorParams"; -export { EdgeDirection } from "./models/EdgeDirection"; -export type { EditableMonitorConfig } from "./models/EditableMonitorConfig"; -export type { EmailDocsSchema } from "./models/EmailDocsSchema"; -export type { EmbeddedLineItem } from "./models/EmbeddedLineItem"; -export type { EmbeddedPrivacyNoticeResponse } from "./models/EmbeddedPrivacyNoticeResponse"; -export type { EmbeddedPurpose } from "./models/EmbeddedPurpose"; -export type { EmbeddedVendor } from "./models/EmbeddedVendor"; -export type { Endpoint } from "./models/Endpoint"; -export { EnforcementLevel } from "./models/EnforcementLevel"; -export { ErrorNotificationMode } from "./models/ErrorNotificationMode"; -export type { Evaluation } from "./models/Evaluation"; -export type { ExecutionAndAuditLogResponse } from "./models/ExecutionAndAuditLogResponse"; -export type { ExecutionApplicationConfig } from "./models/ExecutionApplicationConfig"; -export type { ExecutionLogDetailResponse } from "./models/ExecutionLogDetailResponse"; -export type { ExecutionLogResponse } from "./models/ExecutionLogResponse"; -export { ExecutionLogStatus } from "./models/ExecutionLogStatus"; -export type { ExperienceConfigCreate } from "./models/ExperienceConfigCreate"; -export type { ExperienceConfigDisabledResponse } from "./models/ExperienceConfigDisabledResponse"; -export type { ExperienceConfigDisabledUpdate } from "./models/ExperienceConfigDisabledUpdate"; -export type { ExperienceConfigListViewResponse } from "./models/ExperienceConfigListViewResponse"; -export type { ExperienceConfigResponse } from "./models/ExperienceConfigResponse"; -export type { ExperienceConfigResponseNoNotices } from "./models/ExperienceConfigResponseNoNotices"; -export type { ExperienceConfigUpdate } from "./models/ExperienceConfigUpdate"; -export type { ExperienceMeta } from "./models/ExperienceMeta"; -export type { ExperienceMinimalMeta } from "./models/ExperienceMinimalMeta"; -export type { ExperienceTranslation } from "./models/ExperienceTranslation"; -export type { ExperienceTranslationCreate } from "./models/ExperienceTranslationCreate"; -export type { ExperienceTranslationResponse } from "./models/ExperienceTranslationResponse"; -export type { ExtendedIdentityTypes } from "./models/ExtendedIdentityTypes"; -export type { ExternalDatasetReference } from "./models/ExternalDatasetReference"; -export type { ExternalLoginOTPRequest } from "./models/ExternalLoginOTPRequest"; -export type { ExternalLoginOTPResponse } from "./models/ExternalLoginOTPResponse"; -export type { ExternalLoginVerifyRequest } from "./models/ExternalLoginVerifyRequest"; -export type { ExternalUserCreateRequest } from "./models/ExternalUserCreateRequest"; -export type { fides__api__schemas__application_config__ConsentConfig } from "./models/fides__api__schemas__application_config__ConsentConfig"; -export type { fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds } from "./models/fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds"; -export type { fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds } from "./models/fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds"; -export type { fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds } from "./models/fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds"; -export type { fides__api__schemas__policy__Policy } from "./models/fides__api__schemas__policy__Policy"; -export type { fides__api__schemas__privacy_center_config__ConsentConfig } from "./models/fides__api__schemas__privacy_center_config__ConsentConfig"; -export type { fides__api__schemas__privacy_center_config__CustomPrivacyRequestField } from "./models/fides__api__schemas__privacy_center_config__CustomPrivacyRequestField"; -export type { fides__api__schemas__redis_cache__CustomPrivacyRequestField } from "./models/fides__api__schemas__redis_cache__CustomPrivacyRequestField"; -export type { fides__api__schemas__application_config__PrivacyCenterConfig } from "./models/fides__api__schemas__application_config__PrivacyCenterConfig"; -export type { fides__connectors__models__KeyfileCreds } from "./models/fides__connectors__models__KeyfileCreds"; -export type { FidesCloudStatus } from "./models/FidesCloudStatus"; -export type { FidesDatasetReference } from "./models/FidesDatasetReference"; -export type { FidesDocsSchema } from "./models/FidesDocsSchema"; -export type { fideslang__models__Policy } from "./models/fideslang__models__Policy"; -export type { FidesMeta } from "./models/FidesMeta"; -export type { fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRestrictionResponse } from "./models/fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRestrictionResponse"; -export type { fidesplus__schemas__tcf_experience__TCFPublisherRestrictionResponse } from "./models/fidesplus__schemas__tcf_experience__TCFPublisherRestrictionResponse"; -export type { Field } from "./models/Field"; -export type { FieldMaskingStrategyOverride } from "./models/FieldMaskingStrategyOverride"; -export type { FieldsAffectedResponse } from "./models/FieldsAffectedResponse"; -export type { FilteredPrivacyRequestResults } from "./models/FilteredPrivacyRequestResults"; -export { GCSAuthMethod } from "./models/GCSAuthMethod"; -export type { Generate } from "./models/Generate"; -export type { GenerateRequestPayload } from "./models/GenerateRequestPayload"; -export type { GenerateResponse } from "./models/GenerateResponse"; -export { GenerateTypes } from "./models/GenerateTypes"; -export type { GetRegistrationStatusResponse } from "./models/GetRegistrationStatusResponse"; -export { GoogleCloudSQLIPType } from "./models/GoogleCloudSQLIPType"; -export type { GoogleCloudSQLMySQLDocsSchema } from "./models/GoogleCloudSQLMySQLDocsSchema"; -export type { GoogleCloudSQLPostgresDocsSchema } from "./models/GoogleCloudSQLPostgresDocsSchema"; -export type { GPPApplicationConfig } from "./models/GPPApplicationConfig"; -export type { GPPFieldMapping } from "./models/GPPFieldMapping"; -export type { GPPFieldMappingCreate } from "./models/GPPFieldMappingCreate"; -export type { GPPMechanismMapping } from "./models/GPPMechanismMapping"; -export type { GPPMobileData } from "./models/GPPMobileData"; -export { GPPUSApproach } from "./models/GPPUSApproach"; -export { GroupOperator } from "./models/GroupOperator"; -export type { Header } from "./models/Header"; -export type { HealthCheck } from "./models/HealthCheck"; -export { HTTPMethod } from "./models/HTTPMethod"; -export type { HTTPValidationError } from "./models/HTTPValidationError"; -export type { Identity } from "./models/Identity"; -export type { IdentityInputs } from "./models/IdentityInputs"; -export type { IdentityValue } from "./models/IdentityValue"; -export type { IdentityTypes } from "./models/IdentityTypes"; -export type { IdentityVerificationConfigResponse } from "./models/IdentityVerificationConfigResponse"; -export { IncludeExcludeEnum } from "./models/IncludeExcludeEnum"; -export { IntegrationFeature } from "./models/IntegrationFeature"; -export type { Language } from "./models/Language"; -export { Layer1ButtonOption } from "./models/Layer1ButtonOption"; -export { LegalBasisForProcessingEnum } from "./models/LegalBasisForProcessingEnum"; -export { LegalBasisForProfilingEnum } from "./models/LegalBasisForProfilingEnum"; -export type { LimitedPrivacyNoticeResponseSchema } from "./models/LimitedPrivacyNoticeResponseSchema"; -export type { Location } from "./models/Location"; -export type { LocationGroup } from "./models/LocationGroup"; -export type { LocationIdentityField } from "./models/LocationIdentityField"; -export type { LocationRegulationBase } from "./models/LocationRegulationBase"; -export type { LocationRegulationResponse } from "./models/LocationRegulationResponse"; -export type { LocationRegulationSelections } from "./models/LocationRegulationSelections"; -export type { LogEntry } from "./models/LogEntry"; -export type { ManualAction } from "./models/ManualAction"; -export type { ManualFieldCreate } from "./models/ManualFieldCreate"; -export type { ManualFieldListItem } from "./models/ManualFieldListItem"; -export type { ManualFieldPrivacyRequest } from "./models/ManualFieldPrivacyRequest"; -export { ManualFieldRequestType } from "./models/ManualFieldRequestType"; -export type { ManualFieldResponse } from "./models/ManualFieldResponse"; -export type { ManualFieldSearchFilterOptions } from "./models/ManualFieldSearchFilterOptions"; -export type { ManualFieldSearchResponse } from "./models/ManualFieldSearchResponse"; -export { ManualFieldStatus } from "./models/ManualFieldStatus"; -export type { ManualFieldSystem } from "./models/ManualFieldSystem"; -export type { ManualFieldUpdate } from "./models/ManualFieldUpdate"; -export type { ManualFieldUser } from "./models/ManualFieldUser"; -export type { ManualTaskConfigCreate } from "./models/ManualTaskConfigCreate"; -export type { ManualTaskConfigResponse } from "./models/ManualTaskConfigResponse"; -export type { ManualTaskConfigUpdate } from "./models/ManualTaskConfigUpdate"; -export { ManualTaskConfigurationType } from "./models/ManualTaskConfigurationType"; -export type { ManualTaskFieldBase } from "./models/ManualTaskFieldBase"; -export type { ManualTaskFieldMetadata } from "./models/ManualTaskFieldMetadata"; -export { ManualTaskFieldType } from "./models/ManualTaskFieldType"; -export { ManualTaskParentEntityType } from "./models/ManualTaskParentEntityType"; -export type { ManualTaskResponse } from "./models/ManualTaskResponse"; -export type { ManualWebhookData } from "./models/ManualWebhookData"; -export type { ManualWebhookDocsSchema } from "./models/ManualWebhookDocsSchema"; -export type { ManualWebhookField } from "./models/ManualWebhookField"; -export type { MappedPurpose } from "./models/MappedPurpose"; -export type { MariaDBDocsSchema } from "./models/MariaDBDocsSchema"; -export type { MaskingAPIRequest } from "./models/MaskingAPIRequest"; -export type { MaskingAPIResponse } from "./models/MaskingAPIResponse"; -export { MaskingStrategies } from "./models/MaskingStrategies"; -export type { MaskingStrategyConfigurationDescription } from "./models/MaskingStrategyConfigurationDescription"; -export type { MaskingStrategyDescription } from "./models/MaskingStrategyDescription"; -export type { MaskingStrategyOverride } from "./models/MaskingStrategyOverride"; -export { MatchesEnum } from "./models/MatchesEnum"; -export { MessagingActionType } from "./models/MessagingActionType"; -export type { MessagingConfigRequest } from "./models/MessagingConfigRequest"; -export type { MessagingConfigRequestBase } from "./models/MessagingConfigRequestBase"; -export type { MessagingConfigResponse } from "./models/MessagingConfigResponse"; -export { MessagingConfigStatus } from "./models/MessagingConfigStatus"; -export type { MessagingConfigStatusMessage } from "./models/MessagingConfigStatusMessage"; -export { MessagingConnectionTestStatus } from "./models/MessagingConnectionTestStatus"; -export { MessagingMethod } from "./models/MessagingMethod"; -export type { MessagingSecretsMailgunDocs } from "./models/MessagingSecretsMailgunDocs"; -export type { MessagingSecretsTwilioEmailDocs } from "./models/MessagingSecretsTwilioEmailDocs"; -export type { MessagingSecretsTwilioSMSDocs } from "./models/MessagingSecretsTwilioSMSDocs"; -export type { MessagingServiceDetailsAWS_SES } from "./models/MessagingServiceDetailsAWS_SES"; -export type { MessagingServiceDetailsMailchimpTransactional } from "./models/MessagingServiceDetailsMailchimpTransactional"; -export type { MessagingServiceDetailsMailgun } from "./models/MessagingServiceDetailsMailgun"; -export type { MessagingServiceDetailsTwilioEmail } from "./models/MessagingServiceDetailsTwilioEmail"; -export type { MessagingServiceSecretsAWS_SESDocs } from "./models/MessagingServiceSecretsAWS_SESDocs"; -export type { MessagingServiceSecretsMailchimpTransactionalDocs } from "./models/MessagingServiceSecretsMailchimpTransactionalDocs"; -export { MessagingServiceType } from "./models/MessagingServiceType"; -export type { MessagingTemplateDefault } from "./models/MessagingTemplateDefault"; -export type { MessagingTemplateWithPropertiesBodyParams } from "./models/MessagingTemplateWithPropertiesBodyParams"; -export type { MessagingTemplateWithPropertiesDetail } from "./models/MessagingTemplateWithPropertiesDetail"; -export type { MessagingTemplateWithPropertiesPatchBodyParams } from "./models/MessagingTemplateWithPropertiesPatchBodyParams"; -export type { MessagingTemplateWithPropertiesSummary } from "./models/MessagingTemplateWithPropertiesSummary"; -export type { MinimalClassifyParams } from "./models/MinimalClassifyParams"; -export type { MinimalMessagingTemplate } from "./models/MinimalMessagingTemplate"; -export type { MinimalPrivacyExperienceConfig } from "./models/MinimalPrivacyExperienceConfig"; -export type { MinimalPrivacyNotice } from "./models/MinimalPrivacyNotice"; -export type { MinimalProperty } from "./models/MinimalProperty"; -export type { MinimalTCFBannerTranslation } from "./models/MinimalTCFBannerTranslation"; -export type { MinimalTCFExperienceConfig } from "./models/MinimalTCFExperienceConfig"; -export type { MongoDBDocsSchema } from "./models/MongoDBDocsSchema"; -export type { MonitorClassifyParams } from "./models/MonitorClassifyParams"; -export type { MonitorConfig } from "./models/MonitorConfig"; -export type { MonitorConfigStagedResourcesAggregateRecord } from "./models/MonitorConfigStagedResourcesAggregateRecord"; -export type { MonitorExecution } from "./models/MonitorExecution"; -export type { MonitorExecutionRequestResponse } from "./models/MonitorExecutionRequestResponse"; -export { MonitorExecutionStatus } from "./models/MonitorExecutionStatus"; -export { MonitorFrequency } from "./models/MonitorFrequency"; -export type { MonitorStatusResponse } from "./models/MonitorStatusResponse"; -export type { MonitorTaskDetailResponse } from "./models/MonitorTaskDetailResponse"; -export type { MonitorTaskResponse } from "./models/MonitorTaskResponse"; -export type { MonitorTaskInProgressResponse } from "./models/MonitorTaskInProgressResponse"; -export { MonitorTaskType } from "./models/MonitorTaskType"; -export type { MSSQLDocsSchema } from "./models/MSSQLDocsSchema"; -export type { MySQLDocsSchema } from "./models/MySQLDocsSchema"; -export { MySQLSSLMode } from "./models/MySQLSSLMode"; -export type { NoticeTranslation } from "./models/NoticeTranslation"; -export type { NoticeTranslationCreate } from "./models/NoticeTranslationCreate"; -export type { NoticeTranslationResponse } from "./models/NoticeTranslationResponse"; -export type { NotificationApplicationConfig } from "./models/NotificationApplicationConfig"; -export type { OktaConfig } from "./models/OktaConfig"; -export type { OktaDocsSchema } from "./models/OktaDocsSchema"; -export type { OpenIDProvider } from "./models/OpenIDProvider"; -export type { OpenIDProviderCreate } from "./models/OpenIDProviderCreate"; -export type { OpenIDProviderSimple } from "./models/OpenIDProviderSimple"; -export { Operator } from "./models/Operator"; -export type { Organization } from "./models/Organization"; -export type { OrganizationMetadata } from "./models/OrganizationMetadata"; -export type { OverrideMode } from "./models/OverrideMode"; -export type { Page_Asset_ } from "./models/Page_Asset_"; -export type { Page_AssessmentResponse_ } from "./models/Page_AssessmentResponse_"; -export type { Page_AttachmentResponse_ } from "./models/Page_AttachmentResponse_"; -export type { Page_BasicSystemResponseExtended_ } from "./models/Page_BasicSystemResponseExtended_"; -export type { Page_ClassifyInstanceResponseValues_ } from "./models/Page_ClassifyInstanceResponseValues_"; -export type { Page_CommentResponse_ } from "./models/Page_CommentResponse_"; -export type { Page_ConnectionConfigurationResponse_ } from "./models/Page_ConnectionConfigurationResponse_"; -export type { Page_ConnectionSystemTypeMap_ } from "./models/Page_ConnectionSystemTypeMap_"; -export type { Page_ConsentBreakdown_ } from "./models/Page_ConsentBreakdown_"; -export type { Page_ConsentReport_ } from "./models/Page_ConsentReport_"; -export type { Page_ConsentReportingSchema_ } from "./models/Page_ConsentReportingSchema_"; -export type { Page_CustomReportResponse_ } from "./models/Page_CustomReportResponse_"; -export type { Page_CustomReportResponseMinimal_ } from "./models/Page_CustomReportResponseMinimal_"; -export type { Page_DatamapReport_ } from "./models/Page_DatamapReport_"; -export type { Page_Dataset_ } from "./models/Page_Dataset_"; -export type { Page_DatasetConfigSchema_ } from "./models/Page_DatasetConfigSchema_"; -export type { Page_DatasetResponse_ } from "./models/Page_DatasetResponse_"; -export type { Page_DatastoreStagedResourceTreeAPIResponse_ } from "./models/Page_DatastoreStagedResourceTreeAPIResponse_"; -export type { Page_ExecutionLogDetailResponse_ } from "./models/Page_ExecutionLogDetailResponse_"; -export type { Page_ExperienceConfigListViewResponse_ } from "./models/Page_ExperienceConfigListViewResponse_"; -export type { Page_Language_ } from "./models/Page_Language_"; -export type { Page_LimitedPrivacyNoticeResponseSchema_ } from "./models/Page_LimitedPrivacyNoticeResponseSchema_"; -export type { Page_ManualTaskConfigResponse_ } from "./models/Page_ManualTaskConfigResponse_"; -export type { Page_ManualTaskResponse_ } from "./models/Page_ManualTaskResponse_"; -export type { Page_MessagingConfigResponse_ } from "./models/Page_MessagingConfigResponse_"; -export type { Page_MessagingTemplateWithPropertiesSummary_ } from "./models/Page_MessagingTemplateWithPropertiesSummary_"; -export type { Page_MonitorConfigStagedResourcesAggregateRecord_ } from "./models/Page_MonitorConfigStagedResourcesAggregateRecord_"; -export type { Page_MonitorExecution_ } from "./models/Page_MonitorExecution_"; -export type { Page_MonitorStatusResponse_ } from "./models/Page_MonitorStatusResponse_"; -export type { Page_MonitorTaskResponse_ } from "./models/Page_MonitorTaskResponse_"; -export type { Page_PolicyResponse_ } from "./models/Page_PolicyResponse_"; -export type { Page_PolicyWebhookResponse_ } from "./models/Page_PolicyWebhookResponse_"; -export type { Page_PreApprovalWebhookResponse_ } from "./models/Page_PreApprovalWebhookResponse_"; -export type { Page_PrivacyExperienceMetaResponse_ } from "./models/Page_PrivacyExperienceMetaResponse_"; -export type { Page_Property_ } from "./models/Page_Property_"; -export type { Page_RuleResponseWithTargets_ } from "./models/Page_RuleResponseWithTargets_"; -export type { Page_RuleTarget_ } from "./models/Page_RuleTarget_"; -export type { Page_SharedMonitorConfig_ } from "./models/Page_SharedMonitorConfig_"; -export type { Page_StagedResourceAPIResponse_ } from "./models/Page_StagedResourceAPIResponse_"; -export type { Page_StorageDestinationResponse_ } from "./models/Page_StorageDestinationResponse_"; -export type { Page_str_ } from "./models/Page_str_"; -export type { Page_SystemHistoryResponse_ } from "./models/Page_SystemHistoryResponse_"; -export type { Page_SystemStagedResourcesAggregateRecord_ } from "./models/Page_SystemStagedResourcesAggregateRecord_"; -export type { Page_SystemSummary_ } from "./models/Page_SystemSummary_"; -export type { Page_SystemWithMonitorKeys_ } from "./models/Page_SystemWithMonitorKeys_"; -export type { Page_TCFConfigurationResponse_ } from "./models/Page_TCFConfigurationResponse_"; -export type { Page_TCFPublisherRestrictionResponse_ } from "./models/Page_TCFPublisherRestrictionResponse_"; -export type { Page_TemplateResponse_ } from "./models/Page_TemplateResponse_"; -export type { Page_Union_PrivacyExperienceResponse__TCFBannerExperienceMinimalResponse__ } from "./models/Page_Union_PrivacyExperienceResponse__TCFBannerExperienceMinimalResponse__"; -export type { Page_Union_PrivacyRequestVerboseResponse__PrivacyRequestResponse__ } from "./models/Page_Union_PrivacyRequestVerboseResponse__PrivacyRequestResponse__"; -export type { Page_UserResponse_ } from "./models/Page_UserResponse_"; -export type { ParamValue } from "./models/ParamValue"; -export type { PartialPrivacyCenterConfig } from "./models/PartialPrivacyCenterConfig"; -export type { PartialPrivacyRequestOption } from "./models/PartialPrivacyRequestOption"; -export { PeriodicIntegrationFrequency } from "./models/PeriodicIntegrationFrequency"; -export type { PlusApplicationConfig } from "./models/PlusApplicationConfig"; -export type { PlusConsentSettingsApplicationConfig } from "./models/PlusConsentSettingsApplicationConfig"; -export type { PolicyConditionRequest } from "./models/PolicyConditionRequest"; -export type { PolicyConditionResponse } from "./models/PolicyConditionResponse"; -export type { PolicyMaskingSpec } from "./models/PolicyMaskingSpec"; -export type { PolicyMaskingSpecResponse } from "./models/PolicyMaskingSpecResponse"; -export type { PolicyResponse } from "./models/PolicyResponse"; -export type { PolicyRule } from "./models/PolicyRule"; -export type { PolicyUnavailableMessages } from "./models/PolicyUnavailableMessages"; -export type { PolicyWebhookCreate } from "./models/PolicyWebhookCreate"; -export type { PolicyWebhookDeleteResponse } from "./models/PolicyWebhookDeleteResponse"; -export type { PolicyWebhookResponse } from "./models/PolicyWebhookResponse"; -export type { PolicyWebhookUpdate } from "./models/PolicyWebhookUpdate"; -export type { PolicyWebhookUpdateResponse } from "./models/PolicyWebhookUpdateResponse"; -export type { PostgreSQLDocsSchema } from "./models/PostgreSQLDocsSchema"; -export type { PreApprovalWebhookCreate } from "./models/PreApprovalWebhookCreate"; -export type { PreApprovalWebhookResponse } from "./models/PreApprovalWebhookResponse"; -export type { PreApprovalWebhookUpdate } from "./models/PreApprovalWebhookUpdate"; -export type { PreferencesSaved } from "./models/PreferencesSaved"; -export type { PreferencesSavedExtended } from "./models/PreferencesSavedExtended"; -export type { PreferenceWithNoticeInformation } from "./models/PreferenceWithNoticeInformation"; -export type { PreVerifiedPrivacyPreferencesRequest } from "./models/PreVerifiedPrivacyPreferencesRequest"; -export type { PrivacyCenterConfig } from "./models/PrivacyCenterConfig"; -export type { PrivacyDeclaration } from "./models/PrivacyDeclaration"; -export type { PrivacyDeclarationResponse } from "./models/PrivacyDeclarationResponse"; -export type { PrivacyExperienceGPPSettings } from "./models/PrivacyExperienceGPPSettings"; -export type { PrivacyExperienceMetaResponse } from "./models/PrivacyExperienceMetaResponse"; -export type { PrivacyExperienceResponse } from "./models/PrivacyExperienceResponse"; -export type { PrivacyNoticeCreation } from "./models/PrivacyNoticeCreation"; -export type { PrivacyNoticeDisabledResponse } from "./models/PrivacyNoticeDisabledResponse"; -export type { PrivacyNoticeDisabledUpdate } from "./models/PrivacyNoticeDisabledUpdate"; -export { PrivacyNoticeFramework } from "./models/PrivacyNoticeFramework"; -export { PrivacyNoticeRegion } from "./models/PrivacyNoticeRegion"; -export type { PrivacyNoticeResponse } from "./models/PrivacyNoticeResponse"; -export type { PrivacyNoticeResponseWithRegions } from "./models/PrivacyNoticeResponseWithRegions"; -export type { PrivacyNoticeUpdate } from "./models/PrivacyNoticeUpdate"; -export type { PrivacyPreferencesRequest } from "./models/PrivacyPreferencesRequest"; -export type { PrivacyPreferenceStats } from "./models/PrivacyPreferenceStats"; -export type { PrivacyRequestAccessResults } from "./models/PrivacyRequestAccessResults"; -export type { PrivacyRequestCreate } from "./models/PrivacyRequestCreate"; -export type { PrivacyRequestDiagnosticsExportResponse } from "./models/PrivacyRequestDiagnosticsExportResponse"; -export { PrivacyRequestDRPStatus } from "./models/PrivacyRequestDRPStatus"; -export type { PrivacyRequestDRPStatusResponse } from "./models/PrivacyRequestDRPStatusResponse"; -export type { PrivacyRequestFilter } from "./models/PrivacyRequestFilter"; -export type { PrivacyRequestNotificationInfo } from "./models/PrivacyRequestNotificationInfo"; -export type { PrivacyRequestOption } from "./models/PrivacyRequestOption"; -export type { PrivacyRequestResponse } from "./models/PrivacyRequestResponse"; -export type { PrivacyRequestResumeFormat } from "./models/PrivacyRequestResumeFormat"; -export type { PrivacyRequestUser } from "./models/PrivacyRequestUser"; -export { PrivacyRequestSource } from "./models/PrivacyRequestSource"; -export { PrivacyRequestStatus } from "./models/PrivacyRequestStatus"; -export type { PrivacyRequestTaskSchema } from "./models/PrivacyRequestTaskSchema"; -export type { PrivacyRequestVerboseResponse } from "./models/PrivacyRequestVerboseResponse"; -export type { PrivacyRule } from "./models/PrivacyRule"; -export type { PromoteResourcesResponse } from "./models/PromoteResourcesResponse"; -export type { PropagationPolicyKey } from "./models/PropagationPolicyKey"; -export type { Property } from "./models/Property"; -export type { PropertyCreate } from "./models/PropertyCreate"; -export { PropertyType } from "./models/PropertyType"; -export { ProviderEnum } from "./models/ProviderEnum"; -export type { PublicPropertyResponse } from "./models/PublicPropertyResponse"; -export type { PurposesResponse } from "./models/PurposesResponse"; -export type { QueryParam } from "./models/QueryParam"; -export type { QueueInfo } from "./models/QueueInfo"; -export type { RangeEntry } from "./models/RangeEntry"; -export type { RateLimit } from "./models/RateLimit"; -export type { RateLimitConfig } from "./models/RateLimitConfig"; -export { RateLimitPeriod } from "./models/RateLimitPeriod"; -export type { RDSMySQLDocsSchema } from "./models/RDSMySQLDocsSchema"; -export type { RDSPostgresDocsSchema } from "./models/RDSPostgresDocsSchema"; -export type { ReadSaaSRequest } from "./models/ReadSaaSRequest"; -export type { RecalculateConsentResponse } from "./models/RecalculateConsentResponse"; -export type { RecordConsentServedRequest } from "./models/RecordConsentServedRequest"; -export type { RecordsServedResponse } from "./models/RecordsServedResponse"; -export type { RedshiftDocsSchema } from "./models/RedshiftDocsSchema"; -export type { Registration } from "./models/Registration"; -export { RejectAllMechanism } from "./models/RejectAllMechanism"; -export { ReportExportFormat } from "./models/ReportExportFormat"; -export { ReportType } from "./models/ReportType"; -export { RequestOrigin } from "./models/RequestOrigin"; -export type { RequestTaskCallbackRequest } from "./models/RequestTaskCallbackRequest"; -export type { ResourceFilter } from "./models/ResourceFilter"; -export { ResourceTypes } from "./models/ResourceTypes"; -export { ResponseFormat } from "./models/ResponseFormat"; -export type { ResponseWithMessage } from "./models/ResponseWithMessage"; -export type { RevertAnswerRequest } from "./models/RevertAnswerRequest"; -export type { ReviewPrivacyRequestIds } from "./models/ReviewPrivacyRequestIds"; -export { RoleRegistryEnum } from "./models/RoleRegistryEnum"; -export type { RuleCreate } from "./models/RuleCreate"; -export type { RuleResponse } from "./models/RuleResponse"; -export type { RuleResponseWithTargets } from "./models/RuleResponseWithTargets"; -export type { RuleTarget } from "./models/RuleTarget"; -export type { S3DocsSchema } from "./models/S3DocsSchema"; -export type { S3MonitorParams } from "./models/S3MonitorParams"; -export type { SaaSConfig } from "./models/SaaSConfig"; -export type { SaaSConfigBase } from "./models/SaaSConfigBase"; -export type { SaaSConfigValidationDetails } from "./models/SaaSConfigValidationDetails"; -export type { SaasConnectionTemplateResponse } from "./models/SaasConnectionTemplateResponse"; -export type { SaasConnectionTemplateValues } from "./models/SaasConnectionTemplateValues"; -export type { SaasConnectionTemplateValuesExtended } from "./models/SaasConnectionTemplateValuesExtended"; -export type { SaaSDisplayInfo } from "./models/SaaSDisplayInfo"; -export type { SaaSRequest } from "./models/SaaSRequest"; -export type { SaaSRequestMap } from "./models/SaaSRequestMap"; -export type { SaaSSchema } from "./models/SaaSSchema"; -export type { Schema } from "./models/Schema"; -export { ScopeRegistryEnum } from "./models/ScopeRegistryEnum"; -export type { ScyllaDocsSchema } from "./models/ScyllaDocsSchema"; -export type { SecurityApplicationConfig } from "./models/SecurityApplicationConfig"; -export type { Selection } from "./models/Selection"; -export type { SendMessageRequest } from "./models/SendMessageRequest"; -export type { SendMessageResponse } from "./models/SendMessageResponse"; -export { ServiceHealth } from "./models/ServiceHealth"; -export { ServingComponent } from "./models/ServingComponent"; -export type { SharedMonitorConfig } from "./models/SharedMonitorConfig"; -export type { SingleFieldSubmissionResponse } from "./models/SingleFieldSubmissionResponse"; -export type { SlackChannel } from "./models/SlackChannel"; -export type { SnowflakeDocsSchema } from "./models/SnowflakeDocsSchema"; -export type { SovrnDocsSchema } from "./models/SovrnDocsSchema"; -export { SpecialCategoryLegalBasisEnum } from "./models/SpecialCategoryLegalBasisEnum"; -export { SqlDryRunMode } from "./models/SqlDryRunMode"; -export type { StagedResource } from "./models/StagedResource"; -export type { StagedResourceAPIResponse } from "./models/StagedResourceAPIResponse"; -export { StagedResourceTypeValue } from "./models/StagedResourceTypeValue"; -export type { StagedResourceUpdateRequest } from "./models/StagedResourceUpdateRequest"; -export { StatusEnum } from "./models/StatusEnum"; -export { StatusType } from "./models/StatusType"; -export type { StorageApplicationConfig } from "./models/StorageApplicationConfig"; -export { StorageConfigStatus } from "./models/StorageConfigStatus"; -export type { StorageConfigStatusMessage } from "./models/StorageConfigStatusMessage"; -export type { StorageDestination } from "./models/StorageDestination"; -export type { StorageDestinationBase } from "./models/StorageDestinationBase"; -export type { StorageDestinationResponse } from "./models/StorageDestinationResponse"; -export { StorageDetails } from "./models/StorageDetails"; -export type { StorageDetailsGCS } from "./models/StorageDetailsGCS"; -export type { StorageDetailsLocal } from "./models/StorageDetailsLocal"; -export type { StorageDetailsS3 } from "./models/StorageDetailsS3"; -export type { StorageSecretsGCSDocs } from "./models/StorageSecretsGCSDocs"; -export type { StorageSecretsS3Docs } from "./models/StorageSecretsS3Docs"; -export { StorageType } from "./models/StorageType"; -export { StorageTypeApiAccepted } from "./models/StorageTypeApiAccepted"; -export type { Strategy } from "./models/Strategy"; -export { SupportedLanguage } from "./models/SupportedLanguage"; -export type { System } from "./models/System"; -export type { SystemGroup } from "./models/SystemGroup"; -export type { SystemGroupCreate } from "./models/SystemGroupCreate"; -export type { SystemGroupUpdate } from "./models/SystemGroupUpdate"; -export type { SystemHistoryResponse } from "./models/SystemHistoryResponse"; -export type { SystemMetadata } from "./models/SystemMetadata"; -export type { SystemPurposeSummary } from "./models/SystemPurposeSummary"; -export type { SystemResponse } from "./models/SystemResponse"; -export type { SystemScanHistory } from "./models/SystemScanHistory"; -export type { SystemScannerStatus } from "./models/SystemScannerStatus"; -export type { SystemScanResponse } from "./models/SystemScanResponse"; -export type { SystemSchemaExtended } from "./models/SystemSchemaExtended"; -export type { SystemsDiff } from "./models/SystemsDiff"; -export type { SystemStagedResourcesAggregateRecord } from "./models/SystemStagedResourcesAggregateRecord"; -export type { SystemSummary } from "./models/SystemSummary"; -export { SystemType } from "./models/SystemType"; -export type { SystemWithMonitorKeys } from "./models/SystemWithMonitorKeys"; -export type { Table } from "./models/Table"; -export type { TaskDetails } from "./models/TaskDetails"; -export { TaskRunType } from "./models/TaskRunType"; -export type { TCDecode } from "./models/TCDecode"; -export type { TCFBannerExperienceMinimalResponse } from "./models/TCFBannerExperienceMinimalResponse"; -export type { TCFConfigurationDetail } from "./models/TCFConfigurationDetail"; -export type { TCFConfigurationRequest } from "./models/TCFConfigurationRequest"; -export type { TCFConfigurationResponse } from "./models/TCFConfigurationResponse"; -export type { TCFFeatureRecord } from "./models/TCFFeatureRecord"; -export type { TCFFeatureSave } from "./models/TCFFeatureSave"; -export { TCFLegalBasisEnum } from "./models/TCFLegalBasisEnum"; -export type { TCFPreferences } from "./models/TCFPreferences"; -export type { TCFPublisherRestrictionRequest } from "./models/TCFPublisherRestrictionRequest"; -export type { TCFPublisherRestrictionUpdateRequest } from "./models/TCFPublisherRestrictionUpdateRequest"; -export type { TCFPurposeConsentRecord } from "./models/TCFPurposeConsentRecord"; -export type { TCFPurposeLegitimateInterestsRecord } from "./models/TCFPurposeLegitimateInterestsRecord"; -export type { TCFPurposeOverrideSchema } from "./models/TCFPurposeOverrideSchema"; -export type { TCFPurposeSave } from "./models/TCFPurposeSave"; -export { TCFRestrictionType } from "./models/TCFRestrictionType"; -export type { TCFSpecialFeatureRecord } from "./models/TCFSpecialFeatureRecord"; -export type { TCFSpecialFeatureSave } from "./models/TCFSpecialFeatureSave"; -export type { TCFSpecialPurposeRecord } from "./models/TCFSpecialPurposeRecord"; -export type { TCFSpecialPurposeSave } from "./models/TCFSpecialPurposeSave"; -export type { TCFStatus } from "./models/TCFStatus"; -export type { TCFVendorConsentRecord } from "./models/TCFVendorConsentRecord"; -export type { TCFVendorLegitimateInterestsRecord } from "./models/TCFVendorLegitimateInterestsRecord"; -export type { TCFVendorRelationships } from "./models/TCFVendorRelationships"; -export { TCFVendorRestriction } from "./models/TCFVendorRestriction"; -export type { TCFVendorSave } from "./models/TCFVendorSave"; -export type { TCMobileData } from "./models/TCMobileData"; -export type { TemplateResponse } from "./models/TemplateResponse"; -export type { TestMessagingStatusMessage } from "./models/TestMessagingStatusMessage"; -export type { TestMonitorParams } from "./models/TestMonitorParams"; -export type { TestPrivacyRequest } from "./models/TestPrivacyRequest"; -export { TestStatus } from "./models/TestStatus"; -export type { TestStatusMessage } from "./models/TestStatusMessage"; -export type { TestWebsiteMonitorParams } from "./models/TestWebsiteMonitorParams"; -export type { TimeBasedPartitioning } from "./models/TimeBasedPartitioning"; -export type { TimescaleDocsSchema } from "./models/TimescaleDocsSchema"; -export { TreeResourceChangeIndicator } from "./models/TreeResourceChangeIndicator"; -export type { UnlabeledIdentities } from "./models/UnlabeledIdentities"; -export type { UnverifiedIdentity } from "./models/UnverifiedIdentity"; -export type { UnverifiedPrivacyPreferencesRequest } from "./models/UnverifiedPrivacyPreferencesRequest"; -export type { UpdateAnswerRequest } from "./models/UpdateAnswerRequest"; -export { UserConsentPreference } from "./models/UserConsentPreference"; -export type { UserCreateExtended } from "./models/UserCreateExtended"; -export type { UserCreateResponse } from "./models/UserCreateResponse"; -export type { UserEmailInviteStatus } from "./models/UserEmailInviteStatus"; -export type { UserForcePasswordReset } from "./models/UserForcePasswordReset"; -export type { UserLogin } from "./models/UserLogin"; -export type { UserLoginResponse } from "./models/UserLoginResponse"; -export type { UserPasswordReset } from "./models/UserPasswordReset"; -export type { UserPermissionsCreate } from "./models/UserPermissionsCreate"; -export type { UserPermissionsEdit } from "./models/UserPermissionsEdit"; -export type { UserPermissionsPlusResponse } from "./models/UserPermissionsPlusResponse"; -export type { UserResponse } from "./models/UserResponse"; -export type { UserResponseExtended } from "./models/UserResponseExtended"; -export type { UserUpdate } from "./models/UserUpdate"; -export type { ValidateDatasetResponse } from "./models/ValidateDatasetResponse"; -export type { ValidateRequest } from "./models/ValidateRequest"; -export type { ValidateResponse } from "./models/ValidateResponse"; -export type { ValidateSaaSConfigResponse } from "./models/ValidateSaaSConfigResponse"; -export type { ValidationError } from "./models/ValidationError"; -export { ValidationStatus } from "./models/ValidationStatus"; -export { ValidationTarget } from "./models/ValidationTarget"; -export { ValidTargets } from "./models/ValidTargets"; -export type { ValuesList } from "./models/ValuesList"; -export type { VendorIds } from "./models/VendorIds"; -export type { VerificationCode } from "./models/VerificationCode"; -export type { Violation } from "./models/Violation"; -export type { ViolationAttributes } from "./models/ViolationAttributes"; -export { WebhookDirection } from "./models/WebhookDirection"; -export type { WebhookOrder } from "./models/WebhookOrder"; -export type { WebMonitorUpdates } from "./models/WebMonitorUpdates"; -export type { WebsiteMonitorParams } from "./models/WebsiteMonitorParams"; -export type { WebsiteMonitorResourcesFilters } from "./models/WebsiteMonitorResourcesFilters"; -export type { WebsiteSchema } from "./models/WebsiteSchema"; -export type { WorkerHealthCheck } from "./models/WorkerHealthCheck"; -export type { WorkerInfo } from "./models/WorkerInfo"; -export type { WorkerStats } from "./models/WorkerStats"; +export type * from "./models/ClientOptions"; +export * from "./models/APIMonitorType"; +export * from "./models/AWSAuthMethod"; +export type * from "./models/AWSConfig"; +export * from "./models/AccessLevel"; +export type * from "./models/AccessManualWebhookResponse"; +export type * from "./models/AccessManualWebhooks"; +export type * from "./models/AccessToken"; +export type * from "./models/AccuracyMetrics"; +export * from "./models/ActionType"; +export type * from "./models/ActionValidationErrorResponse"; +export type * from "./models/AdminUIConfig"; +export type * from "./models/AdvancedSettings"; +export type * from "./models/AdvancedSettingsWithExtendedIdentityTypes"; +export type * from "./models/AesDecryptionRequest"; +export type * from "./models/AesDecryptionResponse"; +export type * from "./models/AesEncryptionRequest"; +export type * from "./models/AesEncryptionResponse"; +export * from "./models/AlertLevel"; +export type * from "./models/AllowList"; +export type * from "./models/AllowListUpdate"; +export type * from "./models/AllowedActionsResponse"; +export * from "./models/AllowedTypes"; +export * from "./models/ApplicationStatus"; +export type * from "./models/AssessmentResponse"; +export type * from "./models/AssessmentTaskResponse"; +export type * from "./models/AssessmentTaskSystemInfo"; +export type * from "./models/Asset"; +export type * from "./models/AssetCreate"; +export type * from "./models/AssetReportingFilters"; +export type * from "./models/AssetUpdate"; +export type * from "./models/AssignStewardRequest"; +export type * from "./models/AssignedUserSummary"; +export type * from "./models/AttachmentResponse"; +export * from "./models/AttachmentType"; +export * from "./models/AuditLogAction"; +export type * from "./models/AuthenticationMethods"; +export * from "./models/AuthenticationProtocol"; +export type * from "./models/BackfillRequest"; +export type * from "./models/BackfillStatusResponse"; +export type * from "./models/BaseStagedResourcesRequest"; +export type * from "./models/BasicMessagingTemplateRequest"; +export type * from "./models/BasicMessagingTemplateResponse"; +export type * from "./models/BasicSystemResponseExtended"; +export type * from "./models/BedrockConnectionTestRequest"; +export type * from "./models/BedrockConnectionTestResponse"; +export * from "./models/BenchmarkStatus"; +export type * from "./models/BigQueryConfig"; +export type * from "./models/BigQueryDocsSchema"; +export type * from "./models/BigQueryMonitorConfig"; +export type * from "./models/BigQueryMonitorParams"; +export type * from "./models/Body_Update_tagging_instructions_api_v1_data_category__fides_key__tagging_instructions_patch"; +export type * from "./models/Body_acquire_access_token_api_v1_oauth_token_post"; +export type * from "./models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment__comment_id__attachment_post"; +export type * from "./models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__comment__comment_id__attachment_post"; +export type * from "./models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment__comment_id__attachment_post"; +export type * from "./models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__attachment_post"; +export type * from "./models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__attachment_post"; +export type * from "./models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__attachment_post"; +export type * from "./models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment_post"; +export type * from "./models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__comment_post"; +export type * from "./models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment_post"; +export type * from "./models/Body_export_minimal_datamap_with_format_api_v1_plus_datamap_minimal__export_format__post"; +export type * from "./models/Body_skip_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__skip_post"; +export type * from "./models/Body_submit_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__complete_post"; +export type * from "./models/Body_upload_data_api_v1_storage__request_id__post"; +export type * from "./models/BulkConditionAssignment"; +export type * from "./models/BulkCustomFieldRequest"; +export type * from "./models/BulkDatasetPropertyResponse"; +export type * from "./models/BulkPostPrivacyRequests"; +export type * from "./models/BulkPropertyAssignment"; +export type * from "./models/BulkPropertyRemoval"; +export type * from "./models/BulkPutBasicMessagingTemplateResponse"; +export type * from "./models/BulkPutConnectionConfiguration"; +export type * from "./models/BulkPutDataset"; +export type * from "./models/BulkPutPolicyResponse"; +export type * from "./models/BulkPutRuleResponse"; +export type * from "./models/BulkPutRuleTargetResponse"; +export type * from "./models/BulkPutStorageConfigResponse"; +export type * from "./models/BulkReviewResponse"; +export type * from "./models/BulkSoftDeletePrivacyRequests"; +export type * from "./models/BulkUpdateFailed"; +export type * from "./models/BulkUserAssignment"; +export type * from "./models/CancelPrivacyRequestSelection"; +export type * from "./models/CategoryDistribution"; +export type * from "./models/ChatChannelsResponse"; +export type * from "./models/ChatConfigCreate"; +export type * from "./models/ChatConfigListResponse"; +export type * from "./models/ChatConfigResponse"; +export type * from "./models/ChatConfigSecrets"; +export type * from "./models/ChatConfigTestResponse"; +export type * from "./models/ChatConfigUpdate"; +export type * from "./models/CheckpointActionRequiredDetails"; +export type * from "./models/Classification"; +export type * from "./models/ClassificationBenchmarkRequest"; +export type * from "./models/ClassificationBenchmarkResponse"; +export type * from "./models/ClassificationBenchmarkSummary"; +export type * from "./models/ClassificationCoverage"; +export type * from "./models/ClassificationErrorSchema"; +export type * from "./models/ClassificationResponse"; +export * from "./models/ClassificationStatus"; +export type * from "./models/ClassificationWithConfidence"; +export type * from "./models/ClassifyCollection"; +export type * from "./models/ClassifyDataFlow"; +export type * from "./models/ClassifyDataset"; +export type * from "./models/ClassifyDatasetResponse"; +export type * from "./models/ClassifyEmpty"; +export type * from "./models/ClassifyField"; +export type * from "./models/ClassifyInput"; +export type * from "./models/ClassifyInstanceResponseValues"; +export type * from "./models/ClassifyLabel"; +export type * from "./models/ClassifyLlmParams"; +export * from "./models/ClassifyLlmPromptTemplateOptions"; +export type * from "./models/ClassifyOutput"; +export type * from "./models/ClassifyParams"; +export type * from "./models/ClassifyRequestPayload"; +export type * from "./models/ClassifyResult"; +export type * from "./models/ClassifyStatusUpdatePayload"; +export type * from "./models/ClassifySystem"; +export type * from "./models/ClientConfig"; +export type * from "./models/ClientCreatedResponse"; +export type * from "./models/CloudConfig"; +export * from "./models/ClusterHealth"; +export type * from "./models/CollectionAddressResponse"; +export type * from "./models/CollectionMeta"; +export type * from "./models/ColumnInfo"; +export type * from "./models/ColumnMapItem"; +export * from "./models/ColumnSort"; +export type * from "./models/CommentResponse"; +export * from "./models/CommentType"; +export * from "./models/ComponentType"; +export type * from "./models/ConditionGroup"; +export type * from "./models/ConditionLeaf"; +export type * from "./models/ConditionalTotalPage_ConsentReportingSchema_"; +export type * from "./models/ConditionalValue"; +export * from "./models/ConfidenceBucket"; +export type * from "./models/ConfidenceDistribution"; +export type * from "./models/ConfigConsentOption"; +export type * from "./models/ConfirmResourcesResponse"; +export * from "./models/ConnectionCategory"; +export type * from "./models/ConnectionConfigurationResponse"; +export type * from "./models/ConnectionConfigurationResponseWithSystemKey"; +export type * from "./models/ConnectionDatahubSyncDetail"; +export * from "./models/ConnectionDatahubSyncDetailStatus"; +export type * from "./models/ConnectionDatahubSyncPayload"; +export type * from "./models/ConnectionDatahubSyncResponse"; +export type * from "./models/ConnectionSystemTypeMap"; +export * from "./models/ConnectionTestStatus"; +export * from "./models/ConnectionType"; +export type * from "./models/ConnectorParam"; +export type * from "./models/ConnectorTemplateListResponse"; +export type * from "./models/Consent"; +export type * from "./models/ConsentAlertInfo"; +export type * from "./models/ConsentBreakdown"; +export type * from "./models/ConsentConfigButton"; +export type * from "./models/ConsentConfigPage"; +export type * from "./models/ConsentCreate"; +export type * from "./models/ConsentInfo"; +export * from "./models/ConsentMechanism"; +export type * from "./models/ConsentMetaCreate"; +export type * from "./models/ConsentMetaResponse"; +export * from "./models/ConsentMethod"; +export type * from "./models/ConsentOptionCreate"; +export type * from "./models/ConsentPreferenceCreate"; +export type * from "./models/ConsentPreferenceResponse"; +export type * from "./models/ConsentPreferences"; +export type * from "./models/ConsentPreferencesWithVerificationCode"; +export type * from "./models/ConsentReport"; +export type * from "./models/ConsentReportingSchema"; +export type * from "./models/ConsentRequestCreateExtended"; +export type * from "./models/ConsentRequestMap"; +export type * from "./models/ConsentRequestResponse"; +export type * from "./models/ConsentResponse"; +export type * from "./models/ConsentScopeCreate"; +export type * from "./models/ConsentScopeResponse"; +export * from "./models/ConsentStatus"; +export type * from "./models/ConsentStatusDetail"; +export type * from "./models/ConsentStatusReason"; +export type * from "./models/ConsentWithExecutableStatus"; +export type * from "./models/ConsentableItem"; +export type * from "./models/Constraint"; +export * from "./models/ConstraintType"; +export type * from "./models/ContactDetails"; +export * from "./models/Continent"; +export type * from "./models/CoreHealthCheck"; +export type * from "./models/CreateAssessmentTaskRequest"; +export type * from "./models/CreateAssessmentTaskResponse"; +export type * from "./models/CreateConnectionConfigurationWithSecrets"; +export type * from "./models/CreateConnectionConfigurationWithSecretsExtended"; +export type * from "./models/CreateExportPrivacyPreferencesJobRequest"; +export type * from "./models/CreateExportPrivacyPreferencesJobResponse"; +export type * from "./models/CreateIngestionPrivacyPreferencesJobRequest"; +export type * from "./models/CreateIngestionPrivacyPreferencesJobResponse"; +export * from "./models/CurrentStep"; +export type * from "./models/CursorPage_DatastoreStagedResourceTreeAPIResponse_"; +export * from "./models/CustomAssetType"; +export type * from "./models/CustomField"; +export type * from "./models/CustomFieldDefinition"; +export type * from "./models/CustomFieldDefinitionResponse"; +export type * from "./models/CustomFieldDefinitionWithId"; +export type * from "./models/CustomFieldWithId"; +export type * from "./models/CustomReportConfig"; +export type * from "./models/CustomReportCreate"; +export type * from "./models/CustomReportResponse"; +export type * from "./models/CustomReportResponseMinimal"; +export * from "./models/CustomTaxonomyColor"; +export * from "./models/DATAMAP_GROUPING"; +export * from "./models/DBActions"; +export type * from "./models/DataCategory"; +export type * from "./models/DataCategoryCreateOrUpdate"; +export type * from "./models/DataFlow"; +export * from "./models/DataResponsibilityTitle"; +export type * from "./models/DataSectionConfig"; +export type * from "./models/DataSubject"; +export type * from "./models/DataSubjectCreateOrUpdate"; +export type * from "./models/DataSubjectRights"; +export * from "./models/DataSubjectRightsEnum"; +export type * from "./models/DataUpload"; +export type * from "./models/DataUse"; +export type * from "./models/DataUseCreateOrUpdate"; +export type * from "./models/Database"; +export type * from "./models/DatabaseConfig"; +export type * from "./models/DatabaseHealthCheck"; +export type * from "./models/DatahubDocsSchema"; +export type * from "./models/DatamapReport"; +export type * from "./models/Dataset"; +export type * from "./models/DatasetCollection"; +export type * from "./models/DatasetConfigCtlDataset"; +export type * from "./models/DatasetConfigSchema"; +export type * from "./models/DatasetField"; +export type * from "./models/DatasetMetadata"; +export type * from "./models/DatasetPropertyResponse"; +export type * from "./models/DatasetReachability"; +export type * from "./models/DatasetResponse"; +export type * from "./models/DatasetSchema"; +export type * from "./models/DatasetTestRequest"; +export type * from "./models/DatasetTraversalDetails"; +export type * from "./models/DatastoreMonitorResourcesDynamicFilters"; +export type * from "./models/DatastoreMonitorUpdates"; +export type * from "./models/DatastoreStagedResource"; +export type * from "./models/DatastoreStagedResourceAPIResponse"; +export type * from "./models/DatastoreStagedResourceTreeAPIResponse"; +export type * from "./models/DefaultPolicyConfigRequest"; +export type * from "./models/DefaultPolicyConfigResponse"; +export type * from "./models/DeletedResourcesResponse"; +export type * from "./models/DenyPrivacyRequestSelection"; +export type * from "./models/DictionaryStatus"; +export * from "./models/DiffStatus"; +export type * from "./models/DiffStatusDistribution"; +export * from "./models/DigestConditionType"; +export type * from "./models/DigestConfigRequest"; +export type * from "./models/DigestConfigResponse"; +export * from "./models/DigestType"; +export type * from "./models/DiscoveryMonitorsConfig"; +export * from "./models/DrpAction"; +export type * from "./models/DrpDataRightsResponse"; +export type * from "./models/DrpMeta"; +export type * from "./models/DrpPrivacyRequestCreate"; +export * from "./models/DrpRegime"; +export type * from "./models/DrpRevokeRequest"; +export type * from "./models/DryRunDatasetResponse"; +export type * from "./models/DuplicateDetectionApplicationConfig"; +export type * from "./models/DynamicErasureEmailDocsSchema"; +export type * from "./models/DynamoDBDocsSchema"; +export type * from "./models/DynamoDBMonitorParams"; +export * from "./models/EdgeDirection"; +export type * from "./models/EditableMonitorConfig"; +export type * from "./models/EmailDocsSchema"; +export type * from "./models/EmbeddedLineItem"; +export type * from "./models/EmbeddedPrivacyNoticeResponse"; +export type * from "./models/EmbeddedPurpose"; +export type * from "./models/EmbeddedVendor"; +export type * from "./models/Endpoint"; +export * from "./models/EnforcementLevel"; +export * from "./models/ErrorNotificationMode"; +export * from "./models/ErrorType"; +export type * from "./models/Evaluation"; +export type * from "./models/EventAuditResponse"; +export type * from "./models/ExecutePromptRequest"; +export type * from "./models/ExecutePromptResponse"; +export type * from "./models/ExecutionAndAuditLogResponse"; +export type * from "./models/ExecutionApplicationConfig"; +export type * from "./models/ExecutionLogDetailResponse"; +export type * from "./models/ExecutionLogResponse"; +export * from "./models/ExecutionLogStatus"; +export type * from "./models/ExperienceConfigCreate"; +export type * from "./models/ExperienceConfigDisabledResponse"; +export type * from "./models/ExperienceConfigDisabledUpdate"; +export type * from "./models/ExperienceConfigListViewResponse"; +export type * from "./models/ExperienceConfigResponse"; +export type * from "./models/ExperienceConfigResponseNoNotices"; +export type * from "./models/ExperienceConfigUpdate"; +export type * from "./models/ExperienceMeta"; +export type * from "./models/ExperienceMinimalMeta"; +export type * from "./models/ExperienceTranslation"; +export type * from "./models/ExperienceTranslationCreate"; +export type * from "./models/ExperienceTranslationResponse"; +export * from "./models/ExportFormat"; +export type * from "./models/ExtendedIdentityTypes"; +export type * from "./models/ExternalDatasetReference"; +export type * from "./models/ExternalLoginOTPRequest"; +export type * from "./models/ExternalLoginOTPResponse"; +export type * from "./models/ExternalLoginVerifyRequest"; +export type * from "./models/ExternalUserCreateRequest"; +export type * from "./models/FidesCloudStatus"; +export type * from "./models/FidesConsentMetaCreate"; +export type * from "./models/FidesConsentMetaResponse"; +export type * from "./models/FidesConsentScopes"; +export type * from "./models/FidesDatasetReference"; +export type * from "./models/FidesDocsSchema"; +export type * from "./models/FidesMeta"; +export type * from "./models/Field"; +export type * from "./models/FieldAccuracyDetail"; +export * from "./models/FieldActionType"; +export type * from "./models/FieldMaskingStrategyOverride"; +export type * from "./models/FieldsAffectedResponse"; +export type * from "./models/FilteredFieldActionRequest"; +export type * from "./models/FilteredPrivacyRequestResults"; +export * from "./models/GCSAuthMethod"; +export type * from "./models/GPPApplicationConfig"; +export type * from "./models/GPPFieldMapping"; +export type * from "./models/GPPFieldMappingCreate"; +export type * from "./models/GPPMechanismMapping"; +export type * from "./models/GPPMobileData"; +export * from "./models/GPPUSApproach"; +export type * from "./models/Generate"; +export type * from "./models/GenerateRequestPayload"; +export type * from "./models/GenerateResponse"; +export type * from "./models/GenerateTestDataRequest"; +export * from "./models/GenerateTypes"; +export type * from "./models/GetRegistrationStatusResponse"; +export * from "./models/GoogleCloudSQLIPType"; +export type * from "./models/GoogleCloudSQLMySQLDocsSchema"; +export type * from "./models/GoogleCloudSQLPostgresDocsSchema"; +export * from "./models/GroupOperator"; +export * from "./models/HTTPMethod"; +export type * from "./models/HTTPValidationError"; +export type * from "./models/Header"; +export type * from "./models/HealthCheck"; +export * from "./models/IDPActionType"; +export type * from "./models/IDPActionValidationErrorResponse"; +export type * from "./models/IDPAllowedActionsResponse"; +export type * from "./models/IDPBulkActionResponse"; +export type * from "./models/IDPMonitorBulkSelection"; +export type * from "./models/IDPMonitorResourcesDynamicFilters"; +export type * from "./models/IDPMonitorResourcesFilter"; +export type * from "./models/IdentityBase"; +export type * from "./models/IdentityDefinitionCreate"; +export type * from "./models/IdentityDefinitionEntity"; +export * from "./models/IdentityDefinitionType"; +export type * from "./models/IdentityInputs"; +export * from "./models/IdentityProvider"; +export type * from "./models/IdentityProviderApplicationMetadata"; +export type * from "./models/IdentityProviderMonitorConfig"; +export type * from "./models/IdentityTypes"; +export type * from "./models/IdentityVerificationConfigResponse"; +export * from "./models/IncludeExcludeEnum"; +export * from "./models/IndexStatus"; +export type * from "./models/InfrastructureMonitorUpdates"; +export * from "./models/IntegrationFeature"; +export type * from "./models/JiraIssueType"; +export type * from "./models/JiraOAuthInitiateRequest"; +export type * from "./models/JiraOAuthInitiateResponse"; +export type * from "./models/JiraPreviewRequest"; +export type * from "./models/JiraProject"; +export type * from "./models/JiraStatusCategory"; +export type * from "./models/JiraTicketData"; +export type * from "./models/JiraTicketDocsSchema"; +export type * from "./models/LLMChatRequest"; +export type * from "./models/LLMClassifyRequest"; +export type * from "./models/Language"; +export * from "./models/Layer1ButtonOption"; +export * from "./models/LegalBasisForProcessingEnum"; +export * from "./models/LegalBasisForProfilingEnum"; +export type * from "./models/LimitedPrivacyNoticeResponseSchema"; +export type * from "./models/LinkedDatasetInfo"; +export type * from "./models/LinkedSystemInfo"; +export type * from "./models/LlmClassificationSample"; +export * from "./models/LoadingContext"; +export type * from "./models/Location"; +export type * from "./models/LocationCustomPrivacyRequestField"; +export type * from "./models/LocationGroup"; +export type * from "./models/LocationRegulationBase"; +export type * from "./models/LocationRegulationResponse"; +export type * from "./models/LocationRegulationSelections"; +export type * from "./models/LogEntry"; +export type * from "./models/MSSQLDocsSchema"; +export type * from "./models/MailgunConfig"; +export type * from "./models/ManualAction"; +export type * from "./models/ManualFieldCreate"; +export type * from "./models/ManualFieldListItem"; +export type * from "./models/ManualFieldPrivacyRequest"; +export * from "./models/ManualFieldRequestType"; +export type * from "./models/ManualFieldResponse"; +export type * from "./models/ManualFieldSearchFilterOptions"; +export type * from "./models/ManualFieldSearchResponse"; +export * from "./models/ManualFieldStatus"; +export type * from "./models/ManualFieldSystem"; +export type * from "./models/ManualFieldUpdate"; +export type * from "./models/ManualFieldUser"; +export type * from "./models/ManualTaskConfigCreate"; +export type * from "./models/ManualTaskConfigResponse"; +export type * from "./models/ManualTaskConfigUpdate"; +export type * from "./models/ManualTaskExportRequest"; +export type * from "./models/ManualTaskFieldBase"; +export type * from "./models/ManualTaskFieldMetadata"; +export * from "./models/ManualTaskFieldType"; +export * from "./models/ManualTaskParentEntityType"; +export type * from "./models/ManualTaskResponse"; +export type * from "./models/ManualWebhookData"; +export type * from "./models/ManualWebhookDocsSchema"; +export type * from "./models/ManualWebhookField"; +export type * from "./models/MappedPurpose"; +export type * from "./models/MariaDBDocsSchema"; +export type * from "./models/MaskingAPIRequest"; +export type * from "./models/MaskingAPIResponse"; +export * from "./models/MaskingStrategies"; +export type * from "./models/MaskingStrategyConfigurationDescription"; +export type * from "./models/MaskingStrategyDescription"; +export type * from "./models/MaskingStrategyOverride"; +export * from "./models/MatchesEnum"; +export * from "./models/MessagingActionType"; +export type * from "./models/MessagingConfigRequest"; +export type * from "./models/MessagingConfigRequestBase"; +export type * from "./models/MessagingConfigResponse"; +export * from "./models/MessagingConfigStatus"; +export type * from "./models/MessagingConfigStatusMessage"; +export * from "./models/MessagingConnectionTestStatus"; +export * from "./models/MessagingMethod"; +export type * from "./models/MessagingSecretsMailgunDocs"; +export type * from "./models/MessagingSecretsTwilioEmailDocs"; +export type * from "./models/MessagingSecretsTwilioSMSDocs"; +export type * from "./models/MessagingServiceDetailsAWS_SES"; +export type * from "./models/MessagingServiceDetailsMailchimpTransactional"; +export type * from "./models/MessagingServiceDetailsMailgun"; +export type * from "./models/MessagingServiceDetailsTwilioEmail"; +export type * from "./models/MessagingServiceSecretsAWS_SESDocs"; +export type * from "./models/MessagingServiceSecretsMailchimpTransactionalDocs"; +export * from "./models/MessagingServiceType"; +export type * from "./models/MessagingTemplateDefault"; +export type * from "./models/MessagingTemplateWithPropertiesBodyParams"; +export type * from "./models/MessagingTemplateWithPropertiesDetail"; +export type * from "./models/MessagingTemplateWithPropertiesPatchBodyParams"; +export type * from "./models/MessagingTemplateWithPropertiesSummary"; +export type * from "./models/MessagingTestBodyParams"; +export type * from "./models/MinimalAsset"; +export type * from "./models/MinimalClassifyParams"; +export type * from "./models/MinimalMessagingTemplate"; +export type * from "./models/MinimalPrivacyExperienceConfig"; +export type * from "./models/MinimalPrivacyNotice"; +export type * from "./models/MinimalProperty"; +export type * from "./models/MinimalTCFBannerTranslation"; +export type * from "./models/MinimalTCFExperienceConfig"; +export type * from "./models/MongoDBDocsSchema"; +export type * from "./models/MonitorActionResponse"; +export type * from "./models/MonitorClassifyParams"; +export type * from "./models/MonitorConfig"; +export type * from "./models/MonitorConfigStagedResourcesAggregateRecord"; +export type * from "./models/MonitorDeletionImpact"; +export type * from "./models/MonitorExecution"; +export type * from "./models/MonitorExecutionRequestResponse"; +export * from "./models/MonitorExecutionStatus"; +export * from "./models/MonitorFrequency"; +export type * from "./models/MonitorStatusResponse"; +export type * from "./models/MonitorStewardUserResponse"; +export type * from "./models/MonitorTaskDetailResponse"; +export type * from "./models/MonitorTaskResponse"; +export * from "./models/MonitorTaskType"; +export type * from "./models/MySQLDocsSchema"; +export * from "./models/MySQLSSLMode"; +export type * from "./models/NestedFieldDict"; +export type * from "./models/NoticeTranslation"; +export type * from "./models/NoticeTranslationCreate"; +export type * from "./models/NoticeTranslationResponse"; +export type * from "./models/NotificationApplicationConfig"; +export type * from "./models/OAuthConfigSchema"; +export * from "./models/OAuthGrantType"; +export type * from "./models/OktaConfig"; +export type * from "./models/OktaDocsSchema"; +export type * from "./models/OktaMonitorConfig"; +export type * from "./models/OpenIDProvider"; +export type * from "./models/OpenIDProviderCreate"; +export type * from "./models/OpenIDProviderSimple"; +export * from "./models/Operator"; +export type * from "./models/OptionalStagedResourcesRequest"; +export type * from "./models/Organization"; +export type * from "./models/OrganizationMetadata"; +export type * from "./models/Page_AssessmentResponse_"; +export type * from "./models/Page_AssessmentTaskResponse_"; +export type * from "./models/Page_Asset_"; +export type * from "./models/Page_AttachmentResponse_"; +export type * from "./models/Page_BasicSystemResponseExtended_"; +export type * from "./models/Page_ClassificationBenchmarkSummary_"; +export type * from "./models/Page_ClassifyInstanceResponseValues_"; +export type * from "./models/Page_CommentResponse_"; +export type * from "./models/Page_ConnectionConfigurationResponse_"; +export type * from "./models/Page_ConnectionSystemTypeMap_"; +export type * from "./models/Page_ConsentBreakdown_"; +export type * from "./models/Page_ConsentReport_"; +export type * from "./models/Page_CustomReportResponseMinimal_"; +export type * from "./models/Page_CustomReportResponse_"; +export type * from "./models/Page_DatamapReport_"; +export type * from "./models/Page_DatasetConfigSchema_"; +export type * from "./models/Page_DatasetResponse_"; +export type * from "./models/Page_Dataset_"; +export type * from "./models/Page_DatastoreStagedResourceAPIResponse_"; +export type * from "./models/Page_DigestConfigResponse_"; +export type * from "./models/Page_EventAuditResponse_"; +export type * from "./models/Page_ExecutionLogDetailResponse_"; +export type * from "./models/Page_ExperienceConfigListViewResponse_"; +export type * from "./models/Page_FieldAccuracyDetail_"; +export type * from "./models/Page_Language_"; +export type * from "./models/Page_LimitedPrivacyNoticeResponseSchema_"; +export type * from "./models/Page_ManualTaskConfigResponse_"; +export type * from "./models/Page_ManualTaskResponse_"; +export type * from "./models/Page_MessagingConfigResponse_"; +export type * from "./models/Page_MessagingTemplateWithPropertiesSummary_"; +export type * from "./models/Page_MonitorConfigStagedResourcesAggregateRecord_"; +export type * from "./models/Page_MonitorExecution_"; +export type * from "./models/Page_MonitorStatusResponse_"; +export type * from "./models/Page_MonitorTaskResponse_"; +export type * from "./models/Page_PolicyResponse_"; +export type * from "./models/Page_PolicyWebhookResponse_"; +export type * from "./models/Page_PreApprovalWebhookResponse_"; +export type * from "./models/Page_PrivacyExperienceMetaResponse_"; +export type * from "./models/Page_Property_"; +export type * from "./models/Page_RuleResponseWithTargets_"; +export type * from "./models/Page_RuleTarget_"; +export type * from "./models/Page_SharedMonitorConfig_"; +export type * from "./models/Page_StagedResourceAPIResponse_"; +export type * from "./models/Page_StorageDestinationResponse_"; +export type * from "./models/Page_SystemHistoryResponse_"; +export type * from "./models/Page_SystemStagedResourcesAggregateRecord_"; +export type * from "./models/Page_SystemSummary_"; +export type * from "./models/Page_SystemWithMonitorKeys_"; +export type * from "./models/Page_TCFConfigurationResponse_"; +export type * from "./models/Page_TCFPublisherRestrictionResponse_"; +export type * from "./models/Page_TemplateResponse_"; +export type * from "./models/Page_Union_PrivacyExperienceResponse__TCFBannerExperienceMinimalResponse__"; +export type * from "./models/Page_Union_PrivacyRequestVerboseResponse__PrivacyRequestResponse__"; +export type * from "./models/Page_UserResponse_"; +export type * from "./models/Page_str_"; +export type * from "./models/PaginatedResponse_ConsentResponse_"; +export type * from "./models/PaginationFilterParams"; +export type * from "./models/ParamValue"; +export type * from "./models/Params"; +export type * from "./models/PartialPrivacyCenterConfig"; +export type * from "./models/PartialPrivacyRequestOption"; +export * from "./models/PeriodicIntegrationFrequency"; +export type * from "./models/PlusApplicationConfig"; +export type * from "./models/PlusConsentSettingsApplicationConfig"; +export type * from "./models/PolicyConditionRequest"; +export type * from "./models/PolicyConditionResponse"; +export type * from "./models/PolicyMaskingSpec"; +export type * from "./models/PolicyMaskingSpecResponse"; +export type * from "./models/PolicyResponse"; +export type * from "./models/PolicyRule"; +export type * from "./models/PolicyUnavailableMessages"; +export type * from "./models/PolicyWebhookCreate"; +export type * from "./models/PolicyWebhookDeleteResponse"; +export type * from "./models/PolicyWebhookResponse"; +export type * from "./models/PolicyWebhookUpdate"; +export type * from "./models/PolicyWebhookUpdateResponse"; +export type * from "./models/PostgreSQLDocsSchema"; +export type * from "./models/PreApprovalWebhookCreate"; +export type * from "./models/PreApprovalWebhookResponse"; +export type * from "./models/PreApprovalWebhookUpdate"; +export type * from "./models/PreVerifiedPrivacyPreferencesRequest"; +export type * from "./models/PreferenceFidesMeta"; +export type * from "./models/PreferenceFidesMetaCreate"; +export type * from "./models/PreferenceMetaCreate"; +export type * from "./models/PreferenceMetaResponse"; +export * from "./models/PreferenceType"; +export type * from "./models/PreferenceWithNoticeInformation"; +export type * from "./models/PreferencesSaved"; +export type * from "./models/PreferencesSavedExtended"; +export type * from "./models/PrivacyAssessmentConfigDefaults"; +export type * from "./models/PrivacyAssessmentConfigResponse"; +export type * from "./models/PrivacyAssessmentConfigUpdate"; +export type * from "./models/PrivacyDeclaration"; +export type * from "./models/PrivacyDeclarationResponse"; +export type * from "./models/PrivacyExperienceGPPSettings"; +export type * from "./models/PrivacyExperienceMetaResponse"; +export type * from "./models/PrivacyExperienceResponse"; +export type * from "./models/PrivacyNoticeCreation"; +export type * from "./models/PrivacyNoticeDisabledResponse"; +export type * from "./models/PrivacyNoticeDisabledUpdate"; +export * from "./models/PrivacyNoticeFramework"; +export * from "./models/PrivacyNoticeRegion"; +export type * from "./models/PrivacyNoticeResponse"; +export type * from "./models/PrivacyNoticeResponseWithRegions"; +export type * from "./models/PrivacyNoticeUpdate"; +export type * from "./models/PrivacyPreferenceStats"; +export type * from "./models/PrivacyPreferencesRequest"; +export type * from "./models/PrivacyRequestAccessResults"; +export type * from "./models/PrivacyRequestBulkSelection"; +export type * from "./models/PrivacyRequestCreateExtended"; +export * from "./models/PrivacyRequestDRPStatus"; +export type * from "./models/PrivacyRequestDRPStatusResponse"; +export type * from "./models/PrivacyRequestDiagnosticsExportResponse"; +export type * from "./models/PrivacyRequestFieldDefinition"; +export type * from "./models/PrivacyRequestFieldsResponse"; +export type * from "./models/PrivacyRequestFilter"; +export type * from "./models/PrivacyRequestNotificationInfo"; +export type * from "./models/PrivacyRequestOption"; +export type * from "./models/PrivacyRequestRedactionPatternsRequest"; +export type * from "./models/PrivacyRequestRedactionPatternsResponse"; +export type * from "./models/PrivacyRequestResponse"; +export type * from "./models/PrivacyRequestResumeFormat"; +export * from "./models/PrivacyRequestSource"; +export * from "./models/PrivacyRequestStatus"; +export type * from "./models/PrivacyRequestTaskSchema"; +export type * from "./models/PrivacyRequestUser"; +export type * from "./models/PrivacyRequestVerboseResponse"; +export type * from "./models/PrivacyRule"; +export type * from "./models/PromoteErrorInfo"; +export type * from "./models/PromoteResourcesResponse"; +export type * from "./models/PromoteResponse"; +export type * from "./models/PromoteSummary"; +export type * from "./models/PromotedSystemInfo"; +export * from "./models/PromptCategory"; +export type * from "./models/PromptInfo"; +export * from "./models/PromptType"; +export * from "./models/PropagationPolicyKey"; +export type * from "./models/Property"; +export type * from "./models/PropertyCreate"; +export type * from "./models/PropertyNameResolutionRequest"; +export type * from "./models/PropertyNameResolutionResponse"; +export * from "./models/PropertyType"; +export * from "./models/ProviderEnum"; +export type * from "./models/PublicPropertyResponse"; +export type * from "./models/PurposesResponse"; +export type * from "./models/QueryParam"; +export type * from "./models/QuestionProgressItem"; +export type * from "./models/QuestionnaireStatusResponse"; +export type * from "./models/QueueInfo"; +export type * from "./models/RDSMySQLDocsSchema"; +export type * from "./models/RDSPostgresDocsSchema"; +export type * from "./models/RangeEntry"; +export type * from "./models/RateLimit"; +export type * from "./models/RateLimitConfig"; +export * from "./models/RateLimitPeriod"; +export type * from "./models/ReadSaaSRequest"; +export type * from "./models/RecalculateConsentResponse"; +export type * from "./models/RecordConsentServedRequest"; +export type * from "./models/RecordsServedResponse"; +export type * from "./models/RedshiftDocsSchema"; +export type * from "./models/Registration"; +export * from "./models/RejectAllMechanism"; +export type * from "./models/RenderPromptRequest"; +export type * from "./models/RenderPromptResponse"; +export * from "./models/ReportExportFormat"; +export * from "./models/ReportType"; +export * from "./models/RequestOrigin"; +export type * from "./models/RequestTaskCallbackRequest"; +export type * from "./models/ResourceError"; +export type * from "./models/ResourceFilter"; +export * from "./models/ResourceTypes"; +export * from "./models/ResponseFormat"; +export type * from "./models/ResponseWithMessage"; +export type * from "./models/ResultSetStats"; +export type * from "./models/RevertAnswerRequest"; +export * from "./models/RoleRegistryEnum"; +export type * from "./models/RuleCreate"; +export type * from "./models/RuleCreateWithTargets"; +export type * from "./models/RuleResponse"; +export type * from "./models/RuleResponseWithTargets"; +export type * from "./models/RuleTarget"; +export type * from "./models/S3Config"; +export type * from "./models/S3DocsSchema"; +export type * from "./models/S3MonitorParams"; +export type * from "./models/SaaSConfig"; +export type * from "./models/SaaSConfigBase"; +export type * from "./models/SaaSConfigValidationDetails"; +export type * from "./models/SaaSDisplayInfo"; +export type * from "./models/SaaSRequest"; +export type * from "./models/SaaSRequestMap"; +export type * from "./models/SaaSSchema"; +export type * from "./models/SaasConnectionTemplateResponse"; +export type * from "./models/SaasConnectionTemplateValues"; +export type * from "./models/SaasConnectionTemplateValuesExtended"; +export type * from "./models/Schema"; +export * from "./models/ScopeRegistryEnum"; +export type * from "./models/ScyllaDocsSchema"; +export type * from "./models/SecurityApplicationConfig"; +export * from "./models/SeedExecutionStatus"; +export type * from "./models/SeedRequest"; +export type * from "./models/SeedResponse"; +export type * from "./models/SeedStatusResponse"; +export type * from "./models/SeedStepStatus"; +export * from "./models/SeedTaskStatus"; +export type * from "./models/SeedTasksConfig"; +export type * from "./models/Selection"; +export type * from "./models/SendMessageRequest"; +export type * from "./models/SendMessageResponse"; +export type * from "./models/SendQuestionnaireRequest"; +export type * from "./models/SendQuestionnaireResponse"; +export type * from "./models/SendReminderRequest"; +export type * from "./models/SendReminderResponse"; +export * from "./models/ServiceHealth"; +export * from "./models/ServingComponent"; +export type * from "./models/SetSystemLinksRequest"; +export type * from "./models/SharedMonitorConfig"; +export type * from "./models/SingleFieldSubmissionResponse"; +export type * from "./models/SlackChannel"; +export type * from "./models/SnowflakeDocsSchema"; +export type * from "./models/SourcePreference"; +export type * from "./models/SovrnDocsSchema"; +export * from "./models/SpecialCategoryLegalBasisEnum"; +export * from "./models/SqlDryRunMode"; +export type * from "./models/StagedResource"; +export type * from "./models/StagedResourceAPIResponse"; +export * from "./models/StagedResourceTypeValue"; +export type * from "./models/StagedResourceUpdateRequest"; +export * from "./models/StatusEnum"; +export * from "./models/StatusType"; +export type * from "./models/StorageApplicationConfig"; +export * from "./models/StorageConfigStatus"; +export type * from "./models/StorageConfigStatusMessage"; +export type * from "./models/StorageDestination"; +export type * from "./models/StorageDestinationBase"; +export type * from "./models/StorageDestinationResponse"; +export * from "./models/StorageDetails"; +export type * from "./models/StorageDetailsGCS"; +export type * from "./models/StorageDetailsLocal"; +export type * from "./models/StorageDetailsS3"; +export type * from "./models/StorageSecretsGCSDocs"; +export type * from "./models/StorageSecretsS3Docs"; +export * from "./models/StorageType"; +export * from "./models/StorageTypeApiAccepted"; +export type * from "./models/Strategy"; +export * from "./models/SupportedLanguage"; +export type * from "./models/System"; +export type * from "./models/SystemGroup"; +export type * from "./models/SystemGroupCreate"; +export type * from "./models/SystemGroupUpdate"; +export type * from "./models/SystemHistoryResponse"; +export type * from "./models/SystemLinkRequest"; +export type * from "./models/SystemLinkResponse"; +export type * from "./models/SystemMetadata"; +export type * from "./models/SystemPurposeSummary"; +export type * from "./models/SystemResponse"; +export type * from "./models/SystemResponseExtended"; +export type * from "./models/SystemScanHistory"; +export type * from "./models/SystemScanResponse"; +export type * from "./models/SystemScannerStatus"; +export type * from "./models/SystemSchemaExtended"; +export type * from "./models/SystemStagedResourcesAggregateRecord"; +export type * from "./models/SystemSummary"; +export * from "./models/SystemType"; +export type * from "./models/SystemWithMonitorKeys"; +export type * from "./models/SystemsDiff"; +export type * from "./models/TCDecode"; +export type * from "./models/TCFBannerExperienceMinimalResponse"; +export type * from "./models/TCFConfigurationDetail"; +export type * from "./models/TCFConfigurationRequest"; +export type * from "./models/TCFConfigurationResponse"; +export type * from "./models/TCFFeatureRecord"; +export type * from "./models/TCFFeatureSave"; +export * from "./models/TCFLegalBasisEnum"; +export type * from "./models/TCFPreferences"; +export type * from "./models/TCFPublisherRestrictionRequest"; +export type * from "./models/TCFPublisherRestrictionUpdateRequest"; +export type * from "./models/TCFPurposeConsentRecord"; +export type * from "./models/TCFPurposeLegitimateInterestsRecord"; +export type * from "./models/TCFPurposeOverrideSchema"; +export type * from "./models/TCFPurposeSave"; +export * from "./models/TCFRestrictionType"; +export type * from "./models/TCFSpecialFeatureRecord"; +export type * from "./models/TCFSpecialFeatureSave"; +export type * from "./models/TCFSpecialPurposeRecord"; +export type * from "./models/TCFSpecialPurposeSave"; +export type * from "./models/TCFStatus"; +export type * from "./models/TCFVendorConsentRecord"; +export type * from "./models/TCFVendorLegitimateInterestsRecord"; +export type * from "./models/TCFVendorRelationships"; +export * from "./models/TCFVendorRestriction"; +export type * from "./models/TCFVendorSave"; +export type * from "./models/TCMobileData"; +export type * from "./models/Table"; +export type * from "./models/TableContext"; +export type * from "./models/TaskDetails"; +export * from "./models/TaskRunType"; +export type * from "./models/TaxonomyCreate"; +export type * from "./models/TaxonomyElement"; +export type * from "./models/TaxonomyElementCreate"; +export type * from "./models/TaxonomyElementUpdate"; +export type * from "./models/TaxonomyResponse"; +export type * from "./models/TaxonomyUpdate"; +export type * from "./models/TemplateResponse"; +export type * from "./models/TemplateVariable"; +export type * from "./models/TestMessagingStatusMessage"; +export type * from "./models/TestMonitorParams"; +export type * from "./models/TestPrivacyRequest"; +export * from "./models/TestStatus"; +export type * from "./models/TestStatusMessage"; +export type * from "./models/TestWebsiteMonitorParams"; +export type * from "./models/TimeBasedPartitioning"; +export * from "./models/TimeInclusivity"; +export type * from "./models/TimescaleDocsSchema"; +export type * from "./models/ToneResponse"; +export type * from "./models/ToneUpdate"; +export type * from "./models/UnlabeledIdentities"; +export type * from "./models/UnverifiedIdentity"; +export type * from "./models/UnverifiedPrivacyPreferencesRequest"; +export type * from "./models/UpdateAnswerRequest"; +export type * from "./models/UpdateMonitorStewardsRequest"; +export * from "./models/UserConsentPreference"; +export type * from "./models/UserCreateExtended"; +export type * from "./models/UserCreateResponse"; +export type * from "./models/UserEmailInviteStatus"; +export type * from "./models/UserForcePasswordReset"; +export type * from "./models/UserLogin"; +export type * from "./models/UserLoginResponse"; +export type * from "./models/UserPasswordReset"; +export type * from "./models/UserPermissionsCreate"; +export type * from "./models/UserPermissionsEdit"; +export type * from "./models/UserPermissionsPlusResponse"; +export type * from "./models/UserResponse"; +export type * from "./models/UserResponseExtended"; +export type * from "./models/UserUpdate"; +export * from "./models/ValidTargets"; +export type * from "./models/ValidateDatasetResponse"; +export type * from "./models/ValidateRequest"; +export type * from "./models/ValidateResponse"; +export type * from "./models/ValidateSaaSConfigResponse"; +export type * from "./models/ValidationError"; +export type * from "./models/ValidationErrorResponse"; +export * from "./models/ValidationStatus"; +export * from "./models/ValidationTarget"; +export type * from "./models/ValuesList"; +export type * from "./models/VendorIds"; +export * from "./models/VendorMatchConfidence"; +export type * from "./models/VendorMatchStats"; +export type * from "./models/VerificationCode"; +export type * from "./models/Violation"; +export type * from "./models/ViolationAttributes"; +export type * from "./models/WebMonitorUpdates"; +export * from "./models/WebhookDirection"; +export type * from "./models/WebhookOrder"; +export type * from "./models/WebsiteClassificationReport"; +export type * from "./models/WebsiteMonitorConfig"; +export type * from "./models/WebsiteMonitorParams"; +export type * from "./models/WebsiteMonitorResourcesFilters"; +export type * from "./models/WebsiteSchema"; +export type * from "./models/WorkerHealthCheck"; +export type * from "./models/WorkerInfo"; +export type * from "./models/WorkerStats"; +export type * from "./models/fides__api__schemas__application_config__ConsentConfig"; +export type * from "./models/fides__api__schemas__application_config__PrivacyCenterConfig"; +export type * from "./models/fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds"; +export type * from "./models/fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds"; +export type * from "./models/fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds"; +export type * from "./models/fides__api__schemas__policy__Policy"; +export type * from "./models/fides__api__schemas__privacy_center_config__ConsentConfig"; +export type * from "./models/fides__api__schemas__privacy_center_config__CustomPrivacyRequestField"; +export type * from "./models/fides__api__schemas__privacy_center_config__PrivacyCenterConfig"; +export type * from "./models/fides__api__schemas__privacy_request__IdentityValue"; +export type * from "./models/fides__api__schemas__redis_cache__CustomPrivacyRequestField"; +export type * from "./models/fides__api__schemas__redis_cache__Identity"; +export type * from "./models/fides__connectors__models__KeyfileCreds"; +export type * from "./models/fideslang__models__Policy"; +export type * from "./models/fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRestrictionResponse"; +export type * from "./models/fidesplus__cls__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds"; +export type * from "./models/fidesplus__schemas__tcf_experience__TCFPublisherRestrictionResponse"; +export type * from "./models/fidesplus__v3__schemas__identity__Identity"; +export type * from "./models/fidesplus__v3__schemas__identity__IdentityValue"; +export type * from "./types"; +export type * from "./models/databaseHealthHealthDatabaseGetData"; +export type * from "./models/databaseHealthHealthDatabaseGetErrors"; +export type * from "./models/databaseHealthHealthDatabaseGetResponses"; +export type * from "./models/databaseHealthHealthDatabaseGetResponse"; +export type * from "./models/workersHealthHealthWorkersGetData"; +export type * from "./models/workersHealthHealthWorkersGetErrors"; +export type * from "./models/workersHealthHealthWorkersGetResponses"; +export type * from "./models/workersHealthHealthWorkersGetResponse"; +export type * from "./models/healthHealthGetData"; +export type * from "./models/healthHealthGetErrors"; +export type * from "./models/healthHealthGetError"; +export type * from "./models/healthHealthGetResponses"; +export type * from "./models/healthHealthGetResponse"; +export type * from "./models/readIndexGetData"; +export type * from "./models/readIndexGetResponses"; +export type * from "./models/readOtherPathsCatchallGetData"; +export type * from "./models/readOtherPathsCatchallGetResponses"; diff --git a/clients/admin-ui/src/types/api/models/APIMonitorType.ts b/clients/admin-ui/src/types/api/models/APIMonitorType.ts new file mode 100644 index 00000000000..a8cdc883a3e --- /dev/null +++ b/clients/admin-ui/src/types/api/models/APIMonitorType.ts @@ -0,0 +1,12 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * APIMonitorType + * + * Monitor types as used by the API + */ +export enum APIMonitorType { + WEBSITE = "website", + DATASTORE = "datastore", + INFRASTRUCTURE = "infrastructure", +} diff --git a/clients/admin-ui/src/types/api/models/AWSAuthMethod.ts b/clients/admin-ui/src/types/api/models/AWSAuthMethod.ts index 7f0f2915d16..50c1b914b24 100644 --- a/clients/admin-ui/src/types/api/models/AWSAuthMethod.ts +++ b/clients/admin-ui/src/types/api/models/AWSAuthMethod.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * AWSAuthMethod + */ export enum AWSAuthMethod { AUTOMATIC = "automatic", SECRET_KEYS = "secret_keys", diff --git a/clients/admin-ui/src/types/api/models/AWSConfig.ts b/clients/admin-ui/src/types/api/models/AWSConfig.ts index e030f325066..7fe1881ae9f 100644 --- a/clients/admin-ui/src/types/api/models/AWSConfig.ts +++ b/clients/admin-ui/src/types/api/models/AWSConfig.ts @@ -1,13 +1,25 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AWSConfig + * * The model for the connection config for AWS */ export type AWSConfig = { + /** + * Region Name + */ region_name: string; + /** + * Aws Secret Access Key + */ aws_secret_access_key: string; + /** + * Aws Access Key Id + */ aws_access_key_id: string; + /** + * Aws Session Token + */ aws_session_token?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/AccessLevel.ts b/clients/admin-ui/src/types/api/models/AccessLevel.ts index 78d7c075852..6eb97831784 100644 --- a/clients/admin-ui/src/types/api/models/AccessLevel.ts +++ b/clients/admin-ui/src/types/api/models/AccessLevel.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AccessLevel + * * Perms given to the ConnectionConfig. For example, with "read" permissions, fidesops promises * to not modify the data on a connected application database in any way. * diff --git a/clients/admin-ui/src/types/api/models/AccessManualWebhookResponse.ts b/clients/admin-ui/src/types/api/models/AccessManualWebhookResponse.ts index 222de60055f..e06209706c6 100644 --- a/clients/admin-ui/src/types/api/models/AccessManualWebhookResponse.ts +++ b/clients/admin-ui/src/types/api/models/AccessManualWebhookResponse.ts @@ -1,15 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConnectionConfigurationResponse } from "./ConnectionConfigurationResponse"; import type { ManualWebhookField } from "./ManualWebhookField"; /** + * AccessManualWebhookResponse + * * Expected response for accessing Access Manual Webhooks */ export type AccessManualWebhookResponse = { + /** + * Fields + */ fields: Array; connection_config: ConnectionConfigurationResponse; + /** + * Id + */ id: string; }; diff --git a/clients/admin-ui/src/types/api/models/AccessManualWebhooks.ts b/clients/admin-ui/src/types/api/models/AccessManualWebhooks.ts index a29a7b78c59..9584bc1388d 100644 --- a/clients/admin-ui/src/types/api/models/AccessManualWebhooks.ts +++ b/clients/admin-ui/src/types/api/models/AccessManualWebhooks.ts @@ -1,12 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ManualWebhookField } from "./ManualWebhookField"; /** + * AccessManualWebhooks + * * Expected request body for creating Access Manual Webhooks */ export type AccessManualWebhooks = { + /** + * Fields + */ fields: Array; }; diff --git a/clients/admin-ui/src/types/api/models/AccessToken.ts b/clients/admin-ui/src/types/api/models/AccessToken.ts index 9b72012d3eb..4d2d367c0e8 100644 --- a/clients/admin-ui/src/types/api/models/AccessToken.ts +++ b/clients/admin-ui/src/types/api/models/AccessToken.ts @@ -1,10 +1,25 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** - * A wrapper for the access_code returned upon successful authentication + * AccessToken + * + * A wrapper for the access_code returned upon successful authentication. */ export type AccessToken = { + /** + * Access Token + */ access_token: string; + /** + * Token Type + */ + token_type?: "Bearer"; + /** + * Expires In + */ + expires_in?: number | null; + /** + * Expires At + */ + expires_at?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/AccuracyMetrics.ts b/clients/admin-ui/src/types/api/models/AccuracyMetrics.ts index 48f7ea019d3..bcaab18e61f 100644 --- a/clients/admin-ui/src/types/api/models/AccuracyMetrics.ts +++ b/clients/admin-ui/src/types/api/models/AccuracyMetrics.ts @@ -1,56 +1,80 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AccuracyMetrics + * * Accuracy metrics for classification evaluation. */ export type AccuracyMetrics = { /** + * Precision + * * Precision score (0.0 to 1.0) */ precision: number; /** + * Recall + * * Recall score (0.0 to 1.0) */ recall: number; /** + * F1 Score + * * F1 score (0.0 to 1.0) */ f1_score: number; /** + * Total Ground Truth + * * Total number of ground truth categories */ total_ground_truth: number; /** + * Total Classified + * * Total number of classified categories */ total_classified: number; /** + * True Positives + * * Number of correctly classified categories */ true_positives: number; /** + * False Positives + * * Number of incorrectly classified categories */ false_positives: number; /** + * False Negatives + * * Number of missed categories */ false_negatives: number; /** + * True Negatives + * * Number of correctly classified default categories */ true_negatives: number; /** + * Total Fields + * * Total number of staged resource fields evaluated */ total_fields: number; /** + * Errors + * * Number of fields with classification errors */ errors: number; /** + * Error Percentage + * * Percentage of fields with classification errors (0.0 to 1.0) */ error_percentage: number; diff --git a/clients/admin-ui/src/types/api/models/ActionType.ts b/clients/admin-ui/src/types/api/models/ActionType.ts index 104ce8fa9ad..8bd50c198cd 100644 --- a/clients/admin-ui/src/types/api/models/ActionType.ts +++ b/clients/admin-ui/src/types/api/models/ActionType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ActionType + * * The purpose of a particular privacy request */ export enum ActionType { diff --git a/clients/admin-ui/src/types/api/models/ActionValidationErrorResponse.ts b/clients/admin-ui/src/types/api/models/ActionValidationErrorResponse.ts new file mode 100644 index 00000000000..889f0c40485 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ActionValidationErrorResponse.ts @@ -0,0 +1,27 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { DiffStatus } from "./DiffStatus"; +import { FieldActionType } from "./FieldActionType"; + +/** + * ActionValidationErrorResponse + * + * Structured error response when an action cannot be performed due to invalid diff_statuses. + */ +export type ActionValidationErrorResponse = { + action_type: FieldActionType; + /** + * Disallowed Statuses With Counts + */ + disallowed_statuses_with_counts: { + [key in DiffStatus]?: number; + }; + /** + * Allowed Statuses + */ + allowed_statuses: Array; + /** + * Message + */ + message: string; +}; diff --git a/clients/admin-ui/src/types/api/models/AdminUIConfig.ts b/clients/admin-ui/src/types/api/models/AdminUIConfig.ts index 1a93f51b5c4..fc5e56dc89d 100644 --- a/clients/admin-ui/src/types/api/models/AdminUIConfig.ts +++ b/clients/admin-ui/src/types/api/models/AdminUIConfig.ts @@ -1,11 +1,18 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ErrorNotificationMode } from "./ErrorNotificationMode"; +import { ErrorNotificationMode } from "./ErrorNotificationMode"; +/** + * AdminUIConfig + */ export type AdminUIConfig = { + /** + * Enabled + */ enabled?: boolean | null; + /** + * Url + */ url?: string | null; error_notification_mode?: ErrorNotificationMode | null; }; diff --git a/clients/admin-ui/src/types/api/models/AdvancedSettings.ts b/clients/admin-ui/src/types/api/models/AdvancedSettings.ts index 806aae99830..1d897928698 100644 --- a/clients/admin-ui/src/types/api/models/AdvancedSettings.ts +++ b/clients/admin-ui/src/types/api/models/AdvancedSettings.ts @@ -1,9 +1,10 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { IdentityTypes } from "./IdentityTypes"; +/** + * AdvancedSettings + */ export type AdvancedSettings = { identity_types: IdentityTypes; }; diff --git a/clients/admin-ui/src/types/api/models/AdvancedSettingsWithExtendedIdentityTypes.ts b/clients/admin-ui/src/types/api/models/AdvancedSettingsWithExtendedIdentityTypes.ts index e940896f545..4803edc451c 100644 --- a/clients/admin-ui/src/types/api/models/AdvancedSettingsWithExtendedIdentityTypes.ts +++ b/clients/admin-ui/src/types/api/models/AdvancedSettingsWithExtendedIdentityTypes.ts @@ -1,10 +1,10 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ExtendedIdentityTypes } from "./ExtendedIdentityTypes"; /** + * AdvancedSettingsWithExtendedIdentityTypes + * * Overrides base AdvancedSettings to have extended IdentityTypes */ export type AdvancedSettingsWithExtendedIdentityTypes = { diff --git a/clients/admin-ui/src/types/api/models/AesDecryptionRequest.ts b/clients/admin-ui/src/types/api/models/AesDecryptionRequest.ts index fe655b589c0..e6f82dbf5d8 100644 --- a/clients/admin-ui/src/types/api/models/AesDecryptionRequest.ts +++ b/clients/admin-ui/src/types/api/models/AesDecryptionRequest.ts @@ -1,12 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AesDecryptionRequest + * * Specifies fields provided to the AES Decryption endpoint */ export type AesDecryptionRequest = { + /** + * Value + */ value: string; + /** + * Key + */ key: string; + /** + * Nonce + */ nonce: string; }; diff --git a/clients/admin-ui/src/types/api/models/AesDecryptionResponse.ts b/clients/admin-ui/src/types/api/models/AesDecryptionResponse.ts index e84e331908b..105692e596c 100644 --- a/clients/admin-ui/src/types/api/models/AesDecryptionResponse.ts +++ b/clients/admin-ui/src/types/api/models/AesDecryptionResponse.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AesDecryptionResponse + * * Specified fields returned from the AES Decryption endpoint */ export type AesDecryptionResponse = { + /** + * Decrypted Value + */ decrypted_value: string; }; diff --git a/clients/admin-ui/src/types/api/models/AesEncryptionRequest.ts b/clients/admin-ui/src/types/api/models/AesEncryptionRequest.ts index ebfe2b69f72..9583e286349 100644 --- a/clients/admin-ui/src/types/api/models/AesEncryptionRequest.ts +++ b/clients/admin-ui/src/types/api/models/AesEncryptionRequest.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AesEncryptionRequest + * * Specifies fields provided to the AES Encryption endpoint */ export type AesEncryptionRequest = { + /** + * Value + */ value: string; + /** + * Key + */ key: string; }; diff --git a/clients/admin-ui/src/types/api/models/AesEncryptionResponse.ts b/clients/admin-ui/src/types/api/models/AesEncryptionResponse.ts index 56310f75e47..e49b2ff416c 100644 --- a/clients/admin-ui/src/types/api/models/AesEncryptionResponse.ts +++ b/clients/admin-ui/src/types/api/models/AesEncryptionResponse.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AesEncryptionResponse + * * Specifies fields returned from the AES Encryption endpoint */ export type AesEncryptionResponse = { + /** + * Encrypted Value + */ encrypted_value: string; + /** + * Nonce + */ nonce: string; }; diff --git a/clients/admin-ui/src/types/api/models/AlertLevel.ts b/clients/admin-ui/src/types/api/models/AlertLevel.ts index 451254ce5c7..90f74c41397 100644 --- a/clients/admin-ui/src/types/api/models/AlertLevel.ts +++ b/clients/admin-ui/src/types/api/models/AlertLevel.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * AlertLevel + */ export enum AlertLevel { ALERT = "alert", OK = "ok", diff --git a/clients/admin-ui/src/types/api/models/AllowList.ts b/clients/admin-ui/src/types/api/models/AllowList.ts index db285579797..bbf77761343 100644 --- a/clients/admin-ui/src/types/api/models/AllowList.ts +++ b/clients/admin-ui/src/types/api/models/AllowList.ts @@ -1,10 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * AllowList + */ export type AllowList = { + /** + * Name + */ name?: string | null; + /** + * Description + */ description?: string | null; + /** + * Allowed Values + */ allowed_values?: Array | null; + /** + * Id + */ id?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/AllowListUpdate.ts b/clients/admin-ui/src/types/api/models/AllowListUpdate.ts index e96b5f759e2..e0d018e09a7 100644 --- a/clients/admin-ui/src/types/api/models/AllowListUpdate.ts +++ b/clients/admin-ui/src/types/api/models/AllowListUpdate.ts @@ -1,10 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * AllowListUpdate + */ export type AllowListUpdate = { + /** + * Name + */ name: string; + /** + * Description + */ description?: string | null; + /** + * Allowed Values + */ allowed_values: Array; + /** + * Id + */ id?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/AllowedActionsResponse.ts b/clients/admin-ui/src/types/api/models/AllowedActionsResponse.ts index 8bda82dc4e0..24c0053fc34 100644 --- a/clients/admin-ui/src/types/api/models/AllowedActionsResponse.ts +++ b/clients/admin-ui/src/types/api/models/AllowedActionsResponse.ts @@ -1,14 +1,26 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { FieldActionType } from "./FieldActionType"; +import { DiffStatus } from "./DiffStatus"; +import { FieldActionType } from "./FieldActionType"; /** + * AllowedActionsResponse + * * Response for the allowed actions endpoint with strongly-typed action types. */ export type AllowedActionsResponse = { + /** + * Allowed Actions + */ allowed_actions: Array; - diff_statuses_with_counts: Record; + /** + * Diff Statuses With Counts + */ + diff_statuses_with_counts: { + [key in DiffStatus]?: number; + }; + /** + * Field Count + */ field_count: number; }; diff --git a/clients/admin-ui/src/types/api/models/AllowedTypes.ts b/clients/admin-ui/src/types/api/models/AllowedTypes.ts index 1e1d6e0f3d7..7f2680b02f7 100644 --- a/clients/admin-ui/src/types/api/models/AllowedTypes.ts +++ b/clients/admin-ui/src/types/api/models/AllowedTypes.ts @@ -1,11 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AllowedTypes + * * Allowed types for custom field. */ export enum AllowedTypes { STRING = "string", - STRING_ = "string[]", + STRING = "string[]", } diff --git a/clients/admin-ui/src/types/api/models/ApplicationStatus.ts b/clients/admin-ui/src/types/api/models/ApplicationStatus.ts index a6eed5d9812..d8dc27bf66e 100644 --- a/clients/admin-ui/src/types/api/models/ApplicationStatus.ts +++ b/clients/admin-ui/src/types/api/models/ApplicationStatus.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ApplicationStatus + * * Application lifecycle status values. */ export enum ApplicationStatus { diff --git a/clients/admin-ui/src/types/api/models/AssessmentResponse.ts b/clients/admin-ui/src/types/api/models/AssessmentResponse.ts index 63f302cd2d4..4eefe3cb2a2 100644 --- a/clients/admin-ui/src/types/api/models/AssessmentResponse.ts +++ b/clients/admin-ui/src/types/api/models/AssessmentResponse.ts @@ -1,26 +1,77 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AssessmentResponse + * * Response schema for privacy assessments in list views. */ export type AssessmentResponse = { + /** + * Id + */ id: string; + /** + * Template Id + */ template_id: string; + /** + * Template Name + */ template_name?: string | null; + /** + * Name + */ name: string; + /** + * Status + */ status: string; + /** + * Completeness + */ completeness?: number; + /** + * Risk Level + */ risk_level?: string | null; + /** + * System Fides Key + */ system_fides_key?: string | null; + /** + * System Name + */ system_name?: string | null; + /** + * Declaration Id + */ declaration_id?: string | null; + /** + * Declaration Name + */ declaration_name?: string | null; + /** + * Data Use + */ data_use?: string | null; + /** + * Data Use Name + */ data_use_name?: string | null; + /** + * Data Categories + */ data_categories?: Array; + /** + * Created By + */ created_by?: string | null; + /** + * Created At + */ created_at?: string | null; + /** + * Updated At + */ updated_at?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/AssessmentTaskResponse.ts b/clients/admin-ui/src/types/api/models/AssessmentTaskResponse.ts new file mode 100644 index 00000000000..f91986ce8a7 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/AssessmentTaskResponse.ts @@ -0,0 +1,75 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { AssessmentTaskSystemInfo } from "./AssessmentTaskSystemInfo"; + +/** + * AssessmentTaskResponse + * + * Response schema for privacy assessment task status. + */ +export type AssessmentTaskResponse = { + /** + * Id + */ + id: string; + /** + * Action Type + */ + action_type: string; + /** + * Status + */ + status: string; + /** + * Total Count + */ + total_count?: number; + /** + * Completed Count + */ + completed_count?: number; + /** + * Progress + */ + progress?: number; + /** + * Message + */ + message?: string | null; + /** + * Assessment Types + */ + assessment_types?: Array; + /** + * System Fides Keys + */ + system_fides_keys?: Array | null; + /** + * Systems + */ + systems?: Array | null; + /** + * Created By + */ + created_by?: string | null; + /** + * Use Llm + */ + use_llm?: boolean; + /** + * Llm Model + */ + llm_model?: string | null; + /** + * Assessment Ids + */ + assessment_ids?: Array; + /** + * Created At + */ + created_at?: string | null; + /** + * Updated At + */ + updated_at?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/AssessmentTaskSystemInfo.ts b/clients/admin-ui/src/types/api/models/AssessmentTaskSystemInfo.ts new file mode 100644 index 00000000000..847724ce0df --- /dev/null +++ b/clients/admin-ui/src/types/api/models/AssessmentTaskSystemInfo.ts @@ -0,0 +1,17 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * AssessmentTaskSystemInfo + * + * Minimal system info returned in task responses. + */ +export type AssessmentTaskSystemInfo = { + /** + * Fides Key + */ + fides_key: string; + /** + * Name + */ + name: string; +}; diff --git a/clients/admin-ui/src/types/api/models/Asset.ts b/clients/admin-ui/src/types/api/models/Asset.ts index 88d0eef2d8b..9b92d6ad24c 100644 --- a/clients/admin-ui/src/types/api/models/Asset.ts +++ b/clients/admin-ui/src/types/api/models/Asset.ts @@ -1,28 +1,72 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConsentStatus } from "./ConsentStatus"; +import { ConsentStatus } from "./ConsentStatus"; /** + * Asset + * * Schema for asset responses */ export type Asset = { + /** + * Data Uses + */ data_uses?: Array; + /** + * Description + */ description?: string | null; /** - * Human-readable duration for which this asset persists (e.g., cookie lifetime) + * Duration */ duration?: string | null; + /** + * Name + */ name: string; + /** + * Asset Type + */ asset_type: string; + /** + * Domain + */ domain?: string | null; + /** + * Base Url + */ base_url?: string | null; + /** + * Locations + */ locations?: Array; + /** + * Id + */ id: string; + /** + * System Id + */ system_id: string; + /** + * System Name + */ + system_name?: string | null; + /** + * System Fides Key + */ + system_fides_key?: string | null; + /** + * Parent + */ parent?: Array; + /** + * Parent Domain + */ parent_domain?: string | null; consent_status?: ConsentStatus; + /** + * Page + */ page?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/AssetCreate.ts b/clients/admin-ui/src/types/api/models/AssetCreate.ts index 7f1374bb8e9..eb7f94c0052 100644 --- a/clients/admin-ui/src/types/api/models/AssetCreate.ts +++ b/clients/admin-ui/src/types/api/models/AssetCreate.ts @@ -1,20 +1,41 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AssetCreate + * * Schema for creating a new asset with immutable fields */ export type AssetCreate = { + /** + * Data Uses + */ data_uses?: Array; + /** + * Description + */ description?: string | null; /** - * Human-readable duration for which this asset persists (e.g., cookie lifetime) + * Duration */ duration?: string | null; + /** + * Name + */ name: string; + /** + * Asset Type + */ asset_type: string; + /** + * Domain + */ domain?: string | null; + /** + * Base Url + */ base_url?: string | null; + /** + * Locations + */ locations?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/AssetReportingFilters.ts b/clients/admin-ui/src/types/api/models/AssetReportingFilters.ts new file mode 100644 index 00000000000..7ea388fff44 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/AssetReportingFilters.ts @@ -0,0 +1,29 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * AssetReportingFilters + * + * Schema for asset reporting filter options. + */ +export type AssetReportingFilters = { + /** + * Asset Type + */ + asset_type?: Array | null; + /** + * Consent Status + */ + consent_status?: Array | null; + /** + * System Id + */ + system_id?: Array | null; + /** + * Data Uses + */ + data_uses?: Array | null; + /** + * Locations + */ + locations?: Array | null; +}; diff --git a/clients/admin-ui/src/types/api/models/AssetUpdate.ts b/clients/admin-ui/src/types/api/models/AssetUpdate.ts index c7a4618c1a3..44612934d67 100644 --- a/clients/admin-ui/src/types/api/models/AssetUpdate.ts +++ b/clients/admin-ui/src/types/api/models/AssetUpdate.ts @@ -1,19 +1,34 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AssetUpdate + * * Schema for updating an asset's mutable fields. * Changing any other fields would effectively create a new asset */ export type AssetUpdate = { + /** + * Data Uses + */ data_uses?: Array | null; + /** + * Description + */ description?: string | null; /** - * Human-readable duration for which this asset persists (e.g., cookie lifetime) + * Duration */ duration?: string | null; + /** + * Id + */ id: string; + /** + * System Key + */ system_key?: string | null; + /** + * System Id + */ system_id?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/AssignStewardRequest.ts b/clients/admin-ui/src/types/api/models/AssignStewardRequest.ts new file mode 100644 index 00000000000..e1d04cf30ab --- /dev/null +++ b/clients/admin-ui/src/types/api/models/AssignStewardRequest.ts @@ -0,0 +1,17 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * AssignStewardRequest + * + * Request schema for assigning a data steward to one or more systems. + */ +export type AssignStewardRequest = { + /** + * Data Steward + */ + data_steward: string; + /** + * System Keys + */ + system_keys: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/AssignedUserSummary.ts b/clients/admin-ui/src/types/api/models/AssignedUserSummary.ts index a9b1f47e3fb..08560d5ba26 100644 --- a/clients/admin-ui/src/types/api/models/AssignedUserSummary.ts +++ b/clients/admin-ui/src/types/api/models/AssignedUserSummary.ts @@ -1,24 +1,32 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AssignedUserSummary + * * Minimal user information for manual task assignment list. */ export type AssignedUserSummary = { /** + * Id + * * User ID */ id: string; /** + * Email Address + * * Email Address */ email_address?: string | null; /** + * First Name + * * First name */ first_name?: string | null; /** + * Last Name + * * Last name */ last_name?: string | null; diff --git a/clients/admin-ui/src/types/api/models/AsyncConfig.ts b/clients/admin-ui/src/types/api/models/AsyncConfig.ts deleted file mode 100644 index 20f5d8dbbe9..00000000000 --- a/clients/admin-ui/src/types/api/models/AsyncConfig.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { AsyncStrategy } from "./AsyncStrategy"; - -/** - * Async config only has strategy for now, but could be - * extended with other configuration options when we add polling - */ -export type AsyncConfig = { - strategy: AsyncStrategy; -}; diff --git a/clients/admin-ui/src/types/api/models/AsyncStrategy.ts b/clients/admin-ui/src/types/api/models/AsyncStrategy.ts deleted file mode 100644 index 4b1cf0946cb..00000000000 --- a/clients/admin-ui/src/types/api/models/AsyncStrategy.ts +++ /dev/null @@ -1,11 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -/** - * Async strategies: supports callback for now, but could be - * extended to polling as well in the future - */ -export enum AsyncStrategy { - CALLBACK = "callback", -} diff --git a/clients/admin-ui/src/types/api/models/AttachmentResponse.ts b/clients/admin-ui/src/types/api/models/AttachmentResponse.ts index a9b870b2027..37d3e5856f4 100644 --- a/clients/admin-ui/src/types/api/models/AttachmentResponse.ts +++ b/clients/admin-ui/src/types/api/models/AttachmentResponse.ts @@ -1,48 +1,68 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** - * Schema and helper functionality for AttachmentResponse objects stored in the AttachmentResponse table. + * AttachmentResponse + * + * Schema for attachment responses returned by the API. */ export type AttachmentResponse = { /** + * Id + * * The attachment ID */ id: string; /** + * User Id + * * The user ID */ user_id: string | null; /** + * Username + * * The user name */ username: string; /** + * User First Name + * * The user first name */ user_first_name: string | null; /** + * User Last Name + * * The user last name */ user_last_name: string | null; /** + * File Name + * * The attachment name */ file_name: string; /** + * Attachment Type + * * The attachment type */ attachment_type: string; /** + * Retrieved Attachment Size + * * The size of the attachment */ retrieved_attachment_size: number | null; /** + * Retrieved Attachment Url + * * The URL to retrieve the attachment */ - retrieved_attachment_url: string | null; + retrieved_attachment_url: string | string | null; /** + * Created At + * * The creation date */ created_at: string; diff --git a/clients/admin-ui/src/types/api/models/AttachmentType.ts b/clients/admin-ui/src/types/api/models/AttachmentType.ts index 08d661681b4..2bc27f53cb0 100644 --- a/clients/admin-ui/src/types/api/models/AttachmentType.ts +++ b/clients/admin-ui/src/types/api/models/AttachmentType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AttachmentType + * * Enum for attachment types. Indicates attachment usage. */ export enum AttachmentType { diff --git a/clients/admin-ui/src/types/api/models/AuditLogAction.ts b/clients/admin-ui/src/types/api/models/AuditLogAction.ts index 93c174ef924..ef35e56b180 100644 --- a/clients/admin-ui/src/types/api/models/AuditLogAction.ts +++ b/clients/admin-ui/src/types/api/models/AuditLogAction.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AuditLogAction + * * Enum for audit log actions, reflecting what a user did. */ export enum AuditLogAction { @@ -10,4 +10,5 @@ export enum AuditLogAction { DENIED = "denied", EMAIL_SENT = "email_sent", FINISHED = "finished", + POLICY_EVALUATED = "policy_evaluated", } diff --git a/clients/admin-ui/src/types/api/models/AuthenticationMethods.ts b/clients/admin-ui/src/types/api/models/AuthenticationMethods.ts index d439f0da4ff..80b0450a58c 100644 --- a/clients/admin-ui/src/types/api/models/AuthenticationMethods.ts +++ b/clients/admin-ui/src/types/api/models/AuthenticationMethods.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AuthenticationMethods + * * Schema for reporting which authentication methods are enabled. */ export type AuthenticationMethods = { + /** + * Username Password + */ username_password: boolean; + /** + * Sso + */ sso: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/AuthenticationProtocol.ts b/clients/admin-ui/src/types/api/models/AuthenticationProtocol.ts index e516ac79e87..7df18cd21a3 100644 --- a/clients/admin-ui/src/types/api/models/AuthenticationProtocol.ts +++ b/clients/admin-ui/src/types/api/models/AuthenticationProtocol.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * AuthenticationProtocol + * * Authentication protocol types supported by identity providers. */ export enum AuthenticationProtocol { diff --git a/clients/admin-ui/src/types/api/models/BackfillRequest.ts b/clients/admin-ui/src/types/api/models/BackfillRequest.ts new file mode 100644 index 00000000000..61e554a86dd --- /dev/null +++ b/clients/admin-ui/src/types/api/models/BackfillRequest.ts @@ -0,0 +1,21 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * BackfillRequest + * + * Request body for triggering a database backfill operation. + */ +export type BackfillRequest = { + /** + * Batch Size + * + * Number of rows to update per batch (default: 5000) + */ + batch_size?: number; + /** + * Batch Delay Seconds + * + * Delay between batches in seconds (default: 1.0) + */ + batch_delay_seconds?: number; +}; diff --git a/clients/admin-ui/src/types/api/models/BackfillStatusResponse.ts b/clients/admin-ui/src/types/api/models/BackfillStatusResponse.ts new file mode 100644 index 00000000000..966ee1801cb --- /dev/null +++ b/clients/admin-ui/src/types/api/models/BackfillStatusResponse.ts @@ -0,0 +1,23 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * BackfillStatusResponse + * + * Response body for backfill status endpoint. + */ +export type BackfillStatusResponse = { + /** + * Is Running + * + * Whether a backfill is currently running + */ + is_running: boolean; + /** + * Pending Count + * + * Count of rows pending backfill, keyed by backfill task name + */ + pending_count: { + [key: string]: number; + }; +}; diff --git a/clients/admin-ui/src/types/api/models/BaseStagedResourcesRequest.ts b/clients/admin-ui/src/types/api/models/BaseStagedResourcesRequest.ts index 224e3497ff9..118b682102f 100644 --- a/clients/admin-ui/src/types/api/models/BaseStagedResourcesRequest.ts +++ b/clients/admin-ui/src/types/api/models/BaseStagedResourcesRequest.ts @@ -1,12 +1,14 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * BaseStagedResourcesRequest + * * Request model for bulk operations on staged resources */ export type BaseStagedResourcesRequest = { /** + * Staged Resource Urns + * * List of staged resource URNs to act on */ staged_resource_urns: Array; diff --git a/clients/admin-ui/src/types/api/models/BasicMessagingTemplateRequest.ts b/clients/admin-ui/src/types/api/models/BasicMessagingTemplateRequest.ts index 13d2c1b0ed9..0c8267f5c28 100644 --- a/clients/admin-ui/src/types/api/models/BasicMessagingTemplateRequest.ts +++ b/clients/admin-ui/src/types/api/models/BasicMessagingTemplateRequest.ts @@ -1,8 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * BasicMessagingTemplateRequest + */ export type BasicMessagingTemplateRequest = { + /** + * Type + */ type: string; - content: any; + /** + * Content + */ + content: { + [key: string]: unknown; + }; }; diff --git a/clients/admin-ui/src/types/api/models/BasicMessagingTemplateResponse.ts b/clients/admin-ui/src/types/api/models/BasicMessagingTemplateResponse.ts index 9a74d6b6891..8cc9bc42693 100644 --- a/clients/admin-ui/src/types/api/models/BasicMessagingTemplateResponse.ts +++ b/clients/admin-ui/src/types/api/models/BasicMessagingTemplateResponse.ts @@ -1,9 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * BasicMessagingTemplateResponse + */ export type BasicMessagingTemplateResponse = { + /** + * Type + */ type: string; - content: any; + /** + * Content + */ + content: { + [key: string]: unknown; + }; + /** + * Label + */ label: string; }; diff --git a/clients/admin-ui/src/types/api/models/BasicSystemResponseExtended.ts b/clients/admin-ui/src/types/api/models/BasicSystemResponseExtended.ts index 8c9268299c6..dc70cd89118 100644 --- a/clients/admin-ui/src/types/api/models/BasicSystemResponseExtended.ts +++ b/clients/admin-ui/src/types/api/models/BasicSystemResponseExtended.ts @@ -1,15 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { DataFlow } from "./DataFlow"; -import type { DataResponsibilityTitle } from "./DataResponsibilityTitle"; -import type { LegalBasisForProfilingEnum } from "./LegalBasisForProfilingEnum"; +import { DataResponsibilityTitle } from "./DataResponsibilityTitle"; +import { LegalBasisForProfilingEnum } from "./LegalBasisForProfilingEnum"; import type { PrivacyDeclaration } from "./PrivacyDeclaration"; import type { SystemMetadata } from "./SystemMetadata"; import type { UserResponse } from "./UserResponse"; /** + * BasicSystemResponseExtended + * * Extended version of BasicSystemResponse that includes system group information. * * This response model automatically extracts system group information from the @@ -17,26 +17,41 @@ import type { UserResponse } from "./UserResponse"; */ export type BasicSystemResponseExtended = { /** + * Fides Key + * * A unique key used to identify this resource. */ fides_key: string; /** + * Organization Fides Key + * * Defines the Organization that this resource belongs to. */ organization_fides_key?: string; + /** + * Tags + */ tags?: Array | null; /** + * Name + * * Human-Readable name for this resource. */ name?: string | null; /** + * Description + * * A detailed description of what this resource is. */ description?: string | null; /** + * Meta + * * An optional property to store any extra information for a resource. Data can be structured in any way: simple set of `key: value` pairs or deeply nested objects. */ - meta?: null; + meta?: { + [key: string]: unknown; + } | null; /** * * The SystemMetadata resource model. @@ -46,18 +61,26 @@ export type BasicSystemResponseExtended = { */ fidesctl_meta?: SystemMetadata | null; /** + * System Type + * * A required value to describe the type of system being modeled, examples include: Service, Application, Third Party, etc. */ system_type: string; /** + * Egress + * * The resources to which the system sends data. */ egress?: Array | null; /** + * Ingress + * * The resources from which the system receives data. */ ingress?: Array | null; /** + * Privacy Declarations + * * * The PrivacyDeclaration resource model. * @@ -67,78 +90,116 @@ export type BasicSystemResponseExtended = { */ privacy_declarations: Array; /** + * Administrating Department + * * An optional value to identify the owning department or group of the system within your organization */ administrating_department?: string | null; /** + * Vendor Id + * * The unique identifier for the vendor that's associated with this system. */ vendor_id?: string | null; /** + * Previous Vendor Id + * * If specified, the unique identifier for the vendor that was previously associated with this system. */ previous_vendor_id?: string | null; /** + * Vendor Deleted Date + * * The deleted date of the vendor that's associated with this system. */ vendor_deleted_date?: string | null; /** + * Dataset References + * * Referenced Dataset fides keys used by the system. */ dataset_references?: Array; /** + * Processes Personal Data + * * This toggle indicates whether the system stores or processes personal data. */ processes_personal_data?: boolean; /** + * Exempt From Privacy Regulations + * * This toggle indicates whether the system is exempt from privacy regulation if they do process personal data. */ exempt_from_privacy_regulations?: boolean; /** + * Reason For Exemption + * * The reason that the system is exempt from privacy regulation. */ reason_for_exemption?: string | null; /** + * Uses Profiling + * * Whether the vendor uses data to profile a consumer in a way that has a legal effect. */ uses_profiling?: boolean; /** + * Legal Basis For Profiling + * * The legal basis (or bases) for performing profiling that has a legal effect. */ legal_basis_for_profiling?: Array; /** + * Does International Transfers + * * Whether this system transfers data to other countries or international organizations. */ does_international_transfers?: boolean; /** + * Legal Basis For Transfers + * * The legal basis (or bases) under which the data is transferred. */ legal_basis_for_transfers?: Array; /** + * Requires Data Protection Assessments + * * Whether this system requires data protection impact assessments. */ requires_data_protection_assessments?: boolean; /** + * Dpa Location + * * Location where the DPAs or DIPAs can be found. */ dpa_location?: string | null; /** + * Dpa Progress + * * The optional status of a Data Protection Impact Assessment */ dpa_progress?: string | null; /** + * Privacy Policy + * * A URL that points to the system's publicly accessible privacy policy. */ privacy_policy?: string | null; /** + * Legal Name + * * The legal name for the business represented by the system. */ legal_name?: string | null; /** + * Legal Address + * * The legal address for the business represented by the system. */ legal_address?: string | null; /** + * Responsibility + * * * The model defining the responsibility or role over * the system that processes personal data. @@ -149,43 +210,66 @@ export type BasicSystemResponseExtended = { */ responsibility?: Array; /** + * Dpo + * * The official privacy contact address or DPO. */ dpo?: string | null; /** + * Joint Controller Info + * * The party or parties that share the responsibility for processing personal data. */ joint_controller_info?: string | null; /** + * Data Security Practices + * * The data security practices employed by this system. */ data_security_practices?: string | null; /** + * Cookie Max Age Seconds + * * The maximum storage duration, in seconds, for cookies used by this system. */ cookie_max_age_seconds?: number | null; /** + * Uses Cookies + * * Whether this system uses cookie storage. */ uses_cookies?: boolean; /** + * Cookie Refresh + * * Whether the system's cookies are refreshed after being initially set. */ cookie_refresh?: boolean; /** + * Uses Non Cookie Access + * * Whether the system uses non-cookie methods of storage or accessing information stored on a user's device. */ uses_non_cookie_access?: boolean; /** + * Legitimate Interest Disclosure Url + * * A URL that points to the system's publicly accessible legitimate interest disclosure. */ legitimate_interest_disclosure_url?: string | null; + /** + * Created At + */ created_at: string; /** + * System Groups + * * List of system group fides_keys this system belongs to */ system_groups?: Array; /** + * Data Stewards + * * List of data stewards assigned to this system */ data_stewards?: Array; diff --git a/clients/admin-ui/src/types/api/models/BedrockConnectionTestRequest.ts b/clients/admin-ui/src/types/api/models/BedrockConnectionTestRequest.ts new file mode 100644 index 00000000000..e3b7559169f --- /dev/null +++ b/clients/admin-ui/src/types/api/models/BedrockConnectionTestRequest.ts @@ -0,0 +1,35 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * BedrockConnectionTestRequest + * + * Request schema for AWS Bedrock connection test. + */ +export type BedrockConnectionTestRequest = { + /** + * Aws Region + */ + aws_region: string; + /** + * Model + * + * Bedrock model string + */ + model: string; + /** + * Aws Bearer Token Bedrock + */ + aws_bearer_token_bedrock?: string | null; + /** + * Aws Role Arn + */ + aws_role_arn?: string | null; + /** + * Aws Web Identity Token + */ + aws_web_identity_token?: string | null; + /** + * Aws Role Session Name + */ + aws_role_session_name?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/BedrockConnectionTestResponse.ts b/clients/admin-ui/src/types/api/models/BedrockConnectionTestResponse.ts new file mode 100644 index 00000000000..523b50f73f6 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/BedrockConnectionTestResponse.ts @@ -0,0 +1,47 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * BedrockConnectionTestResponse + * + * Response schema for AWS Bedrock connection test. + */ +export type BedrockConnectionTestResponse = { + /** + * Success + * + * Whether the connection test was successful + */ + success: boolean; + /** + * Message + * + * Human-readable message about the test result + */ + message: string; + /** + * Response Content + * + * Content returned by the model during test + */ + response_content?: string | null; + /** + * Model + * + * Model that was tested + */ + model: string; + /** + * Usage + * + * Token usage information from the test + */ + usage?: { + [key: string]: unknown; + } | null; + /** + * Error Type + * + * Type of error if the test failed + */ + error_type?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/BenchmarkStatus.ts b/clients/admin-ui/src/types/api/models/BenchmarkStatus.ts new file mode 100644 index 00000000000..5b7367d3687 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/BenchmarkStatus.ts @@ -0,0 +1,12 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * BenchmarkStatus + * + * Status values for classification benchmarks. + */ +export enum BenchmarkStatus { + COMPLETED = "completed", + FAILED = "failed", + PENDING = "pending", +} diff --git a/clients/admin-ui/src/types/api/models/BigQueryConfig.ts b/clients/admin-ui/src/types/api/models/BigQueryConfig.ts index c3016a17250..eb643b3d454 100644 --- a/clients/admin-ui/src/types/api/models/BigQueryConfig.ts +++ b/clients/admin-ui/src/types/api/models/BigQueryConfig.ts @@ -1,13 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { fides__connectors__models__KeyfileCreds } from "./fides__connectors__models__KeyfileCreds"; /** + * BigQueryConfig + * * The model for the connection config for BigQuery */ export type BigQueryConfig = { + /** + * Dataset + */ dataset?: string | null; keyfile_creds: fides__connectors__models__KeyfileCreds; }; diff --git a/clients/admin-ui/src/types/api/models/BigQueryDocsSchema.ts b/clients/admin-ui/src/types/api/models/BigQueryDocsSchema.ts index 7146aced8b5..3a9d2977b89 100644 --- a/clients/admin-ui/src/types/api/models/BigQueryDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/BigQueryDocsSchema.ts @@ -1,18 +1,22 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds } from "./fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds"; /** + * BigQueryDocsSchema + * * BigQuery Secrets Schema for API Docs */ export type BigQueryDocsSchema = { /** + * Keyfile creds + * * The contents of the key file that contains authentication credentials for a service account in GCP. */ keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds; /** + * Dataset + * * Only provide a dataset to scope discovery monitors and privacy request automation to a specific BigQuery dataset. In most cases, this can be left blank. */ dataset?: string | null; diff --git a/clients/admin-ui/src/types/api/models/BigQueryMonitorConfig.ts b/clients/admin-ui/src/types/api/models/BigQueryMonitorConfig.ts new file mode 100644 index 00000000000..e534f53d460 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/BigQueryMonitorConfig.ts @@ -0,0 +1,30 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { fidesplus__cls__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds } from "./fidesplus__cls__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds"; + +/** + * BigQueryMonitorConfig + * + * BigQuery monitor configuration. + * + * Simplified seed input for creating a BigQuery discovery monitor. + * See also: EditableMonitorConfig, MonitorClassifyParams, BigQuerySchema. + */ +export type BigQueryMonitorConfig = { + /** + * BigQuery keyfile credentials (JSON string or object) + */ + keyfile_creds: fidesplus__cls__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds; + /** + * System Key + * + * System key to link the connection to + */ + system_key?: string; + /** + * Execute After Creation + * + * Execute the monitor after creation + */ + execute_after_creation?: boolean; +}; diff --git a/clients/admin-ui/src/types/api/models/BigQueryMonitorParams.ts b/clients/admin-ui/src/types/api/models/BigQueryMonitorParams.ts index 460e8471fa4..95facf85240 100644 --- a/clients/admin-ui/src/types/api/models/BigQueryMonitorParams.ts +++ b/clients/admin-ui/src/types/api/models/BigQueryMonitorParams.ts @@ -1,9 +1,12 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * BigQueryMonitorParams + */ export type BigQueryMonitorParams = { /** + * Sharded Table Pattern + * * Regex pattern to identify sharded tables */ sharded_table_pattern?: string | null; diff --git a/clients/admin-ui/src/types/api/models/Body_Update_tagging_instructions_api_v1_data_category__fides_key__tagging_instructions_patch.ts b/clients/admin-ui/src/types/api/models/Body_Update_tagging_instructions_api_v1_data_category__fides_key__tagging_instructions_patch.ts new file mode 100644 index 00000000000..f2c17a493d9 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/Body_Update_tagging_instructions_api_v1_data_category__fides_key__tagging_instructions_patch.ts @@ -0,0 +1,12 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * Body_Update_tagging_instructions_api_v1_data_category__fides_key__tagging_instructions_patch + */ +export type Body_Update_tagging_instructions_api_v1_data_category__fides_key__tagging_instructions_patch = + { + /** + * Tagging Instructions + */ + tagging_instructions: string; + }; diff --git a/clients/admin-ui/src/types/api/models/Body_acquire_access_token_api_v1_oauth_token_post.ts b/clients/admin-ui/src/types/api/models/Body_acquire_access_token_api_v1_oauth_token_post.ts index 8e03bb71ade..f314d3f7426 100644 --- a/clients/admin-ui/src/types/api/models/Body_acquire_access_token_api_v1_oauth_token_post.ts +++ b/clients/admin-ui/src/types/api/models/Body_acquire_access_token_api_v1_oauth_token_post.ts @@ -1,10 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * Body_acquire_access_token_api_v1_oauth_token_post + */ export type Body_acquire_access_token_api_v1_oauth_token_post = { + /** + * Grant Type + */ grant_type?: string; + /** + * Scope + */ scope?: string; + /** + * Client Id + */ client_id?: string | null; + /** + * Client Secret + */ client_secret?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment__comment_id__attachment_post.ts b/clients/admin-ui/src/types/api/models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment__comment_id__attachment_post.ts index 16e20aa62b3..93188d601a1 100644 --- a/clients/admin-ui/src/types/api/models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment__comment_id__attachment_post.ts +++ b/clients/admin-ui/src/types/api/models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment__comment_id__attachment_post.ts @@ -1,11 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AttachmentType } from "./AttachmentType"; +import { AttachmentType } from "./AttachmentType"; +/** + * Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment__comment_id__attachment_post + */ export type Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment__comment_id__attachment_post = { attachment_type: AttachmentType; - files?: Array; + /** + * Files + */ + files?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__comment__comment_id__attachment_post.ts b/clients/admin-ui/src/types/api/models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__comment__comment_id__attachment_post.ts index cd39a4a3e0f..3f05b191dc7 100644 --- a/clients/admin-ui/src/types/api/models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__comment__comment_id__attachment_post.ts +++ b/clients/admin-ui/src/types/api/models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__comment__comment_id__attachment_post.ts @@ -1,11 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AttachmentType } from "./AttachmentType"; +import { AttachmentType } from "./AttachmentType"; +/** + * Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__comment__comment_id__attachment_post + */ export type Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__comment__comment_id__attachment_post = { attachment_type: AttachmentType; - files?: Array; + /** + * Files + */ + files?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment__comment_id__attachment_post.ts b/clients/admin-ui/src/types/api/models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment__comment_id__attachment_post.ts index 1eaf5874860..0eac630b100 100644 --- a/clients/admin-ui/src/types/api/models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment__comment_id__attachment_post.ts +++ b/clients/admin-ui/src/types/api/models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment__comment_id__attachment_post.ts @@ -1,11 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AttachmentType } from "./AttachmentType"; +import { AttachmentType } from "./AttachmentType"; +/** + * Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment__comment_id__attachment_post + */ export type Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment__comment_id__attachment_post = { attachment_type: AttachmentType; - files?: Array; + /** + * Files + */ + files?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__attachment_post.ts b/clients/admin-ui/src/types/api/models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__attachment_post.ts index eca2039fc45..cd96c495df9 100644 --- a/clients/admin-ui/src/types/api/models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__attachment_post.ts +++ b/clients/admin-ui/src/types/api/models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__attachment_post.ts @@ -1,11 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AttachmentType } from "./AttachmentType"; +import { AttachmentType } from "./AttachmentType"; +/** + * Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__attachment_post + */ export type Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__attachment_post = { attachment_type: AttachmentType; - attachment_file: Blob; + /** + * Attachment File + */ + attachment_file: Blob | File; }; diff --git a/clients/admin-ui/src/types/api/models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__attachment_post.ts b/clients/admin-ui/src/types/api/models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__attachment_post.ts index bc949d18d09..b17e3f76615 100644 --- a/clients/admin-ui/src/types/api/models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__attachment_post.ts +++ b/clients/admin-ui/src/types/api/models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__attachment_post.ts @@ -1,11 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AttachmentType } from "./AttachmentType"; +import { AttachmentType } from "./AttachmentType"; +/** + * Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__attachment_post + */ export type Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__attachment_post = { attachment_type: AttachmentType; - attachment_file: Blob; + /** + * Attachment File + */ + attachment_file: Blob | File; }; diff --git a/clients/admin-ui/src/types/api/models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__attachment_post.ts b/clients/admin-ui/src/types/api/models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__attachment_post.ts index b228f95fb54..8aa49a618ad 100644 --- a/clients/admin-ui/src/types/api/models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__attachment_post.ts +++ b/clients/admin-ui/src/types/api/models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__attachment_post.ts @@ -1,11 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AttachmentType } from "./AttachmentType"; +import { AttachmentType } from "./AttachmentType"; +/** + * Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__attachment_post + */ export type Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__attachment_post = { attachment_type: AttachmentType; - attachment_file: Blob; + /** + * Attachment File + */ + attachment_file: Blob | File; }; diff --git a/clients/admin-ui/src/types/api/models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment_post.ts b/clients/admin-ui/src/types/api/models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment_post.ts index 76ba545fcc2..f76424f5c5c 100644 --- a/clients/admin-ui/src/types/api/models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment_post.ts +++ b/clients/admin-ui/src/types/api/models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment_post.ts @@ -1,14 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AttachmentType } from "./AttachmentType"; -import type { CommentType } from "./CommentType"; +import { AttachmentType } from "./AttachmentType"; +import { CommentType } from "./CommentType"; +/** + * Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment_post + */ export type Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment_post = { + /** + * Comment Text + */ comment_text: string; comment_type: CommentType; attachment_type?: AttachmentType; - files?: Array; + /** + * Files + */ + files?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__comment_post.ts b/clients/admin-ui/src/types/api/models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__comment_post.ts index 2fef4454559..e0e5f5351d9 100644 --- a/clients/admin-ui/src/types/api/models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__comment_post.ts +++ b/clients/admin-ui/src/types/api/models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__comment_post.ts @@ -1,14 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AttachmentType } from "./AttachmentType"; -import type { CommentType } from "./CommentType"; +import { AttachmentType } from "./AttachmentType"; +import { CommentType } from "./CommentType"; +/** + * Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__comment_post + */ export type Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__comment_post = { + /** + * Comment Text + */ comment_text: string; comment_type: CommentType; attachment_type?: AttachmentType; - files?: Array; + /** + * Files + */ + files?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment_post.ts b/clients/admin-ui/src/types/api/models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment_post.ts index 90031cd0018..43f5daccdb9 100644 --- a/clients/admin-ui/src/types/api/models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment_post.ts +++ b/clients/admin-ui/src/types/api/models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment_post.ts @@ -1,14 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AttachmentType } from "./AttachmentType"; -import type { CommentType } from "./CommentType"; +import { AttachmentType } from "./AttachmentType"; +import { CommentType } from "./CommentType"; +/** + * Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment_post + */ export type Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment_post = { + /** + * Comment Text + */ comment_text: string; comment_type: CommentType; attachment_type?: AttachmentType; - files?: Array; + /** + * Files + */ + files?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/Body_export_minimal_datamap_with_format_api_v1_plus_datamap_minimal__export_format__post.ts b/clients/admin-ui/src/types/api/models/Body_export_minimal_datamap_with_format_api_v1_plus_datamap_minimal__export_format__post.ts index 885603a40cb..bdcd4f8e557 100644 --- a/clients/admin-ui/src/types/api/models/Body_export_minimal_datamap_with_format_api_v1_plus_datamap_minimal__export_format__post.ts +++ b/clients/admin-ui/src/types/api/models/Body_export_minimal_datamap_with_format_api_v1_plus_datamap_minimal__export_format__post.ts @@ -1,9 +1,10 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { CustomReportCreate } from "./CustomReportCreate"; +/** + * Body_export_minimal_datamap_with_format_api_v1_plus_datamap_minimal__export_format__post + */ export type Body_export_minimal_datamap_with_format_api_v1_plus_datamap_minimal__export_format__post = { report?: CustomReportCreate | null; diff --git a/clients/admin-ui/src/types/api/models/Body_skip_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__skip_post.ts b/clients/admin-ui/src/types/api/models/Body_skip_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__skip_post.ts index 5bcb101baae..5b5a941ffe6 100644 --- a/clients/admin-ui/src/types/api/models/Body_skip_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__skip_post.ts +++ b/clients/admin-ui/src/types/api/models/Body_skip_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__skip_post.ts @@ -1,16 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { CommentType } from "./CommentType"; +import { CommentType } from "./CommentType"; +/** + * Body_skip_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__skip_post + */ export type Body_skip_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__skip_post = { /** + * Skip Reason + * * Required reason for skipping this field */ skip_reason: string; /** + * Comment Text + * * Optional additional comment */ comment_text?: string | null; diff --git a/clients/admin-ui/src/types/api/models/Body_submit_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__complete_post.ts b/clients/admin-ui/src/types/api/models/Body_submit_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__complete_post.ts index 8485f978030..ed20010a90f 100644 --- a/clients/admin-ui/src/types/api/models/Body_submit_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__complete_post.ts +++ b/clients/admin-ui/src/types/api/models/Body_submit_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__complete_post.ts @@ -1,17 +1,22 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AttachmentType } from "./AttachmentType"; -import type { CommentType } from "./CommentType"; +import { AttachmentType } from "./AttachmentType"; +import { CommentType } from "./CommentType"; +/** + * Body_submit_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__complete_post + */ export type Body_submit_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__complete_post = { /** + * Field Value + * * The value for the field (optional if attachments are provided) */ field_value?: string | null; /** + * Comment Text + * * Optional comment for this field */ comment_text?: string | null; @@ -19,7 +24,10 @@ export type Body_submit_single_manual_field_api_v1_privacy_request__privacy_requ * Comment type (required if comment_text is provided) */ comment_type?: CommentType | null; - attachments?: Array; + /** + * Attachments + */ + attachments?: Array; /** * Attachment type (required if attachments are provided) */ diff --git a/clients/admin-ui/src/types/api/models/Body_upload_data_api_v1_storage__request_id__post.ts b/clients/admin-ui/src/types/api/models/Body_upload_data_api_v1_storage__request_id__post.ts index 6851701a3d0..94bc443f5fa 100644 --- a/clients/admin-ui/src/types/api/models/Body_upload_data_api_v1_storage__request_id__post.ts +++ b/clients/admin-ui/src/types/api/models/Body_upload_data_api_v1_storage__request_id__post.ts @@ -1,8 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * Body_upload_data_api_v1_storage__request_id__post + */ export type Body_upload_data_api_v1_storage__request_id__post = { - data: any; + /** + * Data + */ + data: { + [key: string]: unknown; + }; + /** + * Storage Key + */ storage_key: string; }; diff --git a/clients/admin-ui/src/types/api/models/BulkConditionAssignment.ts b/clients/admin-ui/src/types/api/models/BulkConditionAssignment.ts new file mode 100644 index 00000000000..3a6d920d813 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/BulkConditionAssignment.ts @@ -0,0 +1,29 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { ConditionGroup } from "./ConditionGroup"; +import type { ConditionLeaf } from "./ConditionLeaf"; + +/** + * BulkConditionAssignment + * + * Schema for bulk condition assignment to task and/or fields. + * + * This allows setting conditions for both the task level and specific config fields + * in a single request. + */ +export type BulkConditionAssignment = { + /** + * Task Conditions + * + * Conditions to set at task level + */ + task_conditions?: Array | null; + /** + * Field Conditions + * + * Conditions to set for specific fields, keyed by config_field_key + */ + field_conditions?: { + [key: string]: Array; + } | null; +}; diff --git a/clients/admin-ui/src/types/api/models/BulkCustomFieldRequest.ts b/clients/admin-ui/src/types/api/models/BulkCustomFieldRequest.ts index 38d7bfc51b1..5e8d3173e39 100644 --- a/clients/admin-ui/src/types/api/models/BulkCustomFieldRequest.ts +++ b/clients/admin-ui/src/types/api/models/BulkCustomFieldRequest.ts @@ -1,13 +1,25 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { CustomFieldWithId } from "./CustomFieldWithId"; -import type { ResourceTypes } from "./ResourceTypes"; +/** + * BulkCustomFieldRequest + */ export type BulkCustomFieldRequest = { - resource_type: ResourceTypes | string; + /** + * Resource Type + */ + resource_type: string; + /** + * Resource Id + */ resource_id: string; + /** + * Upsert + */ upsert?: Array | null; + /** + * Delete + */ delete?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/BulkDatasetPropertyResponse.ts b/clients/admin-ui/src/types/api/models/BulkDatasetPropertyResponse.ts new file mode 100644 index 00000000000..f6d3262b82d --- /dev/null +++ b/clients/admin-ui/src/types/api/models/BulkDatasetPropertyResponse.ts @@ -0,0 +1,21 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { DatasetPropertyResponse } from "./DatasetPropertyResponse"; + +/** + * BulkDatasetPropertyResponse + * + * Response schema for bulk property assignment/removal operations. + */ +export type BulkDatasetPropertyResponse = { + /** + * Succeeded + */ + succeeded: Array; + /** + * Failed + */ + failed?: Array<{ + [key: string]: unknown; + }> | null; +}; diff --git a/clients/admin-ui/src/types/api/models/BulkPostPrivacyRequests.ts b/clients/admin-ui/src/types/api/models/BulkPostPrivacyRequests.ts index c48410fce5e..eb4ead28945 100644 --- a/clients/admin-ui/src/types/api/models/BulkPostPrivacyRequests.ts +++ b/clients/admin-ui/src/types/api/models/BulkPostPrivacyRequests.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { BulkUpdateFailed } from "./BulkUpdateFailed"; import type { PrivacyRequestResponse } from "./PrivacyRequestResponse"; /** + * BulkPostPrivacyRequests + * * Schema with mixed success/failure responses for Bulk Create of PrivacyRequest responses. */ export type BulkPostPrivacyRequests = { + /** + * Succeeded + */ succeeded: Array; + /** + * Failed + */ failed: Array; }; diff --git a/clients/admin-ui/src/types/api/models/BulkPropertyAssignment.ts b/clients/admin-ui/src/types/api/models/BulkPropertyAssignment.ts new file mode 100644 index 00000000000..f321beb27b1 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/BulkPropertyAssignment.ts @@ -0,0 +1,19 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * BulkPropertyAssignment + * + * Request schema for bulk-assigning properties to datasets. + */ +export type BulkPropertyAssignment = { + /** + * Dataset Config Ids + * + * Internal IDs or fides_keys of dataset configs + */ + dataset_config_ids: Array; + /** + * Property Ids + */ + property_ids: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/BulkPropertyRemoval.ts b/clients/admin-ui/src/types/api/models/BulkPropertyRemoval.ts new file mode 100644 index 00000000000..b42f1d8ba26 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/BulkPropertyRemoval.ts @@ -0,0 +1,19 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * BulkPropertyRemoval + * + * Request schema for bulk-removing properties from datasets. + */ +export type BulkPropertyRemoval = { + /** + * Dataset Config Ids + * + * Internal IDs or fides_keys of dataset configs + */ + dataset_config_ids: Array; + /** + * Property Ids + */ + property_ids: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/BulkPutBasicMessagingTemplateResponse.ts b/clients/admin-ui/src/types/api/models/BulkPutBasicMessagingTemplateResponse.ts index 36f275e0b39..4cb0dd5a3cb 100644 --- a/clients/admin-ui/src/types/api/models/BulkPutBasicMessagingTemplateResponse.ts +++ b/clients/admin-ui/src/types/api/models/BulkPutBasicMessagingTemplateResponse.ts @@ -1,11 +1,18 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { BasicMessagingTemplateResponse } from "./BasicMessagingTemplateResponse"; import type { BulkUpdateFailed } from "./BulkUpdateFailed"; +/** + * BulkPutBasicMessagingTemplateResponse + */ export type BulkPutBasicMessagingTemplateResponse = { + /** + * Succeeded + */ succeeded: Array; + /** + * Failed + */ failed: Array; }; diff --git a/clients/admin-ui/src/types/api/models/BulkPutConnectionConfiguration.ts b/clients/admin-ui/src/types/api/models/BulkPutConnectionConfiguration.ts index 2940505ad68..e30eebfdcab 100644 --- a/clients/admin-ui/src/types/api/models/BulkPutConnectionConfiguration.ts +++ b/clients/admin-ui/src/types/api/models/BulkPutConnectionConfiguration.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { BulkUpdateFailed } from "./BulkUpdateFailed"; import type { ConnectionConfigurationResponse } from "./ConnectionConfigurationResponse"; /** + * BulkPutConnectionConfiguration + * * Schema with mixed success/failure responses for Bulk Create/Update of ConnectionConfiguration responses. */ export type BulkPutConnectionConfiguration = { + /** + * Succeeded + */ succeeded: Array; + /** + * Failed + */ failed: Array; }; diff --git a/clients/admin-ui/src/types/api/models/BulkPutDataset.ts b/clients/admin-ui/src/types/api/models/BulkPutDataset.ts index 60b069d2165..734330f3f47 100644 --- a/clients/admin-ui/src/types/api/models/BulkPutDataset.ts +++ b/clients/admin-ui/src/types/api/models/BulkPutDataset.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { BulkUpdateFailed } from "./BulkUpdateFailed"; import type { Dataset } from "./Dataset"; /** + * BulkPutDataset + * * Schema with mixed success/failure responses for Bulk Create/Update of Datasets. */ export type BulkPutDataset = { + /** + * Succeeded + */ succeeded: Array; + /** + * Failed + */ failed: Array; }; diff --git a/clients/admin-ui/src/types/api/models/BulkPutPolicyResponse.ts b/clients/admin-ui/src/types/api/models/BulkPutPolicyResponse.ts index f87bc7b9127..c5224bf5108 100644 --- a/clients/admin-ui/src/types/api/models/BulkPutPolicyResponse.ts +++ b/clients/admin-ui/src/types/api/models/BulkPutPolicyResponse.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { BulkUpdateFailed } from "./BulkUpdateFailed"; import type { PolicyResponse } from "./PolicyResponse"; /** + * BulkPutPolicyResponse + * * Schema with mixed success/failure responses for Bulk Create/Update of Policy responses. */ export type BulkPutPolicyResponse = { + /** + * Succeeded + */ succeeded: Array; + /** + * Failed + */ failed: Array; }; diff --git a/clients/admin-ui/src/types/api/models/BulkPutRuleResponse.ts b/clients/admin-ui/src/types/api/models/BulkPutRuleResponse.ts index e5fbae75fa9..1011c8f1a04 100644 --- a/clients/admin-ui/src/types/api/models/BulkPutRuleResponse.ts +++ b/clients/admin-ui/src/types/api/models/BulkPutRuleResponse.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { BulkUpdateFailed } from "./BulkUpdateFailed"; import type { RuleResponse } from "./RuleResponse"; /** + * BulkPutRuleResponse + * * Schema with mixed success/failure responses for Bulk Create/Update of Rule responses. */ export type BulkPutRuleResponse = { + /** + * Succeeded + */ succeeded: Array; + /** + * Failed + */ failed: Array; }; diff --git a/clients/admin-ui/src/types/api/models/BulkPutRuleTargetResponse.ts b/clients/admin-ui/src/types/api/models/BulkPutRuleTargetResponse.ts index fe7009625fa..ff0fd1819b0 100644 --- a/clients/admin-ui/src/types/api/models/BulkPutRuleTargetResponse.ts +++ b/clients/admin-ui/src/types/api/models/BulkPutRuleTargetResponse.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { BulkUpdateFailed } from "./BulkUpdateFailed"; import type { RuleTarget } from "./RuleTarget"; /** + * BulkPutRuleTargetResponse + * * Schema with mixed success/failure responses for Bulk Create/Update of RuleTarget responses. */ export type BulkPutRuleTargetResponse = { + /** + * Succeeded + */ succeeded: Array; + /** + * Failed + */ failed: Array; }; diff --git a/clients/admin-ui/src/types/api/models/BulkPutStorageConfigResponse.ts b/clients/admin-ui/src/types/api/models/BulkPutStorageConfigResponse.ts index ae4ce31d8cd..1352a3c6b08 100644 --- a/clients/admin-ui/src/types/api/models/BulkPutStorageConfigResponse.ts +++ b/clients/admin-ui/src/types/api/models/BulkPutStorageConfigResponse.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { BulkUpdateFailed } from "./BulkUpdateFailed"; import type { StorageDestinationResponse } from "./StorageDestinationResponse"; /** + * BulkPutStorageConfigResponse + * * Schema with mixed success/failure responses for Bulk Create/Update of StorageConfig. */ export type BulkPutStorageConfigResponse = { + /** + * Succeeded + */ succeeded?: Array; + /** + * Failed + */ failed?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/BulkReviewResponse.ts b/clients/admin-ui/src/types/api/models/BulkReviewResponse.ts index 39e1a2eb135..4e496292665 100644 --- a/clients/admin-ui/src/types/api/models/BulkReviewResponse.ts +++ b/clients/admin-ui/src/types/api/models/BulkReviewResponse.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { BulkUpdateFailed } from "./BulkUpdateFailed"; import type { PrivacyRequestResponse } from "./PrivacyRequestResponse"; /** + * BulkReviewResponse + * * Schema with mixed success/failure responses for Bulk Approve/Deny of PrivacyRequest responses. */ export type BulkReviewResponse = { + /** + * Succeeded + */ succeeded: Array; + /** + * Failed + */ failed: Array; }; diff --git a/clients/admin-ui/src/types/api/models/BulkSoftDeletePrivacyRequests.ts b/clients/admin-ui/src/types/api/models/BulkSoftDeletePrivacyRequests.ts index 76ea3475661..1e9ace8837c 100644 --- a/clients/admin-ui/src/types/api/models/BulkSoftDeletePrivacyRequests.ts +++ b/clients/admin-ui/src/types/api/models/BulkSoftDeletePrivacyRequests.ts @@ -1,10 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { BulkUpdateFailed } from "./BulkUpdateFailed"; +/** + * BulkSoftDeletePrivacyRequests + */ export type BulkSoftDeletePrivacyRequests = { + /** + * Succeeded + */ succeeded: Array; + /** + * Failed + */ failed: Array; }; diff --git a/clients/admin-ui/src/types/api/models/BulkUpdateFailed.ts b/clients/admin-ui/src/types/api/models/BulkUpdateFailed.ts index 5af0e792095..265ea394a14 100644 --- a/clients/admin-ui/src/types/api/models/BulkUpdateFailed.ts +++ b/clients/admin-ui/src/types/api/models/BulkUpdateFailed.ts @@ -1,11 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * BulkUpdateFailed + * * Schema for use when Bulk Create/Update fails. */ export type BulkUpdateFailed = { + /** + * Message + */ message: string; - data: any; + /** + * Data + */ + data: { + [key: string]: unknown; + }; }; diff --git a/clients/admin-ui/src/types/api/models/BulkUserAssignment.ts b/clients/admin-ui/src/types/api/models/BulkUserAssignment.ts new file mode 100644 index 00000000000..a6455e66682 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/BulkUserAssignment.ts @@ -0,0 +1,26 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * BulkUserAssignment + * + * Schema for bulk user assignment to task and/or fields. + * + * This allows assigning users to both the task level and specific config fields + * in a single request. + */ +export type BulkUserAssignment = { + /** + * Task Users + * + * User IDs to assign to task level + */ + task_users?: Array | null; + /** + * Field Users + * + * User IDs to assign to specific fields, keyed by config_field_key + */ + field_users?: { + [key: string]: Array; + } | null; +}; diff --git a/clients/admin-ui/src/types/api/models/CancelPrivacyRequestSelection.ts b/clients/admin-ui/src/types/api/models/CancelPrivacyRequestSelection.ts new file mode 100644 index 00000000000..fda823861e1 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/CancelPrivacyRequestSelection.ts @@ -0,0 +1,31 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { PrivacyRequestFilter } from "./PrivacyRequestFilter"; + +/** + * CancelPrivacyRequestSelection + * + * Select privacy requests to cancel with optional reason + */ +export type CancelPrivacyRequestSelection = { + /** + * Request Ids + * + * List of privacy request IDs to act on. The backend will automatically batch requests if the list is large. + */ + request_ids?: Array | null; + /** + * Filters to select privacy requests (only used when request_ids is not provided) + */ + filters?: PrivacyRequestFilter | null; + /** + * Exclude Ids + * + * List of privacy request IDs to exclude from the action (only used with filters) + */ + exclude_ids?: Array | null; + /** + * Reason + */ + reason?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/CategoryDistribution.ts b/clients/admin-ui/src/types/api/models/CategoryDistribution.ts new file mode 100644 index 00000000000..ac35117a480 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/CategoryDistribution.ts @@ -0,0 +1,27 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * CategoryDistribution + * + * Distribution of resources by consent category. + */ +export type CategoryDistribution = { + /** + * Category + * + * Consent category name + */ + category: string; + /** + * Count + * + * Number of resources in this category + */ + count: number; + /** + * Percentage + * + * Percentage of total classified + */ + percentage: number; +}; diff --git a/clients/admin-ui/src/types/api/models/ChatChannelsResponse.ts b/clients/admin-ui/src/types/api/models/ChatChannelsResponse.ts index 175c204b534..4f92e391866 100644 --- a/clients/admin-ui/src/types/api/models/ChatChannelsResponse.ts +++ b/clients/admin-ui/src/types/api/models/ChatChannelsResponse.ts @@ -1,12 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { SlackChannel } from "./SlackChannel"; /** + * ChatChannelsResponse + * * Response schema for list of available channels. */ export type ChatChannelsResponse = { + /** + * Channels + */ channels: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ChatConfigCreate.ts b/clients/admin-ui/src/types/api/models/ChatConfigCreate.ts index 2f9d3bfff6d..9812ccde7a5 100644 --- a/clients/admin-ui/src/types/api/models/ChatConfigCreate.ts +++ b/clients/admin-ui/src/types/api/models/ChatConfigCreate.ts @@ -1,14 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ChatConfigCreate + * * Schema for creating a new chat configuration. */ export type ChatConfigCreate = { - provider_type?: string; + /** + * Provider Type + */ + provider_type?: "slack"; + /** + * Workspace Url + */ workspace_url: string; + /** + * Client Id + */ client_id?: string | null; + /** + * Client Secret + */ client_secret?: string | null; + /** + * Signing Secret + */ signing_secret?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/ChatConfigListResponse.ts b/clients/admin-ui/src/types/api/models/ChatConfigListResponse.ts index 07c72060950..09a514fb42b 100644 --- a/clients/admin-ui/src/types/api/models/ChatConfigListResponse.ts +++ b/clients/admin-ui/src/types/api/models/ChatConfigListResponse.ts @@ -1,13 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ChatProviderSettingsResponse } from "./ChatProviderSettingsResponse"; +import type { ChatConfigResponse } from "./ChatConfigResponse"; /** + * ChatConfigListResponse + * * Response schema for list of chat configurations. */ export type ChatConfigListResponse = { - items: Array; + /** + * Items + */ + items: Array; + /** + * Total + */ total: number; }; diff --git a/clients/admin-ui/src/types/api/models/ChatConfigResponse.ts b/clients/admin-ui/src/types/api/models/ChatConfigResponse.ts new file mode 100644 index 00000000000..fb528d7d4a4 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ChatConfigResponse.ts @@ -0,0 +1,53 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * ChatConfigResponse + * + * Response schema for a chat configuration (excludes secrets). + */ +export type ChatConfigResponse = { + /** + * Id + */ + id: string; + /** + * Enabled + */ + enabled: boolean; + /** + * Provider Type + */ + provider_type: string; + /** + * Workspace Url + */ + workspace_url?: string | null; + /** + * Client Id + */ + client_id?: string | null; + /** + * Authorized + */ + authorized: boolean; + /** + * Has Signing Secret + */ + has_signing_secret?: boolean; + /** + * Created At + */ + created_at: string; + /** + * Updated At + */ + updated_at: string; + /** + * Workspace Name + */ + workspace_name?: string | null; + /** + * Connected By Email + */ + connected_by_email?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/ChatConfigSecrets.ts b/clients/admin-ui/src/types/api/models/ChatConfigSecrets.ts new file mode 100644 index 00000000000..8c27b9972c7 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ChatConfigSecrets.ts @@ -0,0 +1,17 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * ChatConfigSecrets + * + * Schema for updating secrets only. + */ +export type ChatConfigSecrets = { + /** + * Client Secret + */ + client_secret?: string | null; + /** + * Signing Secret + */ + signing_secret?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/ChatConfigTestResponse.ts b/clients/admin-ui/src/types/api/models/ChatConfigTestResponse.ts new file mode 100644 index 00000000000..5b5f74f1eba --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ChatConfigTestResponse.ts @@ -0,0 +1,17 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * ChatConfigTestResponse + * + * Response schema for chat provider connection test. + */ +export type ChatConfigTestResponse = { + /** + * Success + */ + success: boolean; + /** + * Message + */ + message: string; +}; diff --git a/clients/admin-ui/src/types/api/models/ChatConfigUpdate.ts b/clients/admin-ui/src/types/api/models/ChatConfigUpdate.ts index 52e6b0a91b0..0b76feafe98 100644 --- a/clients/admin-ui/src/types/api/models/ChatConfigUpdate.ts +++ b/clients/admin-ui/src/types/api/models/ChatConfigUpdate.ts @@ -1,14 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ChatConfigUpdate + * * Schema for updating an existing chat configuration. */ export type ChatConfigUpdate = { - provider_type?: string | null; + /** + * Provider Type + */ + provider_type?: "slack" | null; + /** + * Workspace Url + */ workspace_url?: string | null; + /** + * Client Id + */ client_id?: string | null; + /** + * Client Secret + */ client_secret?: string | null; + /** + * Signing Secret + */ signing_secret?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/ChatProviderSecrets.ts b/clients/admin-ui/src/types/api/models/ChatProviderSecrets.ts deleted file mode 100644 index dab6b26d3e2..00000000000 --- a/clients/admin-ui/src/types/api/models/ChatProviderSecrets.ts +++ /dev/null @@ -1,11 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -/** - * Schema for updating secrets only. - */ -export type ChatProviderSecrets = { - client_secret?: string | null; - signing_secret?: string | null; -}; diff --git a/clients/admin-ui/src/types/api/models/ChatProviderSettingsResponse.ts b/clients/admin-ui/src/types/api/models/ChatProviderSettingsResponse.ts deleted file mode 100644 index e7350089c7a..00000000000 --- a/clients/admin-ui/src/types/api/models/ChatProviderSettingsResponse.ts +++ /dev/null @@ -1,20 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -/** - * Response schema for chat provider settings (excludes secrets). - */ -export type ChatProviderSettingsResponse = { - id: string; - enabled: boolean; - provider_type: string; - workspace_url?: string | null; - client_id?: string | null; - authorized: boolean; - has_signing_secret?: boolean; - created_at: string; - updated_at: string; - workspace_name?: string | null; - connected_by_email?: string | null; -}; diff --git a/clients/admin-ui/src/types/api/models/ChatProviderTestResponse.ts b/clients/admin-ui/src/types/api/models/ChatProviderTestResponse.ts deleted file mode 100644 index e32615cf6ae..00000000000 --- a/clients/admin-ui/src/types/api/models/ChatProviderTestResponse.ts +++ /dev/null @@ -1,11 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -/** - * Response schema for chat provider connection test. - */ -export type ChatProviderTestResponse = { - success: boolean; - message: string; -}; diff --git a/clients/admin-ui/src/types/api/models/CheckpointActionRequiredDetails.ts b/clients/admin-ui/src/types/api/models/CheckpointActionRequiredDetails.ts index 475db28e042..94549d3c24a 100644 --- a/clients/admin-ui/src/types/api/models/CheckpointActionRequiredDetails.ts +++ b/clients/admin-ui/src/types/api/models/CheckpointActionRequiredDetails.ts @@ -1,12 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { CurrentStep } from "./CurrentStep"; +import { CurrentStep } from "./CurrentStep"; import type { ManualAction } from "./ManualAction"; +/** + * CheckpointActionRequiredDetails + */ export type CheckpointActionRequiredDetails = { step: CurrentStep; + /** + * Collection + */ collection?: string | null; + /** + * Action Needed + */ action_needed?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/Classification.ts b/clients/admin-ui/src/types/api/models/Classification.ts index d0f700494ae..0d95459266d 100644 --- a/clients/admin-ui/src/types/api/models/Classification.ts +++ b/clients/admin-ui/src/types/api/models/Classification.ts @@ -1,12 +1,34 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** - * The model for the suggested data labels + * Classification + * + * The model for the suggested data labels. + * + * Note: For LLM-based classifications, the `score` field is always 1.0 and is not used + * for confidence bucket determination. Instead, the `confidence_rating` field (1-5 integer) + * is used to calculate confidence buckets (low, medium, high). The `score` field is primarily + * maintained for backwards compatibility with legacy classification systems. */ export type Classification = { + /** + * Label + */ label: string; + /** + * Score + */ score: number; + /** + * Rationale + */ rationale?: string | null; + /** + * Confidence Rating + */ + confidence_rating?: number | null; + /** + * Default + */ + default?: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/ClassificationBenchmarkRequest.ts b/clients/admin-ui/src/types/api/models/ClassificationBenchmarkRequest.ts new file mode 100644 index 00000000000..42a27eed678 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ClassificationBenchmarkRequest.ts @@ -0,0 +1,27 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * ClassificationBenchmarkRequest + * + * Request model for starting a classification benchmark. + */ +export type ClassificationBenchmarkRequest = { + /** + * Monitor Config Key + * + * Key of the monitor to evaluate + */ + monitor_config_key: string; + /** + * Dataset Fides Key + * + * Fides dataset key to use as ground truth + */ + dataset_fides_key: string; + /** + * Resource Urns + * + * The staged resource URNs to evaluate + */ + resource_urns: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/ClassificationBenchmarkResponse.ts b/clients/admin-ui/src/types/api/models/ClassificationBenchmarkResponse.ts new file mode 100644 index 00000000000..215ad961ee4 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ClassificationBenchmarkResponse.ts @@ -0,0 +1,27 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * ClassificationBenchmarkResponse + * + * Response model for classification benchmark initiation. + */ +export type ClassificationBenchmarkResponse = { + /** + * Benchmark Id + * + * Unique identifier for the benchmark + */ + benchmark_id: string; + /** + * Status + * + * Status of the benchmark + */ + status: string; + /** + * Message + * + * Additional information about the benchmark + */ + message: string; +}; diff --git a/clients/admin-ui/src/types/api/models/ClassificationBenchmarkSummary.ts b/clients/admin-ui/src/types/api/models/ClassificationBenchmarkSummary.ts new file mode 100644 index 00000000000..ce37727ff0d --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ClassificationBenchmarkSummary.ts @@ -0,0 +1,56 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { AccuracyMetrics } from "./AccuracyMetrics"; +import { BenchmarkStatus } from "./BenchmarkStatus"; + +/** + * ClassificationBenchmarkSummary + * + * Summary results of a classification benchmark. + */ +export type ClassificationBenchmarkSummary = { + /** + * Id + * + * Unique identifier for the benchmark + */ + id: string; + /** + * Monitor Config Key + * + * Key of the monitor being evaluated + */ + monitor_config_key: string; + /** + * Dataset Fides Key + * + * Fides dataset key used as ground truth + */ + dataset_fides_key: string; + /** + * Resource Urns + * + * The staged resource URNs that were evaluated + */ + resource_urns: Array; + /** + * Created At + * + * When the benchmark was created + */ + created_at: string; + /** + * Overall accuracy metrics (null for failed benchmarks) + */ + overall_metrics?: AccuracyMetrics | null; + /** + * Status of the benchmark execution + */ + status: BenchmarkStatus; + /** + * Messages + * + * Status messages and error information + */ + messages: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/ClassificationCoverage.ts b/clients/admin-ui/src/types/api/models/ClassificationCoverage.ts new file mode 100644 index 00000000000..df6ca637c3d --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ClassificationCoverage.ts @@ -0,0 +1,39 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * ClassificationCoverage + * + * Coverage statistics for the classification run. + */ +export type ClassificationCoverage = { + /** + * Total Resources + * + * Total resources in the monitor + */ + total_resources: number; + /** + * Classified By Compass + * + * Resources classified by Compass (have vendor_id from scan) + */ + classified_by_compass: number; + /** + * Classified By Llm + * + * Resources classified by LLM + */ + classified_by_llm: number; + /** + * Unclassified + * + * Resources still without classification + */ + unclassified: number; + /** + * Coverage Rate + * + * Percentage of resources with any classification + */ + coverage_rate: number; +}; diff --git a/clients/admin-ui/src/types/api/models/ClassificationErrorSchema.ts b/clients/admin-ui/src/types/api/models/ClassificationErrorSchema.ts new file mode 100644 index 00000000000..39ef0233cc7 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ClassificationErrorSchema.ts @@ -0,0 +1,17 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * ClassificationErrorSchema + * + * Pydantic schema for serializing classification errors. + */ +export type ClassificationErrorSchema = { + /** + * Error Message + */ + error_message: string; + /** + * Field Name + */ + field_name?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/ClassificationResponse.ts b/clients/admin-ui/src/types/api/models/ClassificationResponse.ts index 838e8f5d3b4..0706c474521 100644 --- a/clients/admin-ui/src/types/api/models/ClassificationResponse.ts +++ b/clients/admin-ui/src/types/api/models/ClassificationResponse.ts @@ -1,9 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ClassifyDataset } from "./ClassifyDataset"; +/** + * ClassificationResponse + */ export type ClassificationResponse = { + /** + * Datasets + */ datasets: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ClassificationStatus.ts b/clients/admin-ui/src/types/api/models/ClassificationStatus.ts index e3576081b5a..a7625f60c55 100644 --- a/clients/admin-ui/src/types/api/models/ClassificationStatus.ts +++ b/clients/admin-ui/src/types/api/models/ClassificationStatus.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ClassificationStatus + * * The model housing statuses for a classify instance. * * CREATED: The initial state of an attempt to classify diff --git a/clients/admin-ui/src/types/api/models/ClassificationWithConfidence.ts b/clients/admin-ui/src/types/api/models/ClassificationWithConfidence.ts index 641e49af9d2..a2fcdfce3ae 100644 --- a/clients/admin-ui/src/types/api/models/ClassificationWithConfidence.ts +++ b/clients/admin-ui/src/types/api/models/ClassificationWithConfidence.ts @@ -1,10 +1,10 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConfidenceBucket } from "./ConfidenceBucket"; +import { ConfidenceBucket } from "./ConfidenceBucket"; /** + * ClassificationWithConfidence + * * Pydantic Schema used to represent a classification with a confidence bucket. * * The confidence_bucket is automatically calculated based on the confidence_rating @@ -12,14 +12,34 @@ import type { ConfidenceBucket } from "./ConfidenceBucket"; * NULL confidence_rating is treated as 0, which maps to the LOW bucket. * * Thresholds are read from config. For testing, set config values via fixtures. + * + * Can be constructed from: + * - A dict (e.g., from DB JSON column) + * - A Classification instance (via from_classification() or direct instantiation) */ export type ClassificationWithConfidence = { + /** + * Label + */ label: string; + /** + * Score + */ score: number; + /** + * Rationale + */ rationale?: string | null; + /** + * Confidence Rating + */ confidence_rating?: number | null; /** - * The confidence bucket according to the classification rating and the confidence thresholds. None if no confidence_rating is available. + * Default + */ + default?: boolean; + /** + * Confidence bucket (high/medium/low/manual) based on confidence_rating (1-5). NULL is treated as 0 (LOW). */ - confidence_bucket?: ConfidenceBucket | null; + confidence_bucket: ConfidenceBucket; }; diff --git a/clients/admin-ui/src/types/api/models/ClassifyCollection.ts b/clients/admin-ui/src/types/api/models/ClassifyCollection.ts index b11c3f3cee0..315c44b7680 100644 --- a/clients/admin-ui/src/types/api/models/ClassifyCollection.ts +++ b/clients/admin-ui/src/types/api/models/ClassifyCollection.ts @@ -1,10 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ClassifyField } from "./ClassifyField"; +/** + * ClassifyCollection + */ export type ClassifyCollection = { + /** + * Name + */ name: string; + /** + * Fields + */ fields: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ClassifyDataFlow.ts b/clients/admin-ui/src/types/api/models/ClassifyDataFlow.ts index fe3acb7c40d..c0f5d8dba54 100644 --- a/clients/admin-ui/src/types/api/models/ClassifyDataFlow.ts +++ b/clients/admin-ui/src/types/api/models/ClassifyDataFlow.ts @@ -1,10 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { Classification } from "./Classification"; +/** + * ClassifyDataFlow + */ export type ClassifyDataFlow = { + /** + * Fides Key + */ fides_key: string; + /** + * Classifications + */ classifications: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ClassifyDataset.ts b/clients/admin-ui/src/types/api/models/ClassifyDataset.ts index 443a2ab034d..55e1393b89c 100644 --- a/clients/admin-ui/src/types/api/models/ClassifyDataset.ts +++ b/clients/admin-ui/src/types/api/models/ClassifyDataset.ts @@ -1,13 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ClassificationStatus } from "./ClassificationStatus"; +import { ClassificationStatus } from "./ClassificationStatus"; import type { ClassifyCollection } from "./ClassifyCollection"; +/** + * ClassifyDataset + */ export type ClassifyDataset = { + /** + * Fides Key + */ fides_key: string; + /** + * Name + */ name: string; status: ClassificationStatus; + /** + * Collections + */ collections: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ClassifyDatasetResponse.ts b/clients/admin-ui/src/types/api/models/ClassifyDatasetResponse.ts index 34c61416bc7..2f0c9af207a 100644 --- a/clients/admin-ui/src/types/api/models/ClassifyDatasetResponse.ts +++ b/clients/admin-ui/src/types/api/models/ClassifyDatasetResponse.ts @@ -1,8 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ClassifyDatasetResponse + */ export type ClassifyDatasetResponse = { - classify_instances: Array>; + /** + * Classify Instances + */ + classify_instances: Array<{ + [key: string]: string; + }>; + /** + * Task Id + */ task_id?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/ClassifyEmpty.ts b/clients/admin-ui/src/types/api/models/ClassifyEmpty.ts index b97f67a9629..8d8bcfef6e1 100644 --- a/clients/admin-ui/src/types/api/models/ClassifyEmpty.ts +++ b/clients/admin-ui/src/types/api/models/ClassifyEmpty.ts @@ -1,9 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ClassifyEmpty + * * This class is used for responses that have no * data returned. Returns an empty dictionary */ -export type ClassifyEmpty = {}; +export type ClassifyEmpty = { + [key: string]: never; +}; diff --git a/clients/admin-ui/src/types/api/models/ClassifyField.ts b/clients/admin-ui/src/types/api/models/ClassifyField.ts index 56449c595e2..e536383ef39 100644 --- a/clients/admin-ui/src/types/api/models/ClassifyField.ts +++ b/clients/admin-ui/src/types/api/models/ClassifyField.ts @@ -1,10 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { Classification } from "./Classification"; +/** + * ClassifyField + */ export type ClassifyField = { + /** + * Name + */ name: string; + /** + * Classifications + */ classifications: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ClassifyInput.ts b/clients/admin-ui/src/types/api/models/ClassifyInput.ts new file mode 100644 index 00000000000..d0ea9f5a191 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ClassifyInput.ts @@ -0,0 +1,22 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { TableContext } from "./TableContext"; + +/** + * ClassifyInput + * + * Input for the classification, containing either the content to classify + * or the fully qualified column name, or both. Can also include table context + * information to aid in classification decisions. + */ +export type ClassifyInput = { + /** + * Fq Column Name + */ + fq_column_name?: string | null; + /** + * Text + */ + text?: string | null; + table_context?: TableContext | null; +}; diff --git a/clients/admin-ui/src/types/api/models/ClassifyInstanceResponseValues.ts b/clients/admin-ui/src/types/api/models/ClassifyInstanceResponseValues.ts index 7ea149b9461..ed184f12558 100644 --- a/clients/admin-ui/src/types/api/models/ClassifyInstanceResponseValues.ts +++ b/clients/admin-ui/src/types/api/models/ClassifyInstanceResponseValues.ts @@ -1,19 +1,44 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ClassificationStatus } from "./ClassificationStatus"; -import type { GenerateTypes } from "./GenerateTypes"; +import { ClassificationStatus } from "./ClassificationStatus"; +import { GenerateTypes } from "./GenerateTypes"; +/** + * ClassifyInstanceResponseValues + */ export type ClassifyInstanceResponseValues = { status: ClassificationStatus; + /** + * Organization Key + */ organization_key: string; + /** + * Dataset Key + */ dataset_key: string; + /** + * Dataset Name + */ dataset_name: string; + /** + * Target + */ target: string; type: GenerateTypes; + /** + * Id + */ id: string; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at: string; + /** + * Has Labels + */ has_labels?: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/ClassifyLabel.ts b/clients/admin-ui/src/types/api/models/ClassifyLabel.ts new file mode 100644 index 00000000000..9d9b83429e1 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ClassifyLabel.ts @@ -0,0 +1,39 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * ClassifyLabel + * + * Label and metadata for a classification output. + */ +export type ClassifyLabel = { + /** + * Value + * + * The Fideslang Data Category label + */ + value: string; + /** + * Score + * + * The score of the classification. A float between 0 and 1. For LLM classifications, this is effectively deprecated, and always assigned to 1.0 + */ + score?: number; + /** + * Confidence Rating + * + * The confidence rating of the classification. An integer assigned based on a 1-5 rubric + */ + confidence_rating?: number | null; + /** + * Rationale + * + * The rationale for the classification, if provided + */ + rationale?: string | null; + /** + * Default + * + * Whether this is a 'default' classification label, which is assigned when no other classification is found + */ + default?: boolean; +}; diff --git a/clients/admin-ui/src/types/api/models/ClassifyLlmParams.ts b/clients/admin-ui/src/types/api/models/ClassifyLlmParams.ts index 68f02a35eaa..ef25ad0f23a 100644 --- a/clients/admin-ui/src/types/api/models/ClassifyLlmParams.ts +++ b/clients/admin-ui/src/types/api/models/ClassifyLlmParams.ts @@ -1,20 +1,62 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ClassifyLlmPromptTemplateOptions } from "./ClassifyLlmPromptTemplateOptions"; +import { ClassifyLlmPromptTemplateOptions } from "./ClassifyLlmPromptTemplateOptions"; /** + * ClassifyLlmParams + * * Parameters for the llm/classifier/llm_context_classifier function */ export type ClassifyLlmParams = { + /** + * Llm Model Override + */ llm_model_override?: string | null; + /** + * Custom Llm Instructions + */ custom_llm_instructions?: string | null; prompt_template?: ClassifyLlmPromptTemplateOptions | null; + /** + * Include Rationale + */ include_rationale?: boolean; + /** + * Num Workers + */ num_workers?: number; + /** + * Max Tokens + */ + max_tokens?: number; + /** + * Taxonomy Instructions + */ taxonomy_instructions?: string | null; - tagging_instructions?: Record | null; - tagging_instructions_override_all?: Record | null; + /** + * Tagging Instructions + */ + tagging_instructions?: { + [key: string]: { + [key: string]: unknown; + }; + } | null; + /** + * Tagging Instructions Override All + */ + tagging_instructions_override_all?: { + [key: string]: { + [key: string]: unknown; + }; + } | null; + /** + * Tagging Instructions Remove + */ tagging_instructions_remove?: Array | null; + /** + * Classification Retry Count + * + * Number of times to retry classification if the LLM returns an invalid response (e.g., null tags, malformed XML). Set to 0 to disable retries. + */ + classification_retry_count?: number; }; diff --git a/clients/admin-ui/src/types/api/models/ClassifyLlmPromptTemplateOptions.ts b/clients/admin-ui/src/types/api/models/ClassifyLlmPromptTemplateOptions.ts index fd9d3edfdd5..559bb2c8f4a 100644 --- a/clients/admin-ui/src/types/api/models/ClassifyLlmPromptTemplateOptions.ts +++ b/clients/admin-ui/src/types/api/models/ClassifyLlmPromptTemplateOptions.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ClassifyLlmPromptTemplateOptions + * * Options for the prompt template */ export enum ClassifyLlmPromptTemplateOptions { diff --git a/clients/admin-ui/src/types/api/models/ClassifyOutput.ts b/clients/admin-ui/src/types/api/models/ClassifyOutput.ts new file mode 100644 index 00000000000..f2c3ed1b815 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ClassifyOutput.ts @@ -0,0 +1,25 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { ClassificationErrorSchema } from "./ClassificationErrorSchema"; +import type { ClassifyInput } from "./ClassifyInput"; +import type { ClassifyLabel } from "./ClassifyLabel"; + +/** + * ClassifyOutput + * + * Output of a classification, containing the possibly multiple result labels and the input(s) used. + */ +export type ClassifyOutput = { + /** + * Labels + */ + labels: Array; + /** + * Input + */ + input: ClassifyInput | Array; + /** + * Errors + */ + errors?: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/ClassifyParams.ts b/clients/admin-ui/src/types/api/models/ClassifyParams.ts index b8d1efd4341..e86abdac43b 100644 --- a/clients/admin-ui/src/types/api/models/ClassifyParams.ts +++ b/clients/admin-ui/src/types/api/models/ClassifyParams.ts @@ -1,17 +1,35 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ClassifyParams + * * Model for the classifier params * These are all not required as part of the request * and can rely on the defaults */ export type ClassifyParams = { + /** + * Possible Targets + */ possible_targets?: Array | null; + /** + * Top N + */ top_n?: number; + /** + * Remove Stop Words + */ remove_stop_words?: boolean; + /** + * Pii Threshold + */ pii_threshold?: number; + /** + * Num Samples + */ num_samples?: number; + /** + * Num Threads + */ num_threads?: number; }; diff --git a/clients/admin-ui/src/types/api/models/ClassifyRequestPayload.ts b/clients/admin-ui/src/types/api/models/ClassifyRequestPayload.ts index 9b597130c4a..816b4e30e80 100644 --- a/clients/admin-ui/src/types/api/models/ClassifyRequestPayload.ts +++ b/clients/admin-ui/src/types/api/models/ClassifyRequestPayload.ts @@ -1,13 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ClassifyParams } from "./ClassifyParams"; import type { DatasetSchema } from "./DatasetSchema"; import type { GenerateRequestPayload } from "./GenerateRequestPayload"; +/** + * ClassifyRequestPayload + */ export type ClassifyRequestPayload = { schema_config: GenerateRequestPayload; + /** + * Dataset Schemas + */ dataset_schemas: Array; classify_params?: ClassifyParams; }; diff --git a/clients/admin-ui/src/types/api/models/ClassifyResourcesResponse.ts b/clients/admin-ui/src/types/api/models/ClassifyResourcesResponse.ts deleted file mode 100644 index 81163121295..00000000000 --- a/clients/admin-ui/src/types/api/models/ClassifyResourcesResponse.ts +++ /dev/null @@ -1,10 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -/** - * Response model for confirm operations on staged resources - */ -export type ClassifyResourcesResponse = { - task_id?: string | null; -}; diff --git a/clients/admin-ui/src/types/api/models/ClassifyResult.ts b/clients/admin-ui/src/types/api/models/ClassifyResult.ts new file mode 100644 index 00000000000..0fbc32731b6 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ClassifyResult.ts @@ -0,0 +1,21 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { ClassifyOutput } from "./ClassifyOutput"; + +/** + * ClassifyResult + * + * The result type of the classification, containing a list of classification outputs. + */ +export type ClassifyResult = { + /** + * Items + */ + items: Array; + /** + * Params + */ + params?: { + [key: string]: unknown; + } | null; +}; diff --git a/clients/admin-ui/src/types/api/models/ClassifyStatusUpdatePayload.ts b/clients/admin-ui/src/types/api/models/ClassifyStatusUpdatePayload.ts index 2492948c5a0..d3ab35e9be8 100644 --- a/clients/admin-ui/src/types/api/models/ClassifyStatusUpdatePayload.ts +++ b/clients/admin-ui/src/types/api/models/ClassifyStatusUpdatePayload.ts @@ -1,10 +1,14 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ClassificationStatus } from "./ClassificationStatus"; +import { ClassificationStatus } from "./ClassificationStatus"; +/** + * ClassifyStatusUpdatePayload + */ export type ClassifyStatusUpdatePayload = { + /** + * Dataset Fides Key + */ dataset_fides_key: string; status: ClassificationStatus; }; diff --git a/clients/admin-ui/src/types/api/models/ClassifySystem.ts b/clients/admin-ui/src/types/api/models/ClassifySystem.ts index 951e65e3fa0..74637903c30 100644 --- a/clients/admin-ui/src/types/api/models/ClassifySystem.ts +++ b/clients/admin-ui/src/types/api/models/ClassifySystem.ts @@ -1,14 +1,27 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ClassificationStatus } from "./ClassificationStatus"; +import { ClassificationStatus } from "./ClassificationStatus"; import type { ClassifyDataFlow } from "./ClassifyDataFlow"; +/** + * ClassifySystem + */ export type ClassifySystem = { + /** + * Fides Key + */ fides_key: string; + /** + * Name + */ name: string; status: ClassificationStatus; + /** + * Egress + */ egress: Array; + /** + * Ingress + */ ingress: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ClientConfig.ts b/clients/admin-ui/src/types/api/models/ClientConfig.ts index c30b73a5eb0..feaaced8c38 100644 --- a/clients/admin-ui/src/types/api/models/ClientConfig.ts +++ b/clients/admin-ui/src/types/api/models/ClientConfig.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { Strategy } from "./Strategy"; /** + * ClientConfig + * * Definition for an authenticated base HTTP client */ export type ClientConfig = { + /** + * Protocol + */ protocol: string; + /** + * Host + */ host: string; authentication?: Strategy | null; }; diff --git a/clients/admin-ui/src/types/api/models/ClientCreatedResponse.ts b/clients/admin-ui/src/types/api/models/ClientCreatedResponse.ts index fe8b95b8929..01375d1853f 100644 --- a/clients/admin-ui/src/types/api/models/ClientCreatedResponse.ts +++ b/clients/admin-ui/src/types/api/models/ClientCreatedResponse.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ClientCreatedResponse + * * Response schema for client creation */ export type ClientCreatedResponse = { + /** + * Client Id + */ client_id: string; + /** + * Client Secret + */ client_secret: string; }; diff --git a/clients/admin-ui/src/types/api/models/ClientOptions.ts b/clients/admin-ui/src/types/api/models/ClientOptions.ts new file mode 100644 index 00000000000..52181ddb7eb --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ClientOptions.ts @@ -0,0 +1,5 @@ +// This file is auto-generated by @hey-api/openapi-ts + +export type ClientOptions = { + baseUrl: "http://localhost:8080" | (string & {}); +}; diff --git a/clients/admin-ui/src/types/api/models/CloudConfig.ts b/clients/admin-ui/src/types/api/models/CloudConfig.ts index 162a8c5dadb..e77ed129066 100644 --- a/clients/admin-ui/src/types/api/models/CloudConfig.ts +++ b/clients/admin-ui/src/types/api/models/CloudConfig.ts @@ -1,8 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * CloudConfig + */ export type CloudConfig = { + /** + * Privacy Center Url + */ privacy_center_url?: string | null; + /** + * Domain Verification Records + */ domain_verification_records?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ClusterHealth.ts b/clients/admin-ui/src/types/api/models/ClusterHealth.ts index 57db349e9fa..6c2daef2c41 100644 --- a/clients/admin-ui/src/types/api/models/ClusterHealth.ts +++ b/clients/admin-ui/src/types/api/models/ClusterHealth.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ClusterHealth + * * Cluster health options */ export enum ClusterHealth { diff --git a/clients/admin-ui/src/types/api/models/CollectionAddressResponse.ts b/clients/admin-ui/src/types/api/models/CollectionAddressResponse.ts index b7c8847b0ce..0a47d27a3cb 100644 --- a/clients/admin-ui/src/types/api/models/CollectionAddressResponse.ts +++ b/clients/admin-ui/src/types/api/models/CollectionAddressResponse.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * CollectionAddressResponse + * * Schema for the representation of a collection in the graph */ export type CollectionAddressResponse = { + /** + * Dataset + */ dataset: string | null; + /** + * Collection + */ collection: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/CollectionMeta.ts b/clients/admin-ui/src/types/api/models/CollectionMeta.ts index 3eef1cd38be..126c41b6a32 100644 --- a/clients/admin-ui/src/types/api/models/CollectionMeta.ts +++ b/clients/admin-ui/src/types/api/models/CollectionMeta.ts @@ -1,16 +1,41 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { MaskingStrategyOverride } from "./MaskingStrategyOverride"; /** + * CollectionMeta + * * Collection-level specific annotations used for query traversal */ export type CollectionMeta = { + /** + * After + */ after?: Array | null; + /** + * Erase After + */ erase_after?: Array | null; + /** + * Skip Processing + */ skip_processing?: boolean | null; masking_strategy_override?: MaskingStrategyOverride | null; - partitioning?: null; + /** + * Partitioning + */ + partitioning?: + | { + [key: string]: unknown; + } + | Array<{ + [key: string]: unknown; + }> + | null; + /** + * Redact + * + * Specify 'name' to indicate the collection name should be redacted. + */ + redact?: "name" | null; }; diff --git a/clients/admin-ui/src/types/api/models/ColumnInfo.ts b/clients/admin-ui/src/types/api/models/ColumnInfo.ts new file mode 100644 index 00000000000..06c0e1a4e58 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ColumnInfo.ts @@ -0,0 +1,21 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * ColumnInfo + * + * Information about a column in a database table. + */ +export type ColumnInfo = { + /** + * Name + */ + name: string; + /** + * Data Type + */ + data_type?: string | null; + /** + * Description + */ + description?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/ColumnMapItem.ts b/clients/admin-ui/src/types/api/models/ColumnMapItem.ts index 1bc8b2658e5..d4b3a117ebd 100644 --- a/clients/admin-ui/src/types/api/models/ColumnMapItem.ts +++ b/clients/admin-ui/src/types/api/models/ColumnMapItem.ts @@ -1,16 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ColumnMapItem + * * A map between column keys and custom labels. */ export type ColumnMapItem = { /** + * Label + * * The custom label for the column */ label?: string | null; /** + * Enabled + * * Whether the column is shown */ enabled?: boolean | null; diff --git a/clients/admin-ui/src/types/api/models/ColumnSort.ts b/clients/admin-ui/src/types/api/models/ColumnSort.ts index d1e227473bb..360b293f0a4 100644 --- a/clients/admin-ui/src/types/api/models/ColumnSort.ts +++ b/clients/admin-ui/src/types/api/models/ColumnSort.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ColumnSort + */ export enum ColumnSort { DESC = "desc", ASC = "asc", diff --git a/clients/admin-ui/src/types/api/models/CommentResponse.ts b/clients/admin-ui/src/types/api/models/CommentResponse.ts index 318f0de3188..2646b64f4be 100644 --- a/clients/admin-ui/src/types/api/models/CommentResponse.ts +++ b/clients/admin-ui/src/types/api/models/CommentResponse.ts @@ -1,47 +1,65 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { AttachmentResponse } from "./AttachmentResponse"; -import type { CommentType } from "./CommentType"; +import { CommentType } from "./CommentType"; /** + * CommentResponse + * * Model for comment responses. */ export type CommentResponse = { /** + * Id + * * The comment ID */ id: string; /** + * Privacy Request Id + * * The privacy request ID */ privacy_request_id: string; /** + * User Id + * * The user ID */ user_id: string | null; /** + * Username + * * The username */ username: string | null; /** + * User First Name + * * The user first name */ user_first_name: string | null; /** + * User Last Name + * * The user last name */ user_last_name: string | null; /** + * Created At + * * The creation date */ created_at: string; /** + * Attachments + * * The attachments */ attachments: Array; /** + * Comment Text + * * The comment text */ comment_text: string; diff --git a/clients/admin-ui/src/types/api/models/CommentType.ts b/clients/admin-ui/src/types/api/models/CommentType.ts index 712de536a63..c598218c284 100644 --- a/clients/admin-ui/src/types/api/models/CommentType.ts +++ b/clients/admin-ui/src/types/api/models/CommentType.ts @@ -1,12 +1,12 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * CommentType + * * Enum for comment types. Indicates comment usage. * * - notes are internal comments. - * - reply comments are public and may cause an email or other communciation to be sent + * - reply is reserved for future use and is not currently supported */ export enum CommentType { NOTE = "note", diff --git a/clients/admin-ui/src/types/api/models/ComponentType.ts b/clients/admin-ui/src/types/api/models/ComponentType.ts index a66d07bc7b5..d5158ffb85e 100644 --- a/clients/admin-ui/src/types/api/models/ComponentType.ts +++ b/clients/admin-ui/src/types/api/models/ComponentType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ComponentType + * * The component type - not formalized in the db * * Overlay type has been deprecated but can't be removed for backwards compatibility diff --git a/clients/admin-ui/src/types/api/models/ConditionGroup.ts b/clients/admin-ui/src/types/api/models/ConditionGroup.ts index c6ec56b830a..e76613dd2b6 100644 --- a/clients/admin-ui/src/types/api/models/ConditionGroup.ts +++ b/clients/admin-ui/src/types/api/models/ConditionGroup.ts @@ -1,16 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConditionLeaf } from "./ConditionLeaf"; -import type { GroupOperator } from "./GroupOperator"; +import { GroupOperator } from "./GroupOperator"; +/** + * ConditionGroup + */ export type ConditionGroup = { /** * Logical operator: 'and' or 'or' */ logical_operator: GroupOperator; /** + * Conditions + * * List of conditions or nested groups */ conditions: Array; diff --git a/clients/admin-ui/src/types/api/models/ConditionLeaf.ts b/clients/admin-ui/src/types/api/models/ConditionLeaf.ts index 5726a76df64..43b613064f8 100644 --- a/clients/admin-ui/src/types/api/models/ConditionLeaf.ts +++ b/clients/admin-ui/src/types/api/models/ConditionLeaf.ts @@ -1,11 +1,14 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { Operator } from "./Operator"; +import { Operator } from "./Operator"; +/** + * ConditionLeaf + */ export type ConditionLeaf = { /** + * Field Address + * * Field path to check (e.g., 'user.name', 'billing.subscription.status') */ field_address: string; @@ -14,7 +17,15 @@ export type ConditionLeaf = { */ operator: Operator; /** + * Value + * * Expected value for comparison */ - value?: string | number | boolean | null; + value?: + | string + | number + | number + | boolean + | Array + | null; }; diff --git a/clients/admin-ui/src/types/api/models/ConditionalTotalPage_ConsentReportingSchema_.ts b/clients/admin-ui/src/types/api/models/ConditionalTotalPage_ConsentReportingSchema_.ts new file mode 100644 index 00000000000..2acc69fb874 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ConditionalTotalPage_ConsentReportingSchema_.ts @@ -0,0 +1,29 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { ConsentReportingSchema } from "./ConsentReportingSchema"; + +/** + * ConditionalTotalPage[ConsentReportingSchema] + */ +export type ConditionalTotalPage_ConsentReportingSchema_ = { + /** + * Items + */ + items: Array; + /** + * Total + */ + total?: number | null; + /** + * Pages + */ + pages?: number | null; + /** + * Page + */ + page?: number | null; + /** + * Size + */ + size?: number; +}; diff --git a/clients/admin-ui/src/types/api/models/ConditionalValue.ts b/clients/admin-ui/src/types/api/models/ConditionalValue.ts index e23182f76cd..5eca7da0213 100644 --- a/clients/admin-ui/src/types/api/models/ConditionalValue.ts +++ b/clients/admin-ui/src/types/api/models/ConditionalValue.ts @@ -1,8 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ConditionalValue + */ export type ConditionalValue = { + /** + * Value + */ value: boolean; + /** + * Globalprivacycontrol + */ globalPrivacyControl: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/ConfidenceBucket.ts b/clients/admin-ui/src/types/api/models/ConfidenceBucket.ts index c26a005a54f..d8b027427ae 100644 --- a/clients/admin-ui/src/types/api/models/ConfidenceBucket.ts +++ b/clients/admin-ui/src/types/api/models/ConfidenceBucket.ts @@ -1,14 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ConfidenceBucket + * * Enum for confidence bucket classifications. * * Confidence buckets are determined by the `confidence_rating` field (1-5 integer) * and configurable thresholds, NOT by the `score` field. The `score` field is * maintained for backwards compatibility but is always 1.0 for LLM classifications. - * NULL confidence_rating is treated as 0, which maps to the LOW bucket. + * + * NULL confidence_rating is used for 'default' classifications, + * i.e. when no appropriate data category is identified, and for non-LLM classifications. + * NULL is treated as 0, which maps to the LOW bucket. */ export enum ConfidenceBucket { LOW = "low", diff --git a/clients/admin-ui/src/types/api/models/ConfidenceDistribution.ts b/clients/admin-ui/src/types/api/models/ConfidenceDistribution.ts new file mode 100644 index 00000000000..ed0e62dbe76 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ConfidenceDistribution.ts @@ -0,0 +1,27 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * ConfidenceDistribution + * + * Distribution of confidence scores. + */ +export type ConfidenceDistribution = { + /** + * Score + * + * Confidence score (1-5) + */ + score: number; + /** + * Count + * + * Number of resources with this score + */ + count: number; + /** + * Percentage + * + * Percentage of total classified + */ + percentage: number; +}; diff --git a/clients/admin-ui/src/types/api/models/ConfigConsentOption.ts b/clients/admin-ui/src/types/api/models/ConfigConsentOption.ts index 52cd0d7fa19..fe430c62f2c 100644 --- a/clients/admin-ui/src/types/api/models/ConfigConsentOption.ts +++ b/clients/admin-ui/src/types/api/models/ConfigConsentOption.ts @@ -1,16 +1,41 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConditionalValue } from "./ConditionalValue"; +/** + * ConfigConsentOption + */ export type ConfigConsentOption = { + /** + * Cookiekeys + */ cookieKeys?: Array; + /** + * Default + */ default?: boolean | ConditionalValue | null; + /** + * Description + */ description: string; + /** + * Fidesdatausekey + */ fidesDataUseKey: string; + /** + * Highlight + */ highlight?: boolean | null; + /** + * Name + */ name: string; + /** + * Url + */ url: string; + /** + * Executable + */ executable?: boolean | null; }; diff --git a/clients/admin-ui/src/types/api/models/ConfirmResourcesResponse.ts b/clients/admin-ui/src/types/api/models/ConfirmResourcesResponse.ts index 3579b127875..deb937c6d15 100644 --- a/clients/admin-ui/src/types/api/models/ConfirmResourcesResponse.ts +++ b/clients/admin-ui/src/types/api/models/ConfirmResourcesResponse.ts @@ -1,12 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ConfirmResourcesResponse + * * Response model for confirm operations on staged resources */ export type ConfirmResourcesResponse = { - classify_instances?: Array>; + /** + * Classify Instances + */ + classify_instances?: Array<{ + [key: string]: string; + }>; + /** + * Classification Task Id + */ classification_task_id?: string | null; + /** + * Removal Promotion Task Id + */ removal_promotion_task_id?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/ConnectionCategory.ts b/clients/admin-ui/src/types/api/models/ConnectionCategory.ts index 2080a73382d..d7e06da696e 100644 --- a/clients/admin-ui/src/types/api/models/ConnectionCategory.ts +++ b/clients/admin-ui/src/types/api/models/ConnectionCategory.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ConnectionCategory + * * Categories for connection types, matching frontend ConnectionCategory enum */ export enum ConnectionCategory { diff --git a/clients/admin-ui/src/types/api/models/ConnectionConfigurationResponse.ts b/clients/admin-ui/src/types/api/models/ConnectionConfigurationResponse.ts index 84d3455b096..b8ed84372a2 100644 --- a/clients/admin-ui/src/types/api/models/ConnectionConfigurationResponse.ts +++ b/clients/admin-ui/src/types/api/models/ConnectionConfigurationResponse.ts @@ -1,31 +1,68 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AccessLevel } from "./AccessLevel"; -import type { ActionType } from "./ActionType"; -import type { ConnectionType } from "./ConnectionType"; +import { AccessLevel } from "./AccessLevel"; +import { ActionType } from "./ActionType"; +import { ConnectionType } from "./ConnectionType"; import type { LinkedSystemInfo } from "./LinkedSystemInfo"; import type { SaaSConfigBase } from "./SaaSConfigBase"; /** + * ConnectionConfigurationResponse + * * Describes the returned schema for a ConnectionConfiguration. */ export type ConnectionConfigurationResponse = { connection_type: ConnectionType; - secrets?: null; + /** + * Secrets + */ + secrets?: { + [key: string]: unknown; + } | null; saas_config?: SaaSConfigBase | null; + /** + * Name + */ name?: string | null; + /** + * Key + */ key: string; + /** + * Description + */ description?: string | null; access: AccessLevel; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at?: string | null; + /** + * Disabled + */ disabled?: boolean | null; + /** + * Last Test Timestamp + */ last_test_timestamp?: string | null; + /** + * Last Test Succeeded + */ last_test_succeeded?: boolean | null; + /** + * Authorized + */ authorized?: boolean | null; + /** + * Enabled Actions + */ enabled_actions?: Array | null; - system?: any; + /** + * Linked Systems + */ linked_systems?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ConnectionConfigurationResponseWithSystemKey.ts b/clients/admin-ui/src/types/api/models/ConnectionConfigurationResponseWithSystemKey.ts index 67c25bcbc5a..5bfee96ad7e 100644 --- a/clients/admin-ui/src/types/api/models/ConnectionConfigurationResponseWithSystemKey.ts +++ b/clients/admin-ui/src/types/api/models/ConnectionConfigurationResponseWithSystemKey.ts @@ -1,29 +1,72 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AccessLevel } from "./AccessLevel"; -import type { ActionType } from "./ActionType"; -import type { ConnectionType } from "./ConnectionType"; +import { AccessLevel } from "./AccessLevel"; +import { ActionType } from "./ActionType"; +import { ConnectionType } from "./ConnectionType"; +import type { LinkedSystemInfo } from "./LinkedSystemInfo"; import type { SaaSConfigBase } from "./SaaSConfigBase"; /** - * Describes the full returned schema for a ConnectionConfiguration. + * ConnectionConfigurationResponseWithSystemKey + * + * Extended response that includes the legacy ``system_key`` field. */ export type ConnectionConfigurationResponseWithSystemKey = { connection_type: ConnectionType; - secrets?: null; + /** + * Secrets + */ + secrets?: { + [key: string]: unknown; + } | null; saas_config?: SaaSConfigBase | null; + /** + * Name + */ name?: string | null; + /** + * Key + */ key: string; + /** + * Description + */ description?: string | null; access: AccessLevel; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at?: string | null; + /** + * Disabled + */ disabled?: boolean | null; + /** + * Last Test Timestamp + */ last_test_timestamp?: string | null; + /** + * Last Test Succeeded + */ last_test_succeeded?: boolean | null; + /** + * Authorized + */ authorized?: boolean | null; + /** + * Enabled Actions + */ enabled_actions?: Array | null; + /** + * Linked Systems + */ + linked_systems?: Array; + /** + * System Key + */ system_key?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncDetail.ts b/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncDetail.ts index 381b4b8bb82..c47088bc875 100644 --- a/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncDetail.ts +++ b/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncDetail.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConnectionDatahubSyncDetailStatus } from "./ConnectionDatahubSyncDetailStatus"; +import { ConnectionDatahubSyncDetailStatus } from "./ConnectionDatahubSyncDetailStatus"; /** + * ConnectionDatahubSyncDetail + * * Detail of a Datahub sync. */ export type ConnectionDatahubSyncDetail = { + /** + * Dataset Id + */ dataset_id: string; status: ConnectionDatahubSyncDetailStatus; + /** + * Message + */ message: string; }; diff --git a/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncDetailStatus.ts b/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncDetailStatus.ts index 1044881709a..ba699618aba 100644 --- a/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncDetailStatus.ts +++ b/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncDetailStatus.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ConnectionDatahubSyncDetailStatus + * * Status of a Datahub sync detail. */ export enum ConnectionDatahubSyncDetailStatus { diff --git a/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncPayload.ts b/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncPayload.ts index c3e0cd32ac1..c8236f8d8b2 100644 --- a/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncPayload.ts +++ b/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncPayload.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ConnectionDatahubSyncPayload + * * Payload for syncing Datahub connections. */ export type ConnectionDatahubSyncPayload = { + /** + * Dataset Ids + */ dataset_ids: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncResponse.ts b/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncResponse.ts index d413fb2d0d9..33eeab82ce6 100644 --- a/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncResponse.ts +++ b/clients/admin-ui/src/types/api/models/ConnectionDatahubSyncResponse.ts @@ -1,14 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConnectionDatahubSyncDetail } from "./ConnectionDatahubSyncDetail"; /** + * ConnectionDatahubSyncResponse + * * Response for syncing Datahub connections. */ export type ConnectionDatahubSyncResponse = { + /** + * Succeeded + */ succeeded: Array; + /** + * Failed + */ failed: Array; + /** + * Details + */ details: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ConnectionSystemTypeMap.ts b/clients/admin-ui/src/types/api/models/ConnectionSystemTypeMap.ts index 11fc1e020da..8c9ef38e8e2 100644 --- a/clients/admin-ui/src/types/api/models/ConnectionSystemTypeMap.ts +++ b/clients/admin-ui/src/types/api/models/ConnectionSystemTypeMap.ts @@ -1,27 +1,57 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ActionType } from "./ActionType"; -import type { ConnectionCategory } from "./ConnectionCategory"; -import type { ConnectionType } from "./ConnectionType"; -import type { IntegrationFeature } from "./IntegrationFeature"; -import type { SystemType } from "./SystemType"; +import { ActionType } from "./ActionType"; +import { ConnectionCategory } from "./ConnectionCategory"; +import { ConnectionType } from "./ConnectionType"; +import { IntegrationFeature } from "./IntegrationFeature"; +import { SystemType } from "./SystemType"; /** + * ConnectionSystemTypeMap + * * Describes the returned schema for connection types */ export type ConnectionSystemTypeMap = { + /** + * Identifier + */ identifier: ConnectionType | string; type: SystemType; + /** + * Human Readable + */ human_readable: string; + /** + * Encoded Icon + */ encoded_icon?: string | null; + /** + * Authorization Required + */ authorization_required?: boolean | null; + /** + * User Guide + */ user_guide?: string | null; + /** + * Supported Actions + */ supported_actions: Array; category?: ConnectionCategory | null; + /** + * Tags + */ tags?: Array | null; + /** + * Enabled Features + */ enabled_features?: Array | null; + /** + * Custom + */ custom?: boolean; + /** + * Default Connector Available + */ default_connector_available?: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/ConnectionTestStatus.ts b/clients/admin-ui/src/types/api/models/ConnectionTestStatus.ts index ad3d72251c9..1c31318b21c 100644 --- a/clients/admin-ui/src/types/api/models/ConnectionTestStatus.ts +++ b/clients/admin-ui/src/types/api/models/ConnectionTestStatus.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ConnectionTestStatus + * * Enum for supplying statuses of validating credentials for a Connection Config to the user */ export enum ConnectionTestStatus { diff --git a/clients/admin-ui/src/types/api/models/ConnectionType.ts b/clients/admin-ui/src/types/api/models/ConnectionType.ts index d219a6b136d..281d7e05c9e 100644 --- a/clients/admin-ui/src/types/api/models/ConnectionType.ts +++ b/clients/admin-ui/src/types/api/models/ConnectionType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ConnectionType + * * Supported types to which we can connect Fides. */ export enum ConnectionType { @@ -20,6 +20,7 @@ export enum ConnectionType { MANUAL = "manual", MANUAL_WEBHOOK = "manual_webhook", MANUAL_TASK = "manual_task", + JIRA_TICKET = "jira_ticket", MARIADB = "mariadb", MONGODB = "mongodb", MSSQL = "mssql", diff --git a/clients/admin-ui/src/types/api/models/ConnectorParam.ts b/clients/admin-ui/src/types/api/models/ConnectorParam.ts index 3ff8aad6324..74da1f20c59 100644 --- a/clients/admin-ui/src/types/api/models/ConnectorParam.ts +++ b/clients/admin-ui/src/types/api/models/ConnectorParam.ts @@ -1,16 +1,45 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ConnectorParam + * * Used to define the required parameters for the connector (user and constants) */ export type ConnectorParam = { + /** + * Name + */ name: string; + /** + * Label + */ label?: string | null; + /** + * Options + */ options?: Array | null; + /** + * Default Value + */ default_value?: string | Array | number | Array | null; + /** + * Multiselect + */ multiselect?: boolean | null; + /** + * Description + */ description?: string | null; + /** + * Sensitive + */ sensitive?: boolean | null; + /** + * Type + */ + type?: string | null; + /** + * Allowed Values + */ + allowed_values?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/ConnectorTemplateListResponse.ts b/clients/admin-ui/src/types/api/models/ConnectorTemplateListResponse.ts new file mode 100644 index 00000000000..affd7210897 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ConnectorTemplateListResponse.ts @@ -0,0 +1,34 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { ActionType } from "./ActionType"; +import { ConnectionCategory } from "./ConnectionCategory"; + +/** + * ConnectorTemplateListResponse + * + * Response schema for listing connector templates. + * Provides summary information about available connector templates. + */ +export type ConnectorTemplateListResponse = { + /** + * Type + */ + type: string; + /** + * Name + */ + name: string; + /** + * Supported Actions + */ + supported_actions: Array; + category?: ConnectionCategory | null; + /** + * Custom + */ + custom: boolean; + /** + * Default Connector Available + */ + default_connector_available?: boolean; +}; diff --git a/clients/admin-ui/src/types/api/models/Consent.ts b/clients/admin-ui/src/types/api/models/Consent.ts index 3e78c728023..e3e17345781 100644 --- a/clients/admin-ui/src/types/api/models/Consent.ts +++ b/clients/admin-ui/src/types/api/models/Consent.ts @@ -1,14 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * Consent + * * Deprecated: This used to be populated and sent to the server by a `config.json` in the UI */ export type Consent = { + /** + * Data Use + */ data_use: string; + /** + * Data Use Description + */ data_use_description?: string | null; + /** + * Opt In + */ opt_in: boolean; + /** + * Has Gpc Flag + */ has_gpc_flag?: boolean; + /** + * Conflicts With Gpc + */ conflicts_with_gpc?: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentAlertInfo.ts b/clients/admin-ui/src/types/api/models/ConsentAlertInfo.ts index 1db94558a42..84ab12c0310 100644 --- a/clients/admin-ui/src/types/api/models/ConsentAlertInfo.ts +++ b/clients/admin-ui/src/types/api/models/ConsentAlertInfo.ts @@ -1,14 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AlertLevel } from "./AlertLevel"; +import { AlertLevel } from "./AlertLevel"; /** + * ConsentAlertInfo + * * Used to summarize consent status information for a group of staged resources. */ export type ConsentAlertInfo = { /** + * Message + * * The message to display to the user */ message: string; diff --git a/clients/admin-ui/src/types/api/models/ConsentBreakdown.ts b/clients/admin-ui/src/types/api/models/ConsentBreakdown.ts index 3c7027f8f3e..f8009a26878 100644 --- a/clients/admin-ui/src/types/api/models/ConsentBreakdown.ts +++ b/clients/admin-ui/src/types/api/models/ConsentBreakdown.ts @@ -1,15 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConsentStatus } from "./ConsentStatus"; +import { ConsentStatus } from "./ConsentStatus"; import type { ConsentStatusReason } from "./ConsentStatusReason"; /** + * ConsentBreakdown + * * Response model for consent breakdown information for a given asset */ export type ConsentBreakdown = { + /** + * Location + */ location: string; + /** + * Page + */ page: string; status: ConsentStatus; reason?: ConsentStatusReason | null; diff --git a/clients/admin-ui/src/types/api/models/ConsentConfigButton.ts b/clients/admin-ui/src/types/api/models/ConsentConfigButton.ts index ef5857fb371..db528c45a7d 100644 --- a/clients/admin-ui/src/types/api/models/ConsentConfigButton.ts +++ b/clients/admin-ui/src/types/api/models/ConsentConfigButton.ts @@ -1,21 +1,48 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { fides__api__schemas__privacy_center_config__CustomPrivacyRequestField } from "./fides__api__schemas__privacy_center_config__CustomPrivacyRequestField"; import type { IdentityInputs } from "./IdentityInputs"; +import type { LocationCustomPrivacyRequestField } from "./LocationCustomPrivacyRequestField"; +/** + * ConsentConfigButton + */ export type ConsentConfigButton = { + /** + * Description + */ description: string; + /** + * Description Subtext + */ description_subtext?: Array | null; + /** + * Confirmbuttontext + */ confirmButtonText?: string | null; + /** + * Cancelbuttontext + */ cancelButtonText?: string | null; + /** + * Icon Path + */ icon_path: string; identity_inputs: IdentityInputs; - custom_privacy_request_fields?: Record< - string, - fides__api__schemas__privacy_center_config__CustomPrivacyRequestField - > | null; + /** + * Custom Privacy Request Fields + */ + custom_privacy_request_fields?: { + [key: string]: + | LocationCustomPrivacyRequestField + | fides__api__schemas__privacy_center_config__CustomPrivacyRequestField; + } | null; + /** + * Title + */ title: string; + /** + * Modaltitle + */ modalTitle?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentConfigPage.ts b/clients/admin-ui/src/types/api/models/ConsentConfigPage.ts index dd42a52c14c..be7aa904a57 100644 --- a/clients/admin-ui/src/types/api/models/ConsentConfigPage.ts +++ b/clients/admin-ui/src/types/api/models/ConsentConfigPage.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConfigConsentOption } from "./ConfigConsentOption"; +/** + * ConsentConfigPage + */ export type ConsentConfigPage = { + /** + * Consentoptions + */ consentOptions?: Array; + /** + * Description + */ description: string; + /** + * Description Subtext + */ description_subtext?: Array | null; + /** + * Policy Key + */ policy_key?: string | null; + /** + * Title + */ title: string; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentCreate.ts b/clients/admin-ui/src/types/api/models/ConsentCreate.ts index 41cf9800967..c23b48d0aed 100644 --- a/clients/admin-ui/src/types/api/models/ConsentCreate.ts +++ b/clients/admin-ui/src/types/api/models/ConsentCreate.ts @@ -1,6 +1,4 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConsentMetaCreate } from "./ConsentMetaCreate"; import type { ConsentPreferenceCreate } from "./ConsentPreferenceCreate"; @@ -8,6 +6,8 @@ import type { ConsentScopeCreate } from "./ConsentScopeCreate"; import type { fidesplus__v3__schemas__identity__Identity } from "./fidesplus__v3__schemas__identity__Identity"; /** + * ConsentCreate + * * Unified consent v3 schema. */ export type ConsentCreate = { @@ -21,6 +21,8 @@ export type ConsentCreate = { */ meta?: ConsentMetaCreate | null; /** + * Preferences + * * A list of actual preference values chosen by the subject (e.g. 'opt-in') for the given notice (e.g. 'marketing') and experience (e.g. 'US modal'). Preferences belong to the identity and can be filtered or aggregated by the scope value. */ preferences: Array; diff --git a/clients/admin-ui/src/types/api/models/ConsentInfo.ts b/clients/admin-ui/src/types/api/models/ConsentInfo.ts index 8ac0313e845..7e594e7bea0 100644 --- a/clients/admin-ui/src/types/api/models/ConsentInfo.ts +++ b/clients/admin-ui/src/types/api/models/ConsentInfo.ts @@ -1,25 +1,41 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ConsentInfo + * * API model that represents consent information for a web monitor staged resource */ export type ConsentInfo = { /** + * Default + * * Pages where the asset was found with default consent, indexed by location */ - default?: Record>; + default?: { + [key: string]: Array; + }; /** - * Pages where the asset was found without consent, indexed by location + * Denied + * + * Pages where the asset was found with denied consent, indexed by location */ - denied?: Record>; + denied?: { + [key: string]: Array; + }; /** + * Granted + * * Pages where the asset was found with consent, indexed by location */ - granted?: Record>; + granted?: { + [key: string]: Array; + }; /** + * Cmp Error + * * Pages where the asset was loaded and a CMP error was detected, indexed by location */ - cmp_error?: Record>; + cmp_error?: { + [key: string]: Array; + }; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentMechanism.ts b/clients/admin-ui/src/types/api/models/ConsentMechanism.ts index ad90085b2e8..3ca5da0f1b6 100644 --- a/clients/admin-ui/src/types/api/models/ConsentMechanism.ts +++ b/clients/admin-ui/src/types/api/models/ConsentMechanism.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ConsentMechanism + * * Enum is not formalized in the DB because it may be subject to frequent change */ export enum ConsentMechanism { diff --git a/clients/admin-ui/src/types/api/models/ConsentMetaCreate.ts b/clients/admin-ui/src/types/api/models/ConsentMetaCreate.ts index 5e6e741eec3..22b5c5c34f5 100644 --- a/clients/admin-ui/src/types/api/models/ConsentMetaCreate.ts +++ b/clients/admin-ui/src/types/api/models/ConsentMetaCreate.ts @@ -1,10 +1,10 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { FidesConsentMetaCreate } from "./FidesConsentMetaCreate"; /** + * ConsentMetaCreate + * * A set of Fides-defined metadata properties for a privacy preference. */ export type ConsentMetaCreate = { @@ -12,4 +12,5 @@ export type ConsentMetaCreate = { * A set of Fides-defined metadata properties for a privacy preference. */ fides?: FidesConsentMetaCreate | null; + [key: string]: unknown | FidesConsentMetaCreate | null | undefined; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentMetaResponse.ts b/clients/admin-ui/src/types/api/models/ConsentMetaResponse.ts index f5addc5e926..cf9f4af1bfc 100644 --- a/clients/admin-ui/src/types/api/models/ConsentMetaResponse.ts +++ b/clients/admin-ui/src/types/api/models/ConsentMetaResponse.ts @@ -1,12 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { FidesConsentMetaResponse } from "./FidesConsentMetaResponse"; /** + * ConsentMetaResponse + * * Metadata information with reserved 'fides' namespace and arbitrary additional fields */ export type ConsentMetaResponse = { fides: FidesConsentMetaResponse; + [key: string]: unknown | FidesConsentMetaResponse; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentMethod.ts b/clients/admin-ui/src/types/api/models/ConsentMethod.ts index 69ecffe7934..8b56c1078f4 100644 --- a/clients/admin-ui/src/types/api/models/ConsentMethod.ts +++ b/clients/admin-ui/src/types/api/models/ConsentMethod.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ConsentMethod + */ export enum ConsentMethod { BUTTON = "button", REJECT = "reject", diff --git a/clients/admin-ui/src/types/api/models/ConsentOptionCreate.ts b/clients/admin-ui/src/types/api/models/ConsentOptionCreate.ts index cfefe7d5aeb..1ca9a1cb432 100644 --- a/clients/admin-ui/src/types/api/models/ConsentOptionCreate.ts +++ b/clients/admin-ui/src/types/api/models/ConsentOptionCreate.ts @@ -1,13 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * ConsentOptionCreate + * * Schema for saving the user's preference for a given Privacy Notice (non-TCF Notice) */ export type ConsentOptionCreate = { + /** + * Privacy Notice History Id + */ privacy_notice_history_id: string; preference: UserConsentPreference; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentPreferenceCreate.ts b/clients/admin-ui/src/types/api/models/ConsentPreferenceCreate.ts index 3d614ea03b3..2e8b222f200 100644 --- a/clients/admin-ui/src/types/api/models/ConsentPreferenceCreate.ts +++ b/clients/admin-ui/src/types/api/models/ConsentPreferenceCreate.ts @@ -1,19 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { PreferenceMetaCreate } from "./PreferenceMetaCreate"; -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * ConsentPreferenceCreate + * * Schema representing a single preference value for a given notice (API input). */ export type ConsentPreferenceCreate = { /** + * Notice History Id + * * Identifier for the notice history */ notice_history_id: string; /** + * Notice Key + * * Key identifying the privacy notice */ notice_key: string; @@ -22,6 +26,8 @@ export type ConsentPreferenceCreate = { */ value: UserConsentPreference; /** + * Collected At + * * ISO timestamp when the preference was collected (auto-populated if not provided) */ collected_at?: string | null; diff --git a/clients/admin-ui/src/types/api/models/ConsentPreferenceResponse.ts b/clients/admin-ui/src/types/api/models/ConsentPreferenceResponse.ts index e0daa44a257..48bd292790f 100644 --- a/clients/admin-ui/src/types/api/models/ConsentPreferenceResponse.ts +++ b/clients/admin-ui/src/types/api/models/ConsentPreferenceResponse.ts @@ -1,19 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { PreferenceMeta } from "./PreferenceMeta"; -import type { UserConsentPreference } from "./UserConsentPreference"; +import type { PreferenceMetaResponse } from "./PreferenceMetaResponse"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * ConsentPreferenceResponse + * * An individual preference response (includes backend-generated fields). */ export type ConsentPreferenceResponse = { /** + * Notice History Id + * * Identifier for the notice history */ notice_history_id: string; /** + * Notice Key + * * Key identifying the privacy notice */ notice_key: string; @@ -22,11 +26,13 @@ export type ConsentPreferenceResponse = { */ value: UserConsentPreference; /** + * Collected At + * * ISO timestamp when the preference was collected (auto-populated if not provided) */ collected_at: string; /** * Metadata for a single preference value (includes backend fields like 'derived', 'override', 'source') */ - meta?: PreferenceMeta | null; + meta?: PreferenceMetaResponse | null; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentPreferences.ts b/clients/admin-ui/src/types/api/models/ConsentPreferences.ts index 2a375ea2fef..27c359f104b 100644 --- a/clients/admin-ui/src/types/api/models/ConsentPreferences.ts +++ b/clients/admin-ui/src/types/api/models/ConsentPreferences.ts @@ -1,12 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { Consent } from "./Consent"; /** + * ConsentPreferences + * * Schema for consent preferences. */ export type ConsentPreferences = { + /** + * Consent + */ consent?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentPreferencesWithVerificationCode.ts b/clients/admin-ui/src/types/api/models/ConsentPreferencesWithVerificationCode.ts index 29e01d2f8bd..571cf26cddd 100644 --- a/clients/admin-ui/src/types/api/models/ConsentPreferencesWithVerificationCode.ts +++ b/clients/admin-ui/src/types/api/models/ConsentPreferencesWithVerificationCode.ts @@ -1,18 +1,30 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { Consent } from "./Consent"; import type { ConsentWithExecutableStatus } from "./ConsentWithExecutableStatus"; -import type { Identity } from "./Identity"; +import type { fides__api__schemas__redis_cache__Identity } from "./fides__api__schemas__redis_cache__Identity"; /** + * ConsentPreferencesWithVerificationCode + * * Schema for consent preferences including the verification code. */ export type ConsentPreferencesWithVerificationCode = { + /** + * Code + */ code?: string | null; + /** + * Consent + */ consent: Array; + /** + * Policy Key + */ policy_key?: string | null; + /** + * Executable Options + */ executable_options?: Array | null; - browser_identity?: Identity | null; + browser_identity?: fides__api__schemas__redis_cache__Identity | null; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentReport.ts b/clients/admin-ui/src/types/api/models/ConsentReport.ts index d0fb06a0d93..81ebb8d5552 100644 --- a/clients/admin-ui/src/types/api/models/ConsentReport.ts +++ b/clients/admin-ui/src/types/api/models/ConsentReport.ts @@ -1,20 +1,44 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { Identity } from "./Identity"; +import type { fides__api__schemas__redis_cache__Identity } from "./fides__api__schemas__redis_cache__Identity"; /** + * ConsentReport + * * Keeps record of each of the preferences that have been recorded via ConsentReporting endpoints. */ export type ConsentReport = { + /** + * Data Use + */ data_use: string; + /** + * Data Use Description + */ data_use_description?: string | null; + /** + * Opt In + */ opt_in: boolean; + /** + * Has Gpc Flag + */ has_gpc_flag?: boolean; + /** + * Conflicts With Gpc + */ conflicts_with_gpc?: boolean; + /** + * Id + */ id: string; - identity: Identity; + identity: fides__api__schemas__redis_cache__Identity; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at: string; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentReportingSchema.ts b/clients/admin-ui/src/types/api/models/ConsentReportingSchema.ts index 33424353039..0074e1d343b 100644 --- a/clients/admin-ui/src/types/api/models/ConsentReportingSchema.ts +++ b/clients/admin-ui/src/types/api/models/ConsentReportingSchema.ts @@ -1,42 +1,125 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ActionType } from "./ActionType"; -import type { ConsentMethod } from "./ConsentMethod"; -import type { ExecutionLogStatus } from "./ExecutionLogStatus"; -import type { PrivacyRequestStatus } from "./PrivacyRequestStatus"; -import type { RequestOrigin } from "./RequestOrigin"; +import { ActionType } from "./ActionType"; +import { ConsentMethod } from "./ConsentMethod"; +import { ExecutionLogStatus } from "./ExecutionLogStatus"; +import { PrivacyRequestStatus } from "./PrivacyRequestStatus"; +import { RequestOrigin } from "./RequestOrigin"; import type { TCFPreferences } from "./TCFPreferences"; -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * ConsentReportingSchema + * * Schema for consent reporting - largely a join of PrivacyPreferenceHistory and PrivacyRequest */ export type ConsentReportingSchema = { + /** + * The PrivacyPreferenceHistory id + */ id: string; + /** + * The Privacy Request id created to propagate preferences + */ privacy_request_id?: string | null; + /** + * Email if applicable + */ email?: string | null; + /** + * Phone number if applicable + */ phone_number?: string | null; + /** + * An ID defined outside of Fides that uniquely identifies a user + */ external_id?: string | null; + /** + * Fides user device id if applicable + */ fides_user_device_id?: string | null; - secondary_user_ids?: Record | null; + /** + * Other browser identifiers + */ + secondary_user_ids?: { + [key: string]: string; + } | null; + /** + * Timestamp when Privacy Preference was saved. + */ request_timestamp: string; + /** + * Datetime when Fides received the record of preferences saved. + */ + received_at?: string | null; + /** + * Origin of request - privacy center, modal, overlay, API, etc.. + */ request_origin?: RequestOrigin | null; + /** + * Status of the Privacy Request created to propagate preferences. + */ request_status?: PrivacyRequestStatus | null; + /** + * The Type of Privacy Request. + */ request_type: ActionType; + /** + * The username of the user who approved the Privacy Request if applicable + */ approver_id?: string | null; + /** + * The id of the specific Privacy Notice History that the user consented to + */ privacy_notice_history_id?: string | null; + /** + * The user's preference for the given notice: opt_in, opt_out, or acknowledge + */ preference?: UserConsentPreference | null; + /** + * Detected geography of the user + */ user_geography?: string | null; - affected_system_status: Record; + /** + * Affected system status + */ + affected_system_status: { + [key: string]: ExecutionLogStatus; + }; + /** + * URL of page where preference was recorded + */ url_recorded?: string | null; + /** + * User agent + */ user_agent?: string | null; + /** + * The historical config for the experience that the user was presented - contains the experience language + */ experience_config_history_id?: string | null; + /** + * Truncated ip address + */ truncated_ip_address?: string | null; + /** + * Method of consent preference + */ method?: ConsentMethod | null; + /** + * The id of the record where the notice was served to the end user + */ served_notice_history_id?: string | null; + /** + * The name of the notice + */ notice_name?: string | null; + /** + * TCF Preferences saved + */ tcf_preferences?: TCFPreferences | null; + /** + * Property ID + */ property_id?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentRequestCreateExtended.ts b/clients/admin-ui/src/types/api/models/ConsentRequestCreateExtended.ts index cb49507e1b6..ffe442712b8 100644 --- a/clients/admin-ui/src/types/api/models/ConsentRequestCreateExtended.ts +++ b/clients/admin-ui/src/types/api/models/ConsentRequestCreateExtended.ts @@ -1,20 +1,25 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { fides__api__schemas__redis_cache__CustomPrivacyRequestField } from "./fides__api__schemas__redis_cache__CustomPrivacyRequestField"; -import type { Identity } from "./Identity"; -import type { PrivacyRequestSource } from "./PrivacyRequestSource"; +import type { fides__api__schemas__redis_cache__Identity } from "./fides__api__schemas__redis_cache__Identity"; +import { PrivacyRequestSource } from "./PrivacyRequestSource"; /** + * ConsentRequestCreateExtended + * * An extension of the base fides model with the addition of plus-only fields */ export type ConsentRequestCreateExtended = { - identity: Identity; - custom_privacy_request_fields?: Record< - string, - fides__api__schemas__redis_cache__CustomPrivacyRequestField - > | null; + identity: fides__api__schemas__redis_cache__Identity; + /** + * Custom Privacy Request Fields + */ + custom_privacy_request_fields?: { + [key: string]: fides__api__schemas__redis_cache__CustomPrivacyRequestField; + } | null; + /** + * Property Id + */ property_id?: string | null; source?: PrivacyRequestSource | null; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentRequestMap.ts b/clients/admin-ui/src/types/api/models/ConsentRequestMap.ts index 14b843cf5bb..4ef4b43a7f0 100644 --- a/clients/admin-ui/src/types/api/models/ConsentRequestMap.ts +++ b/clients/admin-ui/src/types/api/models/ConsentRequestMap.ts @@ -1,13 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { SaaSRequest } from "./SaaSRequest"; /** + * ConsentRequestMap + * * A map of actions to Consent requests */ export type ConsentRequestMap = { + /** + * Opt In + */ opt_in?: SaaSRequest | Array; + /** + * Opt Out + */ opt_out?: SaaSRequest | Array; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentRequestResponse.ts b/clients/admin-ui/src/types/api/models/ConsentRequestResponse.ts index 336407ac4ec..3965767ce51 100644 --- a/clients/admin-ui/src/types/api/models/ConsentRequestResponse.ts +++ b/clients/admin-ui/src/types/api/models/ConsentRequestResponse.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ConsentRequestResponse + * * Schema for consent request response. */ export type ConsentRequestResponse = { + /** + * Consent Request Id + */ consent_request_id: string; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentResponse.ts b/clients/admin-ui/src/types/api/models/ConsentResponse.ts index b3ab562480b..0e1e10f9478 100644 --- a/clients/admin-ui/src/types/api/models/ConsentResponse.ts +++ b/clients/admin-ui/src/types/api/models/ConsentResponse.ts @@ -1,6 +1,4 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConsentMetaResponse } from "./ConsentMetaResponse"; import type { ConsentPreferenceResponse } from "./ConsentPreferenceResponse"; @@ -8,11 +6,22 @@ import type { ConsentScopeResponse } from "./ConsentScopeResponse"; import type { fidesplus__v3__schemas__identity__Identity } from "./fidesplus__v3__schemas__identity__Identity"; /** + * ConsentResponse + * * Unified consent v3 schema with server-generated fields (ID, created_at, etc.). */ export type ConsentResponse = { identity: fidesplus__v3__schemas__identity__Identity; scope?: ConsentScopeResponse | null; meta: ConsentMetaResponse; + /** + * Preferences + */ preferences: Array; + /** + * Is Latest + * + * Indicates if this is the latest preference record for the given identity + */ + is_latest?: boolean | null; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentScopeCreate.ts b/clients/admin-ui/src/types/api/models/ConsentScopeCreate.ts index 5534fcbfc57..18591a29981 100644 --- a/clients/admin-ui/src/types/api/models/ConsentScopeCreate.ts +++ b/clients/admin-ui/src/types/api/models/ConsentScopeCreate.ts @@ -1,10 +1,10 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { FidesConsentScopes } from "./FidesConsentScopes"; /** + * ConsentScopeCreate + * * A reserved 'fides' namespace for Fides-defined scope properties. */ export type ConsentScopeCreate = { diff --git a/clients/admin-ui/src/types/api/models/ConsentScopeResponse.ts b/clients/admin-ui/src/types/api/models/ConsentScopeResponse.ts index 4ea6cac3397..e3c2c50af3b 100644 --- a/clients/admin-ui/src/types/api/models/ConsentScopeResponse.ts +++ b/clients/admin-ui/src/types/api/models/ConsentScopeResponse.ts @@ -1,12 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { FidesConsentScopes } from "./FidesConsentScopes"; /** + * ConsentScopeResponse + * * Scope information with reserved 'fides' namespace and arbitrary additional fields */ export type ConsentScopeResponse = { - fides: FidesConsentScopes; + /** + * A reserved 'fides' namespace for Fides-defined scope properties. + */ + fides?: FidesConsentScopes | null; + [key: string]: unknown | FidesConsentScopes | null | undefined; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentStatus.ts b/clients/admin-ui/src/types/api/models/ConsentStatus.ts index 7ba4d966307..b1d4413a99c 100644 --- a/clients/admin-ui/src/types/api/models/ConsentStatus.ts +++ b/clients/admin-ui/src/types/api/models/ConsentStatus.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ConsentStatus + * * Consent status of the asset */ export enum ConsentStatus { diff --git a/clients/admin-ui/src/types/api/models/ConsentStatusDetail.ts b/clients/admin-ui/src/types/api/models/ConsentStatusDetail.ts index 809416deb4a..acc7d1b3b00 100644 --- a/clients/admin-ui/src/types/api/models/ConsentStatusDetail.ts +++ b/clients/admin-ui/src/types/api/models/ConsentStatusDetail.ts @@ -1,11 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConsentStatus } from "./ConsentStatus"; +import { ConsentStatus } from "./ConsentStatus"; import type { ConsentStatusReason } from "./ConsentStatusReason"; /** + * ConsentStatusDetail + * * Model for storing consent_status_details for a given asset */ export type ConsentStatusDetail = { diff --git a/clients/admin-ui/src/types/api/models/ConsentStatusReason.ts b/clients/admin-ui/src/types/api/models/ConsentStatusReason.ts index 26d9b807c8f..9b12b07c836 100644 --- a/clients/admin-ui/src/types/api/models/ConsentStatusReason.ts +++ b/clients/admin-ui/src/types/api/models/ConsentStatusReason.ts @@ -1,14 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConsentMechanism } from "./ConsentMechanism"; -import type { LoadingContext } from "./LoadingContext"; +import { ConsentMechanism } from "./ConsentMechanism"; +import { LoadingContext } from "./LoadingContext"; /** + * ConsentStatusReason + * * TypedDict for storing details relevant to the consent status for a given asset */ export type ConsentStatusReason = { + /** + * Notice Key + */ notice_key: string; mechanism: ConsentMechanism; loading_context: LoadingContext; diff --git a/clients/admin-ui/src/types/api/models/ConsentWithExecutableStatus.ts b/clients/admin-ui/src/types/api/models/ConsentWithExecutableStatus.ts index 13557a15f38..ec6a27dd407 100644 --- a/clients/admin-ui/src/types/api/models/ConsentWithExecutableStatus.ts +++ b/clients/admin-ui/src/types/api/models/ConsentWithExecutableStatus.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ConsentWithExecutableStatus + * * Schema for executable consents */ export type ConsentWithExecutableStatus = { + /** + * Data Use + */ data_use: string; + /** + * Executable + */ executable: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/ConsentableItem.ts b/clients/admin-ui/src/types/api/models/ConsentableItem.ts index 5eca1e7706c..4ed00ec8c46 100644 --- a/clients/admin-ui/src/types/api/models/ConsentableItem.ts +++ b/clients/admin-ui/src/types/api/models/ConsentableItem.ts @@ -1,15 +1,33 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ConsentableItem + * * Schema to represent 3rd-party consentable items and privacy notice relationships. */ export type ConsentableItem = { + /** + * External Id + */ external_id: string; + /** + * Type + */ type: string; + /** + * Name + */ name: string; + /** + * Notice Id + */ notice_id?: string | null; + /** + * Children + */ children?: Array; + /** + * Unmapped + */ unmapped?: boolean | null; }; diff --git a/clients/admin-ui/src/types/api/models/Constraint.ts b/clients/admin-ui/src/types/api/models/Constraint.ts index 2e94f0c047c..a39ae311f9d 100644 --- a/clients/admin-ui/src/types/api/models/Constraint.ts +++ b/clients/admin-ui/src/types/api/models/Constraint.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConstraintType } from "./ConstraintType"; +import { ConstraintType } from "./ConstraintType"; /** + * Constraint + * * Base class for table constraints */ export type Constraint = { + /** + * Name + */ name: string; + /** + * Fields + */ fields: Array; type: ConstraintType; }; diff --git a/clients/admin-ui/src/types/api/models/ConstraintType.ts b/clients/admin-ui/src/types/api/models/ConstraintType.ts index 30689bc654b..b245b302d21 100644 --- a/clients/admin-ui/src/types/api/models/ConstraintType.ts +++ b/clients/admin-ui/src/types/api/models/ConstraintType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ConstraintType + * * Enum of constraint types */ export enum ConstraintType { diff --git a/clients/admin-ui/src/types/api/models/ContactDetails.ts b/clients/admin-ui/src/types/api/models/ContactDetails.ts index b603a818890..9877f5d7097 100644 --- a/clients/admin-ui/src/types/api/models/ContactDetails.ts +++ b/clients/admin-ui/src/types/api/models/ContactDetails.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ContactDetails + * * The contact details information model. * * Used to capture contact information for controllers, used @@ -13,18 +13,26 @@ */ export type ContactDetails = { /** + * Name + * * An individual name used as part of publishing contact information. Encrypted at rest on the server. */ name?: string; /** + * Address + * * An individual address used as part of publishing contact information. Encrypted at rest on the server. */ address?: string; /** + * Email + * * An individual email used as part of publishing contact information. Encrypted at rest on the server. */ email?: string; /** + * Phone + * * An individual phone number used as part of publishing contact information. Encrypted at rest on the server. */ phone?: string; diff --git a/clients/admin-ui/src/types/api/models/Continent.ts b/clients/admin-ui/src/types/api/models/Continent.ts index 39eeabb2821..f982438c677 100644 --- a/clients/admin-ui/src/types/api/models/Continent.ts +++ b/clients/admin-ui/src/types/api/models/Continent.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * Continent + * * Enum of supported continents */ export enum Continent { diff --git a/clients/admin-ui/src/types/api/models/CoreHealthCheck.ts b/clients/admin-ui/src/types/api/models/CoreHealthCheck.ts index ece2e532c9e..042ea575682 100644 --- a/clients/admin-ui/src/types/api/models/CoreHealthCheck.ts +++ b/clients/admin-ui/src/types/api/models/CoreHealthCheck.ts @@ -1,20 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * CoreHealthCheck + * * Server Healthcheck schema */ export type CoreHealthCheck = { + /** + * Webserver + */ webserver: string; + /** + * Version + */ version: string; - cache: CoreHealthCheck.cache; + /** + * Cache + */ + cache: "healthy" | "unhealthy" | "no cache configured" | "skipped"; }; - -export namespace CoreHealthCheck { - export enum cache { - HEALTHY = "healthy", - UNHEALTHY = "unhealthy", - NO_CACHE_CONFIGURED = "no cache configured", - } -} diff --git a/clients/admin-ui/src/types/api/models/CreateAssessmentRequest.ts b/clients/admin-ui/src/types/api/models/CreateAssessmentRequest.ts deleted file mode 100644 index 4bb51b44fa2..00000000000 --- a/clients/admin-ui/src/types/api/models/CreateAssessmentRequest.ts +++ /dev/null @@ -1,28 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -/** - * Request to create and queue an assessment generation task. - * - * New assessment types can be added by creating new templates in the database - * without requiring code changes. - */ -export type CreateAssessmentRequest = { - /** - * Types of assessment - each must match an active template's assessment_type or key - */ - assessment_types?: string[]; - /** - * System fides keys to assess (null = all systems) - */ - system_fides_keys?: string[] | null; - /** - * Whether to use LLM for AI-assisted answers - */ - use_llm?: boolean; - /** - * Specific LLM model to use - */ - model?: string | null; -}; diff --git a/clients/admin-ui/src/types/api/models/CreateAssessmentTaskRequest.ts b/clients/admin-ui/src/types/api/models/CreateAssessmentTaskRequest.ts new file mode 100644 index 00000000000..c0bf6bbc599 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/CreateAssessmentTaskRequest.ts @@ -0,0 +1,50 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * CreateAssessmentTaskRequest + * + * Request to create and queue an assessment generation task. + * + * Accepts lists of assessment types and system keys to generate + * assessments for multiple combinations asynchronously. + */ +export type CreateAssessmentTaskRequest = { + /** + * Assessment Types + * + * List of assessment types to generate (must match active template assessment_type or key) + */ + assessment_types: Array< + | "best_practice_pia" + | "gdpr_dpia" + | "uk_gdpr_dpia" + | "us_ca_cpra_risk_assessment" + | "us_co_cpa_dpa" + | "us_multi_state_dpa" + | "us_va_vcdpa_dpa" + >; + /** + * System Fides Keys + * + * List of system fides keys to assess (None = all systems) + */ + system_fides_keys?: Array | null; + /** + * Use Llm + * + * Whether to use LLM for AI-assisted answers + */ + use_llm?: boolean; + /** + * Model + * + * Specific LLM model to use + */ + model?: string | null; + /** + * High Risk Only + * + * Only generate assessments for declarations that meet high-risk trigger criteria + */ + high_risk_only?: boolean; +}; diff --git a/clients/admin-ui/src/types/api/models/CreateAssessmentTaskResponse.ts b/clients/admin-ui/src/types/api/models/CreateAssessmentTaskResponse.ts new file mode 100644 index 00000000000..f1674f6f804 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/CreateAssessmentTaskResponse.ts @@ -0,0 +1,21 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * CreateAssessmentTaskResponse + * + * Response returned when an assessment task is queued. + */ +export type CreateAssessmentTaskResponse = { + /** + * Task Id + */ + task_id: string; + /** + * Status + */ + status?: string; + /** + * Message + */ + message?: string; +}; diff --git a/clients/admin-ui/src/types/api/models/CreateConnectionConfigurationWithSecrets.ts b/clients/admin-ui/src/types/api/models/CreateConnectionConfigurationWithSecrets.ts index 29af1219937..7ab78439658 100644 --- a/clients/admin-ui/src/types/api/models/CreateConnectionConfigurationWithSecrets.ts +++ b/clients/admin-ui/src/types/api/models/CreateConnectionConfigurationWithSecrets.ts @@ -1,71 +1,801 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AccessLevel } from "./AccessLevel"; -import type { BigQueryDocsSchema } from "./BigQueryDocsSchema"; -import type { ConnectionType } from "./ConnectionType"; -import type { DatahubDocsSchema } from "./DatahubDocsSchema"; -import type { DynamicErasureEmailDocsSchema } from "./DynamicErasureEmailDocsSchema"; -import type { DynamoDBDocsSchema } from "./DynamoDBDocsSchema"; -import type { EmailDocsSchema } from "./EmailDocsSchema"; -import type { FidesDocsSchema } from "./FidesDocsSchema"; -import type { GoogleCloudSQLMySQLDocsSchema } from "./GoogleCloudSQLMySQLDocsSchema"; -import type { GoogleCloudSQLPostgresDocsSchema } from "./GoogleCloudSQLPostgresDocsSchema"; -import type { ManualWebhookDocsSchema } from "./ManualWebhookDocsSchema"; -import type { MariaDBDocsSchema } from "./MariaDBDocsSchema"; -import type { MongoDBDocsSchema } from "./MongoDBDocsSchema"; -import type { MSSQLDocsSchema } from "./MSSQLDocsSchema"; -import type { MySQLDocsSchema } from "./MySQLDocsSchema"; -import type { OktaDocsSchema } from "./OktaDocsSchema"; -import type { PostgreSQLDocsSchema } from "./PostgreSQLDocsSchema"; -import type { RDSMySQLDocsSchema } from "./RDSMySQLDocsSchema"; -import type { RDSPostgresDocsSchema } from "./RDSPostgresDocsSchema"; -import type { RedshiftDocsSchema } from "./RedshiftDocsSchema"; -import type { S3DocsSchema } from "./S3DocsSchema"; +import { AccessLevel } from "./AccessLevel"; +import type { AdvancedSettings } from "./AdvancedSettings"; +import type { AdvancedSettingsWithExtendedIdentityTypes } from "./AdvancedSettingsWithExtendedIdentityTypes"; +import { AWSAuthMethod } from "./AWSAuthMethod"; +import { ConnectionType } from "./ConnectionType"; +import type { fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds } from "./fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds"; +import type { fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds } from "./fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds"; +import type { fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds } from "./fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds"; +import type { FidesDatasetReference } from "./FidesDatasetReference"; +import { GoogleCloudSQLIPType } from "./GoogleCloudSQLIPType"; +import { MySQLSSLMode } from "./MySQLSSLMode"; +import { PeriodicIntegrationFrequency } from "./PeriodicIntegrationFrequency"; import type { SaaSSchema } from "./SaaSSchema"; -import type { ScyllaDocsSchema } from "./ScyllaDocsSchema"; -import type { SnowflakeDocsSchema } from "./SnowflakeDocsSchema"; -import type { SovrnDocsSchema } from "./SovrnDocsSchema"; -import type { TimescaleDocsSchema } from "./TimescaleDocsSchema"; import type { WebsiteSchema } from "./WebsiteSchema"; /** + * CreateConnectionConfigurationWithSecrets + * * Schema for creating a connection configuration including secrets. */ export type CreateConnectionConfigurationWithSecrets = { + /** + * Name + */ name?: string | null; + /** + * Key + */ key?: string | null; connection_type: ConnectionType; access: AccessLevel; + /** + * Disabled + */ disabled?: boolean | null; + /** + * Description + */ description?: string | null; + /** + * Secrets + */ secrets?: - | BigQueryDocsSchema - | DatahubDocsSchema - | DynamicErasureEmailDocsSchema - | DynamoDBDocsSchema - | EmailDocsSchema - | FidesDocsSchema - | GoogleCloudSQLMySQLDocsSchema - | GoogleCloudSQLPostgresDocsSchema - | ManualWebhookDocsSchema - | MariaDBDocsSchema - | MongoDBDocsSchema - | MSSQLDocsSchema - | MySQLDocsSchema - | OktaDocsSchema - | PostgreSQLDocsSchema - | RDSMySQLDocsSchema - | RDSPostgresDocsSchema - | RedshiftDocsSchema - | S3DocsSchema + | { + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds; + /** + * Dataset + * + * Only provide a dataset to scope discovery monitors and privacy request automation to a specific BigQuery dataset. In most cases, this can be left blank. + */ + dataset?: string | null; + } + | { + /** + * DataHub server URL + * + * The URL of your DataHub server. + */ + datahub_server_url: string; + /** + * DataHub token + * + * The token used to authenticate with your DataHub server. + */ + datahub_token: string; + /** + * Frequency + * + * The frequency at which the integration should run. Available options are daily, weekly, monthly, and not scheduled. + */ + frequency: PeriodicIntegrationFrequency; + /** + * Glossary node + * + * The glossary node name to use on Datahub for Fides Data Categories. (e.g. FidesDataCategories) + */ + glossary_node: string; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettings; + /** + * Third party vendor name field + * + * Dataset reference to the field containing the third party vendor name. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. + */ + third_party_vendor_name: FidesDatasetReference; + /** + * Recipient email address field + * + * Dataset reference to the field containing the recipient email address. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. + */ + recipient_email_address: FidesDatasetReference; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * Region + * + * The AWS region where your DynamoDB table is located (ex. us-west-2). + */ + region_name: string; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettings; + /** + * Third Party Vendor Name + */ + third_party_vendor_name: string; + /** + * Recipient Email Address + */ + recipient_email_address: string; + } + | { + /** + * Uri + */ + uri: string; + /** + * Username + */ + username: string; + /** + * Password + */ + password: string; + /** + * Polling Timeout + */ + polling_timeout?: number | null; + /** + * Polling Interval + */ + polling_interval?: number | null; + } + | { + /** + * DB IAM user + * + * example: service-account@test.iam.gserviceaccount.com + */ + db_iam_user: string; + /** + * Instance connection name + * + * example: friendly-tower-424214-n8:us-central1:test-ethyca + */ + instance_connection_name: string; + /** + * Database name + */ + dbname: string; + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds; + /** + * IP type + * + * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview + */ + ip_type?: GoogleCloudSQLIPType | null; + } + | { + /** + * DB IAM user + * + * example: service-account@test.iam.gserviceaccount.com + */ + db_iam_user: string; + /** + * Instance connection name + * + * example: friendly-tower-424214-n8:us-central1:test-ethyca + */ + instance_connection_name: string; + /** + * Database name + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds; + /** + * IP type + * + * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview + */ + ip_type?: GoogleCloudSQLIPType | null; + } + | { + /** + * Access Token + */ + access_token?: string | null; + /** + * Refresh Token + */ + refresh_token?: string | null; + /** + * Token Expiry + */ + token_expiry?: string | null; + /** + * Cloud Id + */ + cloud_id?: string | null; + /** + * Site Url + */ + site_url?: string | null; + } + | { + [key: string]: unknown; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 3306). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 27017). Port will be ignored if using SRV. + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Default auth DB + * + * Used to specify the default authentication database. + */ + defaultauthdb: string; + /** + * Use SRV + * + * Enable SRV record lookup for service discovery (mongodb+srv://). Required for MongoDB Atlas. Enables SSL by default. + */ + use_srv?: boolean | null; + /** + * SSL enabled + * + * Enable SSL/TLS encryption. With SRV: defaults to enabled (can override). Without SRV: defaults to disabled. + */ + ssl_enabled?: boolean | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 1433). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Read Only Connection + * + * Whether to connect to the database in read-only mode. + */ + read_only_connection?: boolean | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 3306). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname: string; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your MySQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * SSL Mode + * + * The SSL mode to use for the connection. Accepted values are: 'required', 'preferred', 'disabled', or an empty value. + */ + ssl_mode?: MySQLSSLMode | null; + } + | { + /** + * Organization URL + * + * The URL of your Okta organization (e.g. https://your-org.okta.com) + */ + org_url: string; + /** + * OAuth2 Client ID + * + * The OAuth2 client ID from your Okta service application + */ + client_id: string; + /** + * Private Key + * + * RSA private key in JWK (JSON) format for signing JWT assertions. Download from Okta: Applications > Your App > Sign On > Client Credentials > Edit > Generate new key. + */ + private_key: string; + /** + * OAuth2 Scopes + * + * OAuth2 scopes to request (default: okta.apps.read) + */ + scopes?: Array | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5432). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSL Mode + */ + ssl_mode?: string | null; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * DB Username + * + * The user account used to authenticate and access the databases. + */ + db_username?: string; + /** + * Region + * + * The AWS region where the RDS instances are located. + */ + region: string; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * DB Username + * + * The user account used to authenticate and access the databases. + */ + db_username?: string; + /** + * Region + * + * The AWS region where the RDS instances are located. + */ + region: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5439). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + user: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + database: string; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your Redshift database is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + } | SaaSSchema - | ScyllaDocsSchema - | SnowflakeDocsSchema - | SovrnDocsSchema - | TimescaleDocsSchema + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 9042). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Keyspace + * + * The keyspace used. If not provided, DSRs for this integration will error. If the integration is used for D & D, then setting a keyspace is not required. + */ + keyspace?: string | null; + } + | { + /** + * Account Name + * + * The unique identifier for your Snowflake account. + */ + account_identifier: string; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + user_login_name: string; + /** + * Password + * + * The password used to authenticate and access the database. You can use a password or a private key, but not both. + */ + password?: string | null; + /** + * Private key + * + * The private key used to authenticate and access the database. If a `private_key_passphrase` is also provided, it is assumed to be encrypted; otherwise, it is assumed to be unencrypted. + */ + private_key?: string | null; + /** + * Passphrase + * + * The passphrase used for the encrypted private key. + */ + private_key_passphrase?: string | null; + /** + * Warehouse + * + * The name of the Snowflake warehouse where your queries will be executed. + */ + warehouse_name: string; + /** + * Database + * + * Only provide a database name to scope discovery monitors and privacy request automation to a specific database. In most cases, this can be left blank. + */ + database_name?: string | null; + /** + * Schema + * + * Only provide a schema to scope discovery monitors and privacy request automation to a specific schema. In most cases, this can be left blank. + */ + schema_name?: string | null; + /** + * Role + * + * The Snowflake role to assume for the session, if different than Username. + */ + role_name?: string | null; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettingsWithExtendedIdentityTypes; + /** + * Third Party Vendor Name + */ + third_party_vendor_name?: string; + /** + * Recipient Email Address + */ + recipient_email_address?: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5432). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSL Mode + */ + ssl_mode?: string | null; + } | WebsiteSchema | null; + /** + * Saas Connector Type + */ saas_connector_type?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/CreateConnectionConfigurationWithSecretsExtended.ts b/clients/admin-ui/src/types/api/models/CreateConnectionConfigurationWithSecretsExtended.ts index b51d244b9ea..27eaf2385df 100644 --- a/clients/admin-ui/src/types/api/models/CreateConnectionConfigurationWithSecretsExtended.ts +++ b/clients/admin-ui/src/types/api/models/CreateConnectionConfigurationWithSecretsExtended.ts @@ -1,73 +1,806 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AccessLevel } from "./AccessLevel"; -import type { ActionType } from "./ActionType"; -import type { BigQueryDocsSchema } from "./BigQueryDocsSchema"; -import type { ConnectionType } from "./ConnectionType"; -import type { DatahubDocsSchema } from "./DatahubDocsSchema"; -import type { DynamicErasureEmailDocsSchema } from "./DynamicErasureEmailDocsSchema"; -import type { DynamoDBDocsSchema } from "./DynamoDBDocsSchema"; -import type { EmailDocsSchema } from "./EmailDocsSchema"; -import type { FidesDocsSchema } from "./FidesDocsSchema"; -import type { GoogleCloudSQLMySQLDocsSchema } from "./GoogleCloudSQLMySQLDocsSchema"; -import type { GoogleCloudSQLPostgresDocsSchema } from "./GoogleCloudSQLPostgresDocsSchema"; -import type { ManualWebhookDocsSchema } from "./ManualWebhookDocsSchema"; -import type { MariaDBDocsSchema } from "./MariaDBDocsSchema"; -import type { MongoDBDocsSchema } from "./MongoDBDocsSchema"; -import type { MSSQLDocsSchema } from "./MSSQLDocsSchema"; -import type { MySQLDocsSchema } from "./MySQLDocsSchema"; -import type { OktaDocsSchema } from "./OktaDocsSchema"; -import type { PostgreSQLDocsSchema } from "./PostgreSQLDocsSchema"; -import type { RDSMySQLDocsSchema } from "./RDSMySQLDocsSchema"; -import type { RDSPostgresDocsSchema } from "./RDSPostgresDocsSchema"; -import type { RedshiftDocsSchema } from "./RedshiftDocsSchema"; -import type { S3DocsSchema } from "./S3DocsSchema"; +import { AccessLevel } from "./AccessLevel"; +import { ActionType } from "./ActionType"; +import type { AdvancedSettings } from "./AdvancedSettings"; +import type { AdvancedSettingsWithExtendedIdentityTypes } from "./AdvancedSettingsWithExtendedIdentityTypes"; +import { AWSAuthMethod } from "./AWSAuthMethod"; +import { ConnectionType } from "./ConnectionType"; +import type { fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds } from "./fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds"; +import type { fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds } from "./fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds"; +import type { fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds } from "./fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds"; +import type { FidesDatasetReference } from "./FidesDatasetReference"; +import { GoogleCloudSQLIPType } from "./GoogleCloudSQLIPType"; +import { MySQLSSLMode } from "./MySQLSSLMode"; +import { PeriodicIntegrationFrequency } from "./PeriodicIntegrationFrequency"; import type { SaaSSchema } from "./SaaSSchema"; -import type { ScyllaDocsSchema } from "./ScyllaDocsSchema"; -import type { SnowflakeDocsSchema } from "./SnowflakeDocsSchema"; -import type { SovrnDocsSchema } from "./SovrnDocsSchema"; -import type { TimescaleDocsSchema } from "./TimescaleDocsSchema"; import type { WebsiteSchema } from "./WebsiteSchema"; /** + * CreateConnectionConfigurationWithSecretsExtended + * * An extension of the base fides model with the addition of plus-only fields */ export type CreateConnectionConfigurationWithSecretsExtended = { + /** + * Name + */ name?: string | null; + /** + * Key + */ key?: string | null; connection_type: ConnectionType; access: AccessLevel; + /** + * Disabled + */ disabled?: boolean | null; + /** + * Description + */ description?: string | null; + /** + * Secrets + */ secrets?: - | BigQueryDocsSchema - | DatahubDocsSchema - | DynamicErasureEmailDocsSchema - | DynamoDBDocsSchema - | EmailDocsSchema - | FidesDocsSchema - | GoogleCloudSQLMySQLDocsSchema - | GoogleCloudSQLPostgresDocsSchema - | ManualWebhookDocsSchema - | MariaDBDocsSchema - | MongoDBDocsSchema - | MSSQLDocsSchema - | MySQLDocsSchema - | OktaDocsSchema - | PostgreSQLDocsSchema - | RDSMySQLDocsSchema - | RDSPostgresDocsSchema - | RedshiftDocsSchema - | S3DocsSchema + | { + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds; + /** + * Dataset + * + * Only provide a dataset to scope discovery monitors and privacy request automation to a specific BigQuery dataset. In most cases, this can be left blank. + */ + dataset?: string | null; + } + | { + /** + * DataHub server URL + * + * The URL of your DataHub server. + */ + datahub_server_url: string; + /** + * DataHub token + * + * The token used to authenticate with your DataHub server. + */ + datahub_token: string; + /** + * Frequency + * + * The frequency at which the integration should run. Available options are daily, weekly, monthly, and not scheduled. + */ + frequency: PeriodicIntegrationFrequency; + /** + * Glossary node + * + * The glossary node name to use on Datahub for Fides Data Categories. (e.g. FidesDataCategories) + */ + glossary_node: string; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettings; + /** + * Third party vendor name field + * + * Dataset reference to the field containing the third party vendor name. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. + */ + third_party_vendor_name: FidesDatasetReference; + /** + * Recipient email address field + * + * Dataset reference to the field containing the recipient email address. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. + */ + recipient_email_address: FidesDatasetReference; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * Region + * + * The AWS region where your DynamoDB table is located (ex. us-west-2). + */ + region_name: string; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettings; + /** + * Third Party Vendor Name + */ + third_party_vendor_name: string; + /** + * Recipient Email Address + */ + recipient_email_address: string; + } + | { + /** + * Uri + */ + uri: string; + /** + * Username + */ + username: string; + /** + * Password + */ + password: string; + /** + * Polling Timeout + */ + polling_timeout?: number | null; + /** + * Polling Interval + */ + polling_interval?: number | null; + } + | { + /** + * DB IAM user + * + * example: service-account@test.iam.gserviceaccount.com + */ + db_iam_user: string; + /** + * Instance connection name + * + * example: friendly-tower-424214-n8:us-central1:test-ethyca + */ + instance_connection_name: string; + /** + * Database name + */ + dbname: string; + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds; + /** + * IP type + * + * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview + */ + ip_type?: GoogleCloudSQLIPType | null; + } + | { + /** + * DB IAM user + * + * example: service-account@test.iam.gserviceaccount.com + */ + db_iam_user: string; + /** + * Instance connection name + * + * example: friendly-tower-424214-n8:us-central1:test-ethyca + */ + instance_connection_name: string; + /** + * Database name + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds; + /** + * IP type + * + * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview + */ + ip_type?: GoogleCloudSQLIPType | null; + } + | { + /** + * Access Token + */ + access_token?: string | null; + /** + * Refresh Token + */ + refresh_token?: string | null; + /** + * Token Expiry + */ + token_expiry?: string | null; + /** + * Cloud Id + */ + cloud_id?: string | null; + /** + * Site Url + */ + site_url?: string | null; + } + | { + [key: string]: unknown; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 3306). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 27017). Port will be ignored if using SRV. + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Default auth DB + * + * Used to specify the default authentication database. + */ + defaultauthdb: string; + /** + * Use SRV + * + * Enable SRV record lookup for service discovery (mongodb+srv://). Required for MongoDB Atlas. Enables SSL by default. + */ + use_srv?: boolean | null; + /** + * SSL enabled + * + * Enable SSL/TLS encryption. With SRV: defaults to enabled (can override). Without SRV: defaults to disabled. + */ + ssl_enabled?: boolean | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 1433). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Read Only Connection + * + * Whether to connect to the database in read-only mode. + */ + read_only_connection?: boolean | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 3306). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname: string; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your MySQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * SSL Mode + * + * The SSL mode to use for the connection. Accepted values are: 'required', 'preferred', 'disabled', or an empty value. + */ + ssl_mode?: MySQLSSLMode | null; + } + | { + /** + * Organization URL + * + * The URL of your Okta organization (e.g. https://your-org.okta.com) + */ + org_url: string; + /** + * OAuth2 Client ID + * + * The OAuth2 client ID from your Okta service application + */ + client_id: string; + /** + * Private Key + * + * RSA private key in JWK (JSON) format for signing JWT assertions. Download from Okta: Applications > Your App > Sign On > Client Credentials > Edit > Generate new key. + */ + private_key: string; + /** + * OAuth2 Scopes + * + * OAuth2 scopes to request (default: okta.apps.read) + */ + scopes?: Array | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5432). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSL Mode + */ + ssl_mode?: string | null; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * DB Username + * + * The user account used to authenticate and access the databases. + */ + db_username?: string; + /** + * Region + * + * The AWS region where the RDS instances are located. + */ + region: string; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * DB Username + * + * The user account used to authenticate and access the databases. + */ + db_username?: string; + /** + * Region + * + * The AWS region where the RDS instances are located. + */ + region: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5439). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + user: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + database: string; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your Redshift database is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + } | SaaSSchema - | ScyllaDocsSchema - | SnowflakeDocsSchema - | SovrnDocsSchema - | TimescaleDocsSchema + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 9042). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Keyspace + * + * The keyspace used. If not provided, DSRs for this integration will error. If the integration is used for D & D, then setting a keyspace is not required. + */ + keyspace?: string | null; + } + | { + /** + * Account Name + * + * The unique identifier for your Snowflake account. + */ + account_identifier: string; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + user_login_name: string; + /** + * Password + * + * The password used to authenticate and access the database. You can use a password or a private key, but not both. + */ + password?: string | null; + /** + * Private key + * + * The private key used to authenticate and access the database. If a `private_key_passphrase` is also provided, it is assumed to be encrypted; otherwise, it is assumed to be unencrypted. + */ + private_key?: string | null; + /** + * Passphrase + * + * The passphrase used for the encrypted private key. + */ + private_key_passphrase?: string | null; + /** + * Warehouse + * + * The name of the Snowflake warehouse where your queries will be executed. + */ + warehouse_name: string; + /** + * Database + * + * Only provide a database name to scope discovery monitors and privacy request automation to a specific database. In most cases, this can be left blank. + */ + database_name?: string | null; + /** + * Schema + * + * Only provide a schema to scope discovery monitors and privacy request automation to a specific schema. In most cases, this can be left blank. + */ + schema_name?: string | null; + /** + * Role + * + * The Snowflake role to assume for the session, if different than Username. + */ + role_name?: string | null; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettingsWithExtendedIdentityTypes; + /** + * Third Party Vendor Name + */ + third_party_vendor_name?: string; + /** + * Recipient Email Address + */ + recipient_email_address?: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5432). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSL Mode + */ + ssl_mode?: string | null; + } | WebsiteSchema | null; + /** + * Saas Connector Type + */ saas_connector_type?: string | null; + /** + * Enabled Actions + */ enabled_actions: Array; }; diff --git a/clients/admin-ui/src/types/api/models/CreateExportPrivacyPreferencesJobRequest.ts b/clients/admin-ui/src/types/api/models/CreateExportPrivacyPreferencesJobRequest.ts new file mode 100644 index 00000000000..a9f66980d4e --- /dev/null +++ b/clients/admin-ui/src/types/api/models/CreateExportPrivacyPreferencesJobRequest.ts @@ -0,0 +1,19 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * CreateExportPrivacyPreferencesJobRequest + */ +export type CreateExportPrivacyPreferencesJobRequest = { + /** + * Destination Url + * + * The destination URL to export to (i.e s3://target-bucket/prefix) + */ + destination_url: string; + /** + * Batch Size + * + * Batch size for exports (1-1000); default is 100 + */ + batch_size?: number; +}; diff --git a/clients/admin-ui/src/types/api/models/CreateExportPrivacyPreferencesJobResponse.ts b/clients/admin-ui/src/types/api/models/CreateExportPrivacyPreferencesJobResponse.ts new file mode 100644 index 00000000000..c05771883b5 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/CreateExportPrivacyPreferencesJobResponse.ts @@ -0,0 +1,11 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * CreateExportPrivacyPreferencesJobResponse + */ +export type CreateExportPrivacyPreferencesJobResponse = { + /** + * Job Id + */ + job_id?: string; +}; diff --git a/clients/admin-ui/src/types/api/models/CreateIngestionPrivacyPreferencesJobRequest.ts b/clients/admin-ui/src/types/api/models/CreateIngestionPrivacyPreferencesJobRequest.ts new file mode 100644 index 00000000000..edc89ac9bb8 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/CreateIngestionPrivacyPreferencesJobRequest.ts @@ -0,0 +1,13 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * CreateIngestionPrivacyPreferencesJobRequest + */ +export type CreateIngestionPrivacyPreferencesJobRequest = { + /** + * Source Url + * + * The source URL to import from (i.e s3://target-bucket/prefix) + */ + source_url: string; +}; diff --git a/clients/admin-ui/src/types/api/models/CreateIngestionPrivacyPreferencesJobResponse.ts b/clients/admin-ui/src/types/api/models/CreateIngestionPrivacyPreferencesJobResponse.ts new file mode 100644 index 00000000000..367743258d1 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/CreateIngestionPrivacyPreferencesJobResponse.ts @@ -0,0 +1,11 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * CreateIngestionPrivacyPreferencesJobResponse + */ +export type CreateIngestionPrivacyPreferencesJobResponse = { + /** + * Job Id + */ + job_id?: string; +}; diff --git a/clients/admin-ui/src/types/api/models/CurrentStep.ts b/clients/admin-ui/src/types/api/models/CurrentStep.ts index 9803596dd20..fb92f22f9bb 100644 --- a/clients/admin-ui/src/types/api/models/CurrentStep.ts +++ b/clients/admin-ui/src/types/api/models/CurrentStep.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * CurrentStep + */ export enum CurrentStep { PRE_WEBHOOKS = "pre_webhooks", ACCESS = "access", diff --git a/clients/admin-ui/src/types/api/models/CursorPage_DatastoreStagedResourceTreeAPIResponse_.ts b/clients/admin-ui/src/types/api/models/CursorPage_DatastoreStagedResourceTreeAPIResponse_.ts index ceec100e3d9..466e986558a 100644 --- a/clients/admin-ui/src/types/api/models/CursorPage_DatastoreStagedResourceTreeAPIResponse_.ts +++ b/clients/admin-ui/src/types/api/models/CursorPage_DatastoreStagedResourceTreeAPIResponse_.ts @@ -1,25 +1,40 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { DatastoreStagedResourceTreeAPIResponse } from "./DatastoreStagedResourceTreeAPIResponse"; +/** + * CursorPage[DatastoreStagedResourceTreeAPIResponse] + */ export type CursorPage_DatastoreStagedResourceTreeAPIResponse_ = { + /** + * Items + */ items: Array; + /** + * Total + */ total: number; /** + * Current Page + * * Cursor to refetch the current page */ current_page?: string | null; /** + * Current Page Backwards + * * Cursor to refetch the current page starting from the last item */ current_page_backwards?: string | null; /** + * Previous Page + * * Cursor for the previous page */ previous_page?: string | null; /** + * Next Page + * * Cursor for the next page */ next_page?: string | null; diff --git a/clients/admin-ui/src/types/api/models/CustomAssetType.ts b/clients/admin-ui/src/types/api/models/CustomAssetType.ts index e87b695dbfe..b0f81c93878 100644 --- a/clients/admin-ui/src/types/api/models/CustomAssetType.ts +++ b/clients/admin-ui/src/types/api/models/CustomAssetType.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * CustomAssetType + */ export enum CustomAssetType { CUSTOM_FIDES_CSS = "custom-fides.css", } diff --git a/clients/admin-ui/src/types/api/models/CustomField.ts b/clients/admin-ui/src/types/api/models/CustomField.ts index 2fe84db3140..89cb0f4a1c7 100644 --- a/clients/admin-ui/src/types/api/models/CustomField.ts +++ b/clients/admin-ui/src/types/api/models/CustomField.ts @@ -1,9 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * CustomField + */ export type CustomField = { + /** + * Resource Id + */ resource_id: string; + /** + * Custom Field Definition Id + */ custom_field_definition_id: string; + /** + * Value + */ value: string | Array; }; diff --git a/clients/admin-ui/src/types/api/models/CustomFieldDefinition.ts b/clients/admin-ui/src/types/api/models/CustomFieldDefinition.ts index fb4386eacb1..7e0c206dc61 100644 --- a/clients/admin-ui/src/types/api/models/CustomFieldDefinition.ts +++ b/clients/admin-ui/src/types/api/models/CustomFieldDefinition.ts @@ -1,16 +1,38 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AllowedTypes } from "./AllowedTypes"; -import type { ResourceTypes } from "./ResourceTypes"; +import { AllowedTypes } from "./AllowedTypes"; +import { ResourceTypes } from "./ResourceTypes"; +/** + * CustomFieldDefinition + */ export type CustomFieldDefinition = { + /** + * Name + */ name: string; + /** + * Description + */ description?: string | null; + /** + * Field Type + */ field_type: AllowedTypes | string; + /** + * Allow List Id + */ allow_list_id?: string | null; + /** + * Resource Type + */ resource_type: ResourceTypes | string; + /** + * Field Definition + */ field_definition?: string | null; + /** + * Active + */ active?: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/CustomFieldDefinitionResponse.ts b/clients/admin-ui/src/types/api/models/CustomFieldDefinitionResponse.ts index 9f581049c87..40713c9910b 100644 --- a/clients/admin-ui/src/types/api/models/CustomFieldDefinitionResponse.ts +++ b/clients/admin-ui/src/types/api/models/CustomFieldDefinitionResponse.ts @@ -1,18 +1,46 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AllowedTypes } from "./AllowedTypes"; -import type { ResourceTypes } from "./ResourceTypes"; +import { AllowedTypes } from "./AllowedTypes"; +import { ResourceTypes } from "./ResourceTypes"; +/** + * CustomFieldDefinitionResponse + */ export type CustomFieldDefinitionResponse = { + /** + * Name + */ name: string; + /** + * Description + */ description?: string | null; + /** + * Field Type + */ field_type: AllowedTypes | string; + /** + * Allow List Id + */ allow_list_id?: string | null; + /** + * Resource Type + */ resource_type: ResourceTypes | string; + /** + * Field Definition + */ field_definition?: string | null; + /** + * Active + */ active?: boolean; + /** + * Id + */ id: string; + /** + * Created At + */ created_at: string; }; diff --git a/clients/admin-ui/src/types/api/models/CustomFieldDefinitionWithId.ts b/clients/admin-ui/src/types/api/models/CustomFieldDefinitionWithId.ts index de9cef2d34e..78e62d53f6a 100644 --- a/clients/admin-ui/src/types/api/models/CustomFieldDefinitionWithId.ts +++ b/clients/admin-ui/src/types/api/models/CustomFieldDefinitionWithId.ts @@ -1,17 +1,42 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AllowedTypes } from "./AllowedTypes"; -import type { ResourceTypes } from "./ResourceTypes"; +import { AllowedTypes } from "./AllowedTypes"; +import { ResourceTypes } from "./ResourceTypes"; +/** + * CustomFieldDefinitionWithId + */ export type CustomFieldDefinitionWithId = { + /** + * Name + */ name: string; + /** + * Description + */ description?: string | null; + /** + * Field Type + */ field_type: AllowedTypes | string; + /** + * Allow List Id + */ allow_list_id?: string | null; + /** + * Resource Type + */ resource_type: ResourceTypes | string; + /** + * Field Definition + */ field_definition?: string | null; + /** + * Active + */ active?: boolean; + /** + * Id + */ id?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/CustomFieldWithId.ts b/clients/admin-ui/src/types/api/models/CustomFieldWithId.ts index 781f990e391..b5c27e3675f 100644 --- a/clients/admin-ui/src/types/api/models/CustomFieldWithId.ts +++ b/clients/admin-ui/src/types/api/models/CustomFieldWithId.ts @@ -1,10 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * CustomFieldWithId + */ export type CustomFieldWithId = { + /** + * Resource Id + */ resource_id: string; + /** + * Custom Field Definition Id + */ custom_field_definition_id: string; + /** + * Value + */ value: string | Array; + /** + * Id + */ id?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/CustomReportConfig.ts b/clients/admin-ui/src/types/api/models/CustomReportConfig.ts index 7b2ad8f47b8..b67edb7263e 100644 --- a/clients/admin-ui/src/types/api/models/CustomReportConfig.ts +++ b/clients/admin-ui/src/types/api/models/CustomReportConfig.ts @@ -1,19 +1,27 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ColumnMapItem } from "./ColumnMapItem"; /** + * CustomReportConfig + * * The configuration for a custom report. */ export type CustomReportConfig = { /** + * Table State + * * Flexible dictionary storing UI-specific table state data without a fixed schema */ - table_state?: any; + table_state?: { + [key: string]: unknown; + }; /** + * Column Map + * * A map between column keys and custom labels */ - column_map?: Record; + column_map?: { + [key: string]: ColumnMapItem; + }; }; diff --git a/clients/admin-ui/src/types/api/models/CustomReportCreate.ts b/clients/admin-ui/src/types/api/models/CustomReportCreate.ts index b2d33b0da23..a2ac5c1ab84 100644 --- a/clients/admin-ui/src/types/api/models/CustomReportCreate.ts +++ b/clients/admin-ui/src/types/api/models/CustomReportCreate.ts @@ -1,14 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { CustomReportConfig } from "./CustomReportConfig"; -import type { ReportType } from "./ReportType"; +import { ReportType } from "./ReportType"; /** + * CustomReportCreate + * * Schema to create a new custom report. */ export type CustomReportCreate = { + /** + * Name + */ name: string; type: ReportType; config: CustomReportConfig; diff --git a/clients/admin-ui/src/types/api/models/CustomReportResponse.ts b/clients/admin-ui/src/types/api/models/CustomReportResponse.ts index 191961f7e0a..3f0d928ac76 100644 --- a/clients/admin-ui/src/types/api/models/CustomReportResponse.ts +++ b/clients/admin-ui/src/types/api/models/CustomReportResponse.ts @@ -1,16 +1,22 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { CustomReportConfig } from "./CustomReportConfig"; -import type { ReportType } from "./ReportType"; +import { ReportType } from "./ReportType"; /** + * CustomReportResponse + * * Response containing the basic custom report information along with the actual custom report configuration. */ export type CustomReportResponse = { + /** + * Id + */ id: string; type: ReportType; + /** + * Name + */ name: string; config: CustomReportConfig; }; diff --git a/clients/admin-ui/src/types/api/models/CustomReportResponseMinimal.ts b/clients/admin-ui/src/types/api/models/CustomReportResponseMinimal.ts index b36401b9044..d4bb5b351b4 100644 --- a/clients/admin-ui/src/types/api/models/CustomReportResponseMinimal.ts +++ b/clients/admin-ui/src/types/api/models/CustomReportResponseMinimal.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ReportType } from "./ReportType"; +import { ReportType } from "./ReportType"; /** + * CustomReportResponseMinimal + * * Simple schema just containing the basic custom report information. */ export type CustomReportResponseMinimal = { + /** + * Id + */ id: string; type: ReportType; + /** + * Name + */ name: string; }; diff --git a/clients/admin-ui/src/types/api/models/CustomTaxonomyColor.ts b/clients/admin-ui/src/types/api/models/CustomTaxonomyColor.ts index a2baac2e000..7d8fee963c9 100644 --- a/clients/admin-ui/src/types/api/models/CustomTaxonomyColor.ts +++ b/clients/admin-ui/src/types/api/models/CustomTaxonomyColor.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * CustomTaxonomyColor + */ export enum CustomTaxonomyColor { TAXONOMY_WHITE = "taxonomy_white", TAXONOMY_RED = "taxonomy_red", diff --git a/clients/admin-ui/src/types/api/models/DATAMAP_GROUPING.ts b/clients/admin-ui/src/types/api/models/DATAMAP_GROUPING.ts index c0a1dbab4bd..10e6daa4264 100644 --- a/clients/admin-ui/src/types/api/models/DATAMAP_GROUPING.ts +++ b/clients/admin-ui/src/types/api/models/DATAMAP_GROUPING.ts @@ -1,12 +1,12 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DATAMAP_GROUPING + * * Allowed column groupings for the minimal datamap report */ export enum DATAMAP_GROUPING { - SYSTEM_DATA_USE = "system, data_use", - DATA_USE_SYSTEM = "data_use, system", + "SYSTEM,_DATA_USE" = "system, data_use", + "DATA_USE,_SYSTEM" = "data_use, system", SYSTEM_GROUP = "system_group", } diff --git a/clients/admin-ui/src/types/api/models/DBActions.ts b/clients/admin-ui/src/types/api/models/DBActions.ts index 794b6da4f76..2e6b833e5a2 100644 --- a/clients/admin-ui/src/types/api/models/DBActions.ts +++ b/clients/admin-ui/src/types/api/models/DBActions.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DBActions + * * The available path parameters for the `/admin/db/{action}` endpoint. */ export enum DBActions { diff --git a/clients/admin-ui/src/types/api/models/DataCategory.ts b/clients/admin-ui/src/types/api/models/DataCategory.ts index 7fd7fed3496..709527bc9a9 100644 --- a/clients/admin-ui/src/types/api/models/DataCategory.ts +++ b/clients/admin-ui/src/types/api/models/DataCategory.ts @@ -1,44 +1,75 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * DataCategory + */ export type DataCategory = { /** + * Version Added + * * The version of Fideslang in which this label was added. */ version_added?: string | null; /** + * Version Deprecated + * * The version of Fideslang in which this label was deprecated. */ version_deprecated?: string | null; /** + * Replaced By + * * The new name, if applicable, for this label after deprecation. */ replaced_by?: string | null; /** + * Is Default + * * Denotes whether the resource is part of the default taxonomy or not. */ is_default?: boolean; /** + * Fides Key + * * A unique key used to identify this resource. */ fides_key: string; /** + * Organization Fides Key + * * Defines the Organization that this resource belongs to. */ organization_fides_key?: string; + /** + * Tags + */ tags?: Array | null; /** + * Name + * * Human-Readable name for this resource. */ name?: string | null; /** + * Description + * * A detailed description of what this resource is. */ description?: string | null; + /** + * Parent Key + */ parent_key?: string | null; /** + * Active + * * Indicates whether the resource is currently 'active'. */ active?: boolean; + /** + * Tagging Instructions + * + * Instructions for LLM-based data classification tagging. + */ + tagging_instructions?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/DataCategoryCreateOrUpdate.ts b/clients/admin-ui/src/types/api/models/DataCategoryCreateOrUpdate.ts index 11e09fa1b48..af56e093ea2 100644 --- a/clients/admin-ui/src/types/api/models/DataCategoryCreateOrUpdate.ts +++ b/clients/admin-ui/src/types/api/models/DataCategoryCreateOrUpdate.ts @@ -1,29 +1,65 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * DataCategoryCreateOrUpdate + */ export type DataCategoryCreateOrUpdate = { /** + * Version Added + * * The version of Fideslang in which this label was added. */ version_added?: string | null; /** + * Version Deprecated + * * The version of Fideslang in which this label was deprecated. */ version_deprecated?: string | null; /** + * Replaced By + * * The new name, if applicable, for this label after deprecation. */ replaced_by?: string | null; /** + * Is Default + * * Denotes whether the resource is part of the default taxonomy or not. */ is_default?: boolean; + /** + * Name + */ name?: string | null; + /** + * Description + */ description?: string | null; + /** + * Active + */ active?: boolean | null; + /** + * Fides Key + */ fides_key?: string | null; + /** + * Tags + */ tags?: Array | null; + /** + * Organization Fides Key + */ organization_fides_key?: string | null; + /** + * Parent Key + */ parent_key?: string | null; + /** + * Tagging Instructions + * + * Instructions for LLM-based data classification tagging. + */ + tagging_instructions?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/DataFlow.ts b/clients/admin-ui/src/types/api/models/DataFlow.ts index c6db9095abb..67262dc0171 100644 --- a/clients/admin-ui/src/types/api/models/DataFlow.ts +++ b/clients/admin-ui/src/types/api/models/DataFlow.ts @@ -1,22 +1,28 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DataFlow + * * The DataFlow resource model. * * Describes a resource model with which a given System resource communicates. */ export type DataFlow = { /** + * Fides Key + * * Identifies the System or Dataset resource with which the communication occurs. May also be 'user', to represent communication with the user(s) of a System. */ fides_key: string; /** + * Type + * * Specifies the resource model class for which the `fides_key` applies. May be any of dataset, system, user. */ type: string; /** + * Data Categories + * * An array of data categories describing the data in transit. */ data_categories?: Array | null; diff --git a/clients/admin-ui/src/types/api/models/DataResponsibilityTitle.ts b/clients/admin-ui/src/types/api/models/DataResponsibilityTitle.ts index 0de7664f152..a5c46d6bf51 100644 --- a/clients/admin-ui/src/types/api/models/DataResponsibilityTitle.ts +++ b/clients/admin-ui/src/types/api/models/DataResponsibilityTitle.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DataResponsibilityTitle + * * The model defining the responsibility or role over * the system that processes personal data. * diff --git a/clients/admin-ui/src/types/api/models/DataSectionConfig.ts b/clients/admin-ui/src/types/api/models/DataSectionConfig.ts new file mode 100644 index 00000000000..d0a9f5c9d9a --- /dev/null +++ b/clients/admin-ui/src/types/api/models/DataSectionConfig.ts @@ -0,0 +1,45 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * DataSectionConfig + * + * Configuration for which data sections to include. + */ +export type DataSectionConfig = { + /** + * Organization + */ + organization?: boolean; + /** + * Data Categories + */ + data_categories?: boolean; + /** + * Data Uses + */ + data_uses?: boolean; + /** + * Data Subjects + */ + data_subjects?: boolean; + /** + * Systems + */ + systems?: boolean; + /** + * Datasets + */ + datasets?: boolean; + /** + * Policies + */ + policies?: boolean; + /** + * Privacy Notices + */ + privacy_notices?: boolean; + /** + * Connections + */ + connections?: boolean; +}; diff --git a/clients/admin-ui/src/types/api/models/DataSubject.ts b/clients/admin-ui/src/types/api/models/DataSubject.ts index 76a549f49ca..fe7e0d7aad2 100644 --- a/clients/admin-ui/src/types/api/models/DataSubject.ts +++ b/clients/admin-ui/src/types/api/models/DataSubject.ts @@ -1,40 +1,60 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { DataSubjectRights } from "./DataSubjectRights"; +/** + * DataSubject + */ export type DataSubject = { /** + * Version Added + * * The version of Fideslang in which this label was added. */ version_added?: string | null; /** + * Version Deprecated + * * The version of Fideslang in which this label was deprecated. */ version_deprecated?: string | null; /** + * Replaced By + * * The new name, if applicable, for this label after deprecation. */ replaced_by?: string | null; /** + * Is Default + * * Denotes whether the resource is part of the default taxonomy or not. */ is_default?: boolean; /** + * Fides Key + * * A unique key used to identify this resource. */ fides_key: string; /** + * Organization Fides Key + * * Defines the Organization that this resource belongs to. */ organization_fides_key?: string; + /** + * Tags + */ tags?: Array | null; /** + * Name + * * Human-Readable name for this resource. */ name?: string | null; /** + * Description + * * A detailed description of what this resource is. */ description?: string | null; @@ -49,10 +69,14 @@ export type DataSubject = { */ rights?: DataSubjectRights | null; /** + * Automated Decisions Or Profiling + * * A boolean value to annotate whether or not automated decisions/profiling exists for the data subject. */ automated_decisions_or_profiling?: boolean | null; /** + * Active + * * Indicates whether the resource is currently 'active'. */ active?: boolean; diff --git a/clients/admin-ui/src/types/api/models/DataSubjectCreateOrUpdate.ts b/clients/admin-ui/src/types/api/models/DataSubjectCreateOrUpdate.ts index 3e8460ee9d9..3720be6b27b 100644 --- a/clients/admin-ui/src/types/api/models/DataSubjectCreateOrUpdate.ts +++ b/clients/admin-ui/src/types/api/models/DataSubjectCreateOrUpdate.ts @@ -1,32 +1,62 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { DataSubjectRights } from "./DataSubjectRights"; +/** + * DataSubjectCreateOrUpdate + */ export type DataSubjectCreateOrUpdate = { /** + * Version Added + * * The version of Fideslang in which this label was added. */ version_added?: string | null; /** + * Version Deprecated + * * The version of Fideslang in which this label was deprecated. */ version_deprecated?: string | null; /** + * Replaced By + * * The new name, if applicable, for this label after deprecation. */ replaced_by?: string | null; /** + * Is Default + * * Denotes whether the resource is part of the default taxonomy or not. */ is_default?: boolean; + /** + * Name + */ name?: string | null; + /** + * Description + */ description?: string | null; + /** + * Active + */ active?: boolean | null; + /** + * Fides Key + */ fides_key?: string | null; + /** + * Tags + */ tags?: Array | null; + /** + * Organization Fides Key + */ organization_fides_key?: string | null; rights?: DataSubjectRights | null; + /** + * Automated Decisions Or Profiling + */ automated_decisions_or_profiling?: boolean | null; }; diff --git a/clients/admin-ui/src/types/api/models/DataSubjectRights.ts b/clients/admin-ui/src/types/api/models/DataSubjectRights.ts index 103b8d5e1e3..4ca6e893016 100644 --- a/clients/admin-ui/src/types/api/models/DataSubjectRights.ts +++ b/clients/admin-ui/src/types/api/models/DataSubjectRights.ts @@ -1,11 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { DataSubjectRightsEnum } from "./DataSubjectRightsEnum"; -import type { IncludeExcludeEnum } from "./IncludeExcludeEnum"; +import { DataSubjectRightsEnum } from "./DataSubjectRightsEnum"; +import { IncludeExcludeEnum } from "./IncludeExcludeEnum"; /** + * DataSubjectRights + * * The DataSubjectRights resource model. * * Includes a strategy and optionally a @@ -18,6 +18,8 @@ export type DataSubjectRights = { */ strategy: IncludeExcludeEnum; /** + * Values + * * A list of valid data subject rights to be used when applying data rights to a data subject via a strategy. */ values?: Array | null; diff --git a/clients/admin-ui/src/types/api/models/DataSubjectRightsEnum.ts b/clients/admin-ui/src/types/api/models/DataSubjectRightsEnum.ts index f9f90934d17..8fbe2f7acf9 100644 --- a/clients/admin-ui/src/types/api/models/DataSubjectRightsEnum.ts +++ b/clients/admin-ui/src/types/api/models/DataSubjectRightsEnum.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DataSubjectRightsEnum + * * The model for data subject rights over * personal data. * diff --git a/clients/admin-ui/src/types/api/models/DataUpload.ts b/clients/admin-ui/src/types/api/models/DataUpload.ts index dd4cbf5c960..46376e57728 100644 --- a/clients/admin-ui/src/types/api/models/DataUpload.ts +++ b/clients/admin-ui/src/types/api/models/DataUpload.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DataUpload + * * A wrapper for the data upload location returned upon successful upload */ export type DataUpload = { + /** + * Location + */ location: string; }; diff --git a/clients/admin-ui/src/types/api/models/DataUse.ts b/clients/admin-ui/src/types/api/models/DataUse.ts index 4df688916ff..a5d0d9cff36 100644 --- a/clients/admin-ui/src/types/api/models/DataUse.ts +++ b/clients/admin-ui/src/types/api/models/DataUse.ts @@ -1,43 +1,68 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * DataUse + */ export type DataUse = { /** + * Version Added + * * The version of Fideslang in which this label was added. */ version_added?: string | null; /** + * Version Deprecated + * * The version of Fideslang in which this label was deprecated. */ version_deprecated?: string | null; /** + * Replaced By + * * The new name, if applicable, for this label after deprecation. */ replaced_by?: string | null; /** + * Is Default + * * Denotes whether the resource is part of the default taxonomy or not. */ is_default?: boolean; /** + * Fides Key + * * A unique key used to identify this resource. */ fides_key: string; /** + * Organization Fides Key + * * Defines the Organization that this resource belongs to. */ organization_fides_key?: string; + /** + * Tags + */ tags?: Array | null; /** + * Name + * * Human-Readable name for this resource. */ name?: string | null; /** + * Description + * * A detailed description of what this resource is. */ description?: string | null; + /** + * Parent Key + */ parent_key?: string | null; /** + * Active + * * Indicates whether the resource is currently 'active'. */ active?: boolean; diff --git a/clients/admin-ui/src/types/api/models/DataUseCreateOrUpdate.ts b/clients/admin-ui/src/types/api/models/DataUseCreateOrUpdate.ts index 9500ebe43f3..bb2b85f50de 100644 --- a/clients/admin-ui/src/types/api/models/DataUseCreateOrUpdate.ts +++ b/clients/admin-ui/src/types/api/models/DataUseCreateOrUpdate.ts @@ -1,29 +1,59 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * DataUseCreateOrUpdate + */ export type DataUseCreateOrUpdate = { /** + * Version Added + * * The version of Fideslang in which this label was added. */ version_added?: string | null; /** + * Version Deprecated + * * The version of Fideslang in which this label was deprecated. */ version_deprecated?: string | null; /** + * Replaced By + * * The new name, if applicable, for this label after deprecation. */ replaced_by?: string | null; /** + * Is Default + * * Denotes whether the resource is part of the default taxonomy or not. */ is_default?: boolean; + /** + * Name + */ name?: string | null; + /** + * Description + */ description?: string | null; + /** + * Active + */ active?: boolean | null; + /** + * Fides Key + */ fides_key?: string | null; + /** + * Tags + */ tags?: Array | null; + /** + * Organization Fides Key + */ organization_fides_key?: string | null; + /** + * Parent Key + */ parent_key?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/Database.ts b/clients/admin-ui/src/types/api/models/Database.ts index 2ee7af90077..b4da717b4cb 100644 --- a/clients/admin-ui/src/types/api/models/Database.ts +++ b/clients/admin-ui/src/types/api/models/Database.ts @@ -1,24 +1,51 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ClassificationWithConfidence } from "./ClassificationWithConfidence"; -import type { DiffStatus } from "./DiffStatus"; +import { DiffStatus } from "./DiffStatus"; import type { ResourceError } from "./ResourceError"; -import type { StagedResourceTypeValue } from "./StagedResourceTypeValue"; +import { StagedResourceTypeValue } from "./StagedResourceTypeValue"; +/** + * Database + */ export type Database = { + /** + * Urn + */ urn: string; + /** + * User Assigned Data Categories + */ user_assigned_data_categories?: Array | null; /** + * User Assigned Data Uses + * * User assigned data uses overriding auto assigned data uses */ user_assigned_data_uses?: Array | null; + /** + * User Assigned System Key + */ user_assigned_system_key?: string | null; + /** + * Name + */ name?: string | null; + /** + * System Key + */ system_key?: string | null; + /** + * Description + */ description?: string | null; + /** + * Monitor Config Id + */ monitor_config_id?: string | null; + /** + * Updated At + */ updated_at?: string | null; /** * The diff status of the staged resource @@ -26,14 +53,58 @@ export type Database = { diff_status?: DiffStatus | null; resource_type?: StagedResourceTypeValue | null; /** + * Data Uses + * * The data uses associated with the staged resource */ data_uses?: Array | null; /** + * Errors + * * List of errors encountered during processing */ errors?: Array; + /** + * Source Modified + */ source_modified?: string | null; + /** + * Classifications + */ classifications?: Array; + /** + * Schemas + */ schemas?: Array; + [key: string]: + | unknown + | string + | Array + | null + | Array + | null + | string + | null + | string + | null + | string + | null + | string + | null + | string + | null + | string + | null + | DiffStatus + | null + | StagedResourceTypeValue + | null + | Array + | null + | Array + | string + | null + | Array + | Array + | undefined; }; diff --git a/clients/admin-ui/src/types/api/models/DatabaseConfig.ts b/clients/admin-ui/src/types/api/models/DatabaseConfig.ts index d332f5be66c..9fefe2e0da4 100644 --- a/clients/admin-ui/src/types/api/models/DatabaseConfig.ts +++ b/clients/admin-ui/src/types/api/models/DatabaseConfig.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DatabaseConfig + * * The model for the connection config for databases */ export type DatabaseConfig = { + /** + * Connection String + */ connection_string: string; }; diff --git a/clients/admin-ui/src/types/api/models/DatabaseHealthCheck.ts b/clients/admin-ui/src/types/api/models/DatabaseHealthCheck.ts index 6fc7330a816..5a749a025dd 100644 --- a/clients/admin-ui/src/types/api/models/DatabaseHealthCheck.ts +++ b/clients/admin-ui/src/types/api/models/DatabaseHealthCheck.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DatabaseHealthCheck + * * Database Healthcheck Schema */ export type DatabaseHealthCheck = { + /** + * Database + */ database: string; + /** + * Database Revision + */ database_revision?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/DatahubDocsSchema.ts b/clients/admin-ui/src/types/api/models/DatahubDocsSchema.ts index 8b0f7793dce..d9814da7fe6 100644 --- a/clients/admin-ui/src/types/api/models/DatahubDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/DatahubDocsSchema.ts @@ -1,26 +1,34 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { PeriodicIntegrationFrequency } from "./PeriodicIntegrationFrequency"; +import { PeriodicIntegrationFrequency } from "./PeriodicIntegrationFrequency"; /** + * DatahubDocsSchema + * * Datahub Schema for API docs. */ export type DatahubDocsSchema = { /** + * DataHub server URL + * * The URL of your DataHub server. */ datahub_server_url: string; /** + * DataHub token + * * The token used to authenticate with your DataHub server. */ datahub_token: string; /** + * Frequency + * * The frequency at which the integration should run. Available options are daily, weekly, monthly, and not scheduled. */ frequency: PeriodicIntegrationFrequency; /** + * Glossary node + * * The glossary node name to use on Datahub for Fides Data Categories. (e.g. FidesDataCategories) */ glossary_node: string; diff --git a/clients/admin-ui/src/types/api/models/DatamapReport.ts b/clients/admin-ui/src/types/api/models/DatamapReport.ts index 3b6f5deeb78..26dc6b2b33c 100644 --- a/clients/admin-ui/src/types/api/models/DatamapReport.ts +++ b/clients/admin-ui/src/types/api/models/DatamapReport.ts @@ -1,53 +1,264 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * DatamapReport + */ export type DatamapReport = { + /** + * Administrating Department + */ administrating_department?: string | null; + /** + * Cookie Max Age Seconds + */ cookie_max_age_seconds?: number | null; + /** + * Cookie Refresh + */ cookie_refresh: boolean; + /** + * Data Categories + */ data_categories?: string | Array | null; + /** + * System Undeclared Data Categories + */ system_undeclared_data_categories?: Array | null; + /** + * Data Use Undeclared Data Categories + */ data_use_undeclared_data_categories?: Array | null; + /** + * Data Security Practices + */ data_security_practices?: string | null; + /** + * Data Shared With Third Parties + */ data_shared_with_third_parties?: boolean | null; + /** + * Data Stewards + */ data_stewards?: Array | null; + /** + * Data Subjects + */ data_subjects?: Array | null; + /** + * Data Uses + */ data_uses?: string | Array | null; + /** + * Declaration Name + */ declaration_name?: string | null; + /** + * Description + */ description?: string | null; + /** + * Does International Transfers + */ does_international_transfers: boolean; + /** + * Dpa Location + */ dpa_location?: string | null; + /** + * Dpo + */ dpo?: string | null; + /** + * Egress + */ egress?: Array | null; + /** + * Exempt From Privacy Regulations + */ exempt_from_privacy_regulations: boolean; + /** + * Features + */ features?: Array | null; + /** + * Fides Key + */ fides_key: string; + /** + * Flexible Legal Basis For Processing + */ flexible_legal_basis_for_processing?: boolean | null; + /** + * Impact Assessment Location + */ impact_assessment_location?: string | null; + /** + * Ingress + */ ingress?: Array | null; + /** + * Joint Controller Info + */ joint_controller_info?: string | null; + /** + * Legal Address + */ legal_address?: string | null; + /** + * Legal Basis For Processing + */ legal_basis_for_processing?: string | null; + /** + * Legal Basis For Profiling + */ legal_basis_for_profiling?: Array | null; + /** + * Legal Basis For Transfers + */ legal_basis_for_transfers?: Array | null; + /** + * Legal Name + */ legal_name?: string | null; + /** + * Legitimate Interest Disclosure Url + */ legitimate_interest_disclosure_url?: string | null; + /** + * Link To Processor Contract + */ link_to_processor_contract?: string | null; + /** + * Privacy Policy + */ privacy_policy?: string | null; + /** + * Processes Personal Data + */ processes_personal_data: boolean; + /** + * Reason For Exemption + */ reason_for_exemption?: string | null; + /** + * Requires Data Protection Assessments + */ requires_data_protection_assessments: boolean; + /** + * Responsibility + */ responsibility?: Array | null; + /** + * Retention Period + */ retention_period?: string | null; + /** + * Shared Categories + */ shared_categories?: Array | null; + /** + * Special Category Legal Basis + */ special_category_legal_basis?: string | null; + /** + * System Name + */ system_name: string; - system_group_data_uses?: Array | null; - system_group_fides_key?: string | null; + /** + * System Groups + */ system_groups?: Array | null; + /** + * Third Parties + */ third_parties?: string | null; + /** + * Uses Cookies + */ uses_cookies: boolean; + /** + * Uses Non Cookie Access + */ uses_non_cookie_access: boolean; + /** + * Uses Profiling + */ uses_profiling: boolean; + [key: string]: + | unknown + | string + | null + | number + | null + | boolean + | string + | Array + | null + | Array + | null + | Array + | null + | string + | null + | boolean + | null + | Array + | null + | Array + | null + | string + | Array + | null + | string + | null + | string + | null + | string + | null + | string + | null + | Array + | null + | Array + | null + | string + | boolean + | null + | string + | null + | Array + | null + | string + | null + | string + | null + | string + | null + | Array + | null + | Array + | null + | string + | null + | string + | null + | string + | null + | string + | null + | string + | null + | Array + | null + | string + | null + | Array + | null + | string + | null + | Array + | null + | string + | null + | undefined; }; diff --git a/clients/admin-ui/src/types/api/models/Dataset.ts b/clients/admin-ui/src/types/api/models/Dataset.ts index d262cc35234..e64e404f36f 100644 --- a/clients/admin-ui/src/types/api/models/Dataset.ts +++ b/clients/admin-ui/src/types/api/models/Dataset.ts @@ -1,36 +1,53 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { DatasetCollection } from "./DatasetCollection"; import type { DatasetMetadata } from "./DatasetMetadata"; /** + * Dataset + * * The Dataset resource model. */ export type Dataset = { /** + * Fides Key + * * A unique key used to identify this resource. */ fides_key: string; /** + * Organization Fides Key + * * Defines the Organization that this resource belongs to. */ organization_fides_key?: string; + /** + * Tags + */ tags?: Array | null; /** + * Name + * * Human-Readable name for this resource. */ name?: string | null; /** + * Description + * * A detailed description of what this resource is. */ description?: string | null; /** + * Meta + * * An optional property to store any extra information for a resource. Data can be structured in any way: simple set of `key: value` pairs or deeply nested objects. */ - meta?: null; + meta?: { + [key: string]: unknown; + } | null; /** + * Data Categories + * * Array of Data Category resources identified by `fides_key`, that apply to all collections in the Dataset. */ data_categories?: Array | null; @@ -43,6 +60,8 @@ export type Dataset = { */ fides_meta?: DatasetMetadata | null; /** + * Collections + * * An array of objects that describe the Dataset's collections. */ collections: Array; diff --git a/clients/admin-ui/src/types/api/models/DatasetCollection.ts b/clients/admin-ui/src/types/api/models/DatasetCollection.ts index f62a8e4f061..8ef9ff4e5af 100644 --- a/clients/admin-ui/src/types/api/models/DatasetCollection.ts +++ b/clients/admin-ui/src/types/api/models/DatasetCollection.ts @@ -1,29 +1,37 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { CollectionMeta } from "./CollectionMeta"; import type { DatasetField } from "./DatasetField"; /** + * DatasetCollection + * * The DatasetCollection resource model. * * This resource is nested within a Dataset. */ export type DatasetCollection = { /** + * Name + * * Human-Readable name for this resource. */ name: string; /** + * Description + * * A detailed description of what this resource is. */ description?: string | null; /** + * Data Categories + * * Array of Data Category resources identified by `fides_key`, that apply to all fields in the collection. */ data_categories?: Array | null; /** + * Fields + * * An array of objects that describe the collection's fields. */ fields: Array; diff --git a/clients/admin-ui/src/types/api/models/DatasetConfigCtlDataset.ts b/clients/admin-ui/src/types/api/models/DatasetConfigCtlDataset.ts index 9da28b241af..4d23c5f437e 100644 --- a/clients/admin-ui/src/types/api/models/DatasetConfigCtlDataset.ts +++ b/clients/admin-ui/src/types/api/models/DatasetConfigCtlDataset.ts @@ -1,8 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * DatasetConfigCtlDataset + */ export type DatasetConfigCtlDataset = { + /** + * Fides Key + */ fides_key: string; + /** + * Ctl Dataset Fides Key + */ ctl_dataset_fides_key: string; + /** + * Property Ids + */ + property_ids?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/DatasetConfigSchema.ts b/clients/admin-ui/src/types/api/models/DatasetConfigSchema.ts index 83a8ea94e0c..266f0b0dd89 100644 --- a/clients/admin-ui/src/types/api/models/DatasetConfigSchema.ts +++ b/clients/admin-ui/src/types/api/models/DatasetConfigSchema.ts @@ -1,13 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { Dataset } from "./Dataset"; /** + * DatasetConfigSchema + * * Returns the DatasetConfig fides key and the linked Ctl Dataset */ export type DatasetConfigSchema = { + /** + * Fides Key + */ fides_key: string; ctl_dataset: Dataset; }; diff --git a/clients/admin-ui/src/types/api/models/DatasetField.ts b/clients/admin-ui/src/types/api/models/DatasetField.ts index 9c4a4c46910..765e7091f22 100644 --- a/clients/admin-ui/src/types/api/models/DatasetField.ts +++ b/clients/admin-ui/src/types/api/models/DatasetField.ts @@ -1,29 +1,37 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { FidesMeta } from "./FidesMeta"; /** + * DatasetField + * * The DatasetField resource model. * * This resource is nested within a DatasetCollection. */ export type DatasetField = { /** + * Name + * * Human-Readable name for this resource. */ name: string; /** + * Description + * * A detailed description of what this resource is. */ description?: string | null; /** + * Data Categories + * * Arrays of Data Categories, identified by `fides_key`, that applies to this field. */ data_categories?: Array | null; fides_meta?: FidesMeta | null; /** + * Fields + * * An optional array of objects that describe hierarchical/nested fields (typically found in NoSQL databases). */ fields?: Array | null; diff --git a/clients/admin-ui/src/types/api/models/DatasetMetadata.ts b/clients/admin-ui/src/types/api/models/DatasetMetadata.ts index e829e0f4551..b9555d863d9 100644 --- a/clients/admin-ui/src/types/api/models/DatasetMetadata.ts +++ b/clients/admin-ui/src/types/api/models/DatasetMetadata.ts @@ -1,14 +1,31 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DatasetMetadata + * * The DatasetMetadata resource model. * * Object used to hold application specific metadata for a dataset */ export type DatasetMetadata = { + /** + * Resource Id + */ resource_id?: string | null; + /** + * After + */ after?: Array | null; - namespace?: null; + /** + * Namespace + */ + namespace?: { + [key: string]: unknown; + } | null; + /** + * Redact + * + * Specify 'name' to indicate the dataset name should be redacted. + */ + redact?: "name" | null; }; diff --git a/clients/admin-ui/src/types/api/models/DatasetPropertyResponse.ts b/clients/admin-ui/src/types/api/models/DatasetPropertyResponse.ts new file mode 100644 index 00000000000..fede2c1bf93 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/DatasetPropertyResponse.ts @@ -0,0 +1,17 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * DatasetPropertyResponse + * + * Response schema showing a dataset's property assignments. + */ +export type DatasetPropertyResponse = { + /** + * Fides Key + */ + fides_key: string; + /** + * Property Ids + */ + property_ids: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/DatasetReachability.ts b/clients/admin-ui/src/types/api/models/DatasetReachability.ts index b53ab3307a1..8def4adc4fe 100644 --- a/clients/admin-ui/src/types/api/models/DatasetReachability.ts +++ b/clients/admin-ui/src/types/api/models/DatasetReachability.ts @@ -1,11 +1,22 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DatasetReachability + * * Response containing reachability details for a single dataset */ export type DatasetReachability = { + /** + * Reachable + */ reachable: boolean; - details: string | null; + /** + * Details + */ + details: + | string + | Array<{ + [key: string]: unknown; + }> + | null; }; diff --git a/clients/admin-ui/src/types/api/models/DatasetResponse.ts b/clients/admin-ui/src/types/api/models/DatasetResponse.ts index 3b5282e9936..9afa8f98228 100644 --- a/clients/admin-ui/src/types/api/models/DatasetResponse.ts +++ b/clients/admin-ui/src/types/api/models/DatasetResponse.ts @@ -1,11 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { DatasetCollection } from "./DatasetCollection"; import type { DatasetMetadata } from "./DatasetMetadata"; /** + * DatasetResponse + * * Dataset response model for API endpoints. * * Note: This class extends the Dataset model from fideslang rather than having a proper @@ -15,27 +15,44 @@ import type { DatasetMetadata } from "./DatasetMetadata"; */ export type DatasetResponse = { /** + * Fides Key + * * A unique key used to identify this resource. */ fides_key: string; /** + * Organization Fides Key + * * Defines the Organization that this resource belongs to. */ organization_fides_key?: string; + /** + * Tags + */ tags?: Array | null; /** + * Name + * * Human-Readable name for this resource. */ name?: string | null; /** + * Description + * * A detailed description of what this resource is. */ description?: string | null; /** + * Meta + * * An optional property to store any extra information for a resource. Data can be structured in any way: simple set of `key: value` pairs or deeply nested objects. */ - meta?: null; + meta?: { + [key: string]: unknown; + } | null; /** + * Data Categories + * * Array of Data Category resources identified by `fides_key`, that apply to all collections in the Dataset. */ data_categories?: Array | null; @@ -48,6 +65,8 @@ export type DatasetResponse = { */ fides_meta?: DatasetMetadata | null; /** + * Collections + * * An array of objects that describe the Dataset's collections. */ collections?: Array | null; diff --git a/clients/admin-ui/src/types/api/models/DatasetSchema.ts b/clients/admin-ui/src/types/api/models/DatasetSchema.ts index 4b436cc17fe..bd8c68f0d20 100644 --- a/clients/admin-ui/src/types/api/models/DatasetSchema.ts +++ b/clients/admin-ui/src/types/api/models/DatasetSchema.ts @@ -1,8 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * DatasetSchema + */ export type DatasetSchema = { + /** + * Fides Key + */ fides_key: string; + /** + * Name + */ name?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/DatasetTestRequest.ts b/clients/admin-ui/src/types/api/models/DatasetTestRequest.ts index 8c774dd7293..9c55155cb20 100644 --- a/clients/admin-ui/src/types/api/models/DatasetTestRequest.ts +++ b/clients/admin-ui/src/types/api/models/DatasetTestRequest.ts @@ -1,13 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { UnlabeledIdentities } from "./UnlabeledIdentities"; /** + * DatasetTestRequest + * * The policy key and inputs required to run a dataset test. */ export type DatasetTestRequest = { + /** + * Policy Key + */ policy_key: string; identities: UnlabeledIdentities; }; diff --git a/clients/admin-ui/src/types/api/models/DatasetTraversalDetails.ts b/clients/admin-ui/src/types/api/models/DatasetTraversalDetails.ts index d2993f90161..1d3f2c04321 100644 --- a/clients/admin-ui/src/types/api/models/DatasetTraversalDetails.ts +++ b/clients/admin-ui/src/types/api/models/DatasetTraversalDetails.ts @@ -1,12 +1,18 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DatasetTraversalDetails + * * Describes whether or not the parent dataset is traversable; if not, includes * an error message describing the traversal issues. */ export type DatasetTraversalDetails = { + /** + * Is Traversable + */ is_traversable: boolean; + /** + * Msg + */ msg: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/DatastoreMonitorResourcesDynamicFilters.ts b/clients/admin-ui/src/types/api/models/DatastoreMonitorResourcesDynamicFilters.ts index 67d9d76f443..08919a591e2 100644 --- a/clients/admin-ui/src/types/api/models/DatastoreMonitorResourcesDynamicFilters.ts +++ b/clients/admin-ui/src/types/api/models/DatastoreMonitorResourcesDynamicFilters.ts @@ -1,11 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConfidenceBucket } from "./ConfidenceBucket"; +import { ConfidenceBucket } from "./ConfidenceBucket"; +/** + * DatastoreMonitorResourcesDynamicFilters + */ export type DatastoreMonitorResourcesDynamicFilters = { + /** + * Diff Status + */ diff_status?: Array | null; + /** + * Data Category + */ data_category?: Array | null; + /** + * Confidence Bucket + */ confidence_bucket?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/DatastoreMonitorUpdates.ts b/clients/admin-ui/src/types/api/models/DatastoreMonitorUpdates.ts index f58d9886eeb..b94d4ae291a 100644 --- a/clients/admin-ui/src/types/api/models/DatastoreMonitorUpdates.ts +++ b/clients/admin-ui/src/types/api/models/DatastoreMonitorUpdates.ts @@ -1,17 +1,41 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DatastoreMonitorUpdates + * * Updates dictionary for datastore monitors with classification and review counts */ export type DatastoreMonitorUpdates = { + /** + * Unlabeled + */ unlabeled: number; + /** + * In Review + */ in_review: number; + /** + * Classifying + */ classifying: number; + /** + * Removals + */ removals: number; + /** + * Reviewed + */ reviewed: number; + /** + * Classified Low Confidence + */ classified_low_confidence: number | null; + /** + * Classified Medium Confidence + */ classified_medium_confidence: number | null; + /** + * Classified High Confidence + */ classified_high_confidence: number | null; }; diff --git a/clients/admin-ui/src/types/api/models/DatastoreStagedResource.ts b/clients/admin-ui/src/types/api/models/DatastoreStagedResource.ts index e6d12abbbc1..3651fa5d456 100644 --- a/clients/admin-ui/src/types/api/models/DatastoreStagedResource.ts +++ b/clients/admin-ui/src/types/api/models/DatastoreStagedResource.ts @@ -1,27 +1,53 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ClassificationWithConfidence } from "./ClassificationWithConfidence"; -import type { DiffStatus } from "./DiffStatus"; +import { DiffStatus } from "./DiffStatus"; import type { ResourceError } from "./ResourceError"; -import type { StagedResourceTypeValue } from "./StagedResourceTypeValue"; +import { StagedResourceTypeValue } from "./StagedResourceTypeValue"; /** + * DatastoreStagedResource + * * API model that represents a datastore staged resource, fields common to all types of datastore staged resources */ export type DatastoreStagedResource = { + /** + * Urn + */ urn: string; + /** + * User Assigned Data Categories + */ user_assigned_data_categories?: Array | null; /** + * User Assigned Data Uses + * * User assigned data uses overriding auto assigned data uses */ user_assigned_data_uses?: Array | null; + /** + * User Assigned System Key + */ user_assigned_system_key?: string | null; + /** + * Name + */ name?: string | null; + /** + * System Key + */ system_key?: string | null; + /** + * Description + */ description?: string | null; + /** + * Monitor Config Id + */ monitor_config_id?: string | null; + /** + * Updated At + */ updated_at?: string | null; /** * The diff status of the staged resource @@ -29,13 +55,53 @@ export type DatastoreStagedResource = { diff_status?: DiffStatus | null; resource_type?: StagedResourceTypeValue | null; /** + * Data Uses + * * The data uses associated with the staged resource */ data_uses?: Array | null; /** + * Errors + * * List of errors encountered during processing */ errors?: Array; + /** + * Source Modified + */ source_modified?: string | null; + /** + * Classifications + */ classifications?: Array; + [key: string]: + | unknown + | string + | Array + | null + | Array + | null + | string + | null + | string + | null + | string + | null + | string + | null + | string + | null + | string + | null + | DiffStatus + | null + | StagedResourceTypeValue + | null + | Array + | null + | Array + | string + | null + | Array + | undefined; }; diff --git a/clients/admin-ui/src/types/api/models/DatastoreStagedResourceAPIResponse.ts b/clients/admin-ui/src/types/api/models/DatastoreStagedResourceAPIResponse.ts index 2916fd52b4a..5a4d88e15da 100644 --- a/clients/admin-ui/src/types/api/models/DatastoreStagedResourceAPIResponse.ts +++ b/clients/admin-ui/src/types/api/models/DatastoreStagedResourceAPIResponse.ts @@ -1,27 +1,48 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ClassificationWithConfidence } from "./ClassificationWithConfidence"; -import type { DiffStatus } from "./DiffStatus"; +import { DiffStatus } from "./DiffStatus"; /** + * DatastoreStagedResourceAPIResponse + * * Pydantic Schema used to represent any StageResource in datastore monitor, used only for API responses. */ export type DatastoreStagedResourceAPIResponse = { + /** + * Urn + */ urn: string; + /** + * Name + */ name?: string | null; diff_status?: DiffStatus | null; + /** + * Description + */ description?: string | null; + /** + * Updated At + */ updated_at?: string | null; + /** + * Classifications + */ classifications?: Array; - preferred_data_categories?: Array | null; /** + * User Assigned Data Categories + * * User assigned data categories overriding auto assigned classifications */ user_assigned_data_categories?: Array | null; + /** + * Data Type + */ data_type?: string | null; /** + * Monitor Config Id + * * The monitor config that detected this resource */ monitor_config_id: string; diff --git a/clients/admin-ui/src/types/api/models/DatastoreStagedResourceTreeAPIResponse.ts b/clients/admin-ui/src/types/api/models/DatastoreStagedResourceTreeAPIResponse.ts index 15bc74962e8..4f3b0b1383a 100644 --- a/clients/admin-ui/src/types/api/models/DatastoreStagedResourceTreeAPIResponse.ts +++ b/clients/admin-ui/src/types/api/models/DatastoreStagedResourceTreeAPIResponse.ts @@ -1,25 +1,38 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { DiffStatus } from "./DiffStatus"; +import { DiffStatus } from "./DiffStatus"; /** + * DatastoreStagedResourceTreeAPIResponse + * * Pydantic Schema used to represent a datastore staged resource children, used only for API responses. */ export type DatastoreStagedResourceTreeAPIResponse = { + /** + * Urn + */ urn: string; + /** + * Name + */ name?: string | null; + /** + * Resource Type + */ resource_type?: string | null; /** * The diff status of the staged resource */ diff_status?: DiffStatus | null; /** + * Monitor Config Id + * * The monitor config that detected this resource */ monitor_config_id: string; /** + * Has Grandchildren + * * Whether the resource has grandchildren */ has_grandchildren?: boolean; diff --git a/clients/admin-ui/src/types/api/models/DefaultPolicyConfigRequest.ts b/clients/admin-ui/src/types/api/models/DefaultPolicyConfigRequest.ts new file mode 100644 index 00000000000..94d02710805 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/DefaultPolicyConfigRequest.ts @@ -0,0 +1,21 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { ActionType } from "./ActionType"; + +/** + * DefaultPolicyConfigRequest + * + * Request schema for setting default policy configuration. + */ +export type DefaultPolicyConfigRequest = { + /** + * Policy Key + * + * Policy key to set as default. Null to reset to system default. + */ + policy_key?: string | null; + /** + * Action type (access, erasure, or consent) for which to set the default policy. + */ + action_type: ActionType; +}; diff --git a/clients/admin-ui/src/types/api/models/DefaultPolicyConfigResponse.ts b/clients/admin-ui/src/types/api/models/DefaultPolicyConfigResponse.ts new file mode 100644 index 00000000000..09dd617d1c3 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/DefaultPolicyConfigResponse.ts @@ -0,0 +1,27 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * DefaultPolicyConfigResponse + * + * Response schema for default policy configuration. + */ +export type DefaultPolicyConfigResponse = { + /** + * Access + * + * Policy key for default access policy. Returns the system default when no custom override is set. + */ + access: string; + /** + * Erasure + * + * Policy key for default erasure policy. Returns the system default when no custom override is set. + */ + erasure: string; + /** + * Consent + * + * Policy key for default consent policy. Returns the system default when no custom override is set. + */ + consent: string; +}; diff --git a/clients/admin-ui/src/types/api/models/DeletedResourcesResponse.ts b/clients/admin-ui/src/types/api/models/DeletedResourcesResponse.ts index 5d133d1a952..be12bea4cfe 100644 --- a/clients/admin-ui/src/types/api/models/DeletedResourcesResponse.ts +++ b/clients/admin-ui/src/types/api/models/DeletedResourcesResponse.ts @@ -1,12 +1,14 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DeletedResourcesResponse + * * Response model for delete operations on staged resources */ export type DeletedResourcesResponse = { /** + * Count + * * Number of resources deleted */ count: number; diff --git a/clients/admin-ui/src/types/api/models/DenyPrivacyRequestSelection.ts b/clients/admin-ui/src/types/api/models/DenyPrivacyRequestSelection.ts new file mode 100644 index 00000000000..392116a5ca7 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/DenyPrivacyRequestSelection.ts @@ -0,0 +1,31 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { PrivacyRequestFilter } from "./PrivacyRequestFilter"; + +/** + * DenyPrivacyRequestSelection + * + * Select privacy requests to deny with optional reason + */ +export type DenyPrivacyRequestSelection = { + /** + * Request Ids + * + * List of privacy request IDs to act on. The backend will automatically batch requests if the list is large. + */ + request_ids?: Array | null; + /** + * Filters to select privacy requests (only used when request_ids is not provided) + */ + filters?: PrivacyRequestFilter | null; + /** + * Exclude Ids + * + * List of privacy request IDs to exclude from the action (only used with filters) + */ + exclude_ids?: Array | null; + /** + * Reason + */ + reason?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/DenyPrivacyRequests.ts b/clients/admin-ui/src/types/api/models/DenyPrivacyRequests.ts deleted file mode 100644 index 1f883b34635..00000000000 --- a/clients/admin-ui/src/types/api/models/DenyPrivacyRequests.ts +++ /dev/null @@ -1,11 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -/** - * Pass in a list of privacy request ids and rejection reason - */ -export type DenyPrivacyRequests = { - request_ids: Array; - reason?: string | null; -}; diff --git a/clients/admin-ui/src/types/api/models/DictionaryStatus.ts b/clients/admin-ui/src/types/api/models/DictionaryStatus.ts index af9ac8f67d8..25da95c0d6b 100644 --- a/clients/admin-ui/src/types/api/models/DictionaryStatus.ts +++ b/clients/admin-ui/src/types/api/models/DictionaryStatus.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ServiceHealth } from "./ServiceHealth"; +import { ServiceHealth } from "./ServiceHealth"; /** + * DictionaryStatus + * * Dictionary status schema */ export type DictionaryStatus = { + /** + * Enabled + */ enabled?: boolean; service_health?: ServiceHealth | null; + /** + * Service Error + */ service_error?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/DiffStatus.ts b/clients/admin-ui/src/types/api/models/DiffStatus.ts index bc63aed55df..b02246adf76 100644 --- a/clients/admin-ui/src/types/api/models/DiffStatus.ts +++ b/clients/admin-ui/src/types/api/models/DiffStatus.ts @@ -1,7 +1,10 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * DiffStatus + * + * Enum representing the status of staged resources. + */ export enum DiffStatus { ADDITION = "addition", CLASSIFICATION_ADDITION = "classification_addition", diff --git a/clients/admin-ui/src/types/api/models/DiffStatusDistribution.ts b/clients/admin-ui/src/types/api/models/DiffStatusDistribution.ts new file mode 100644 index 00000000000..0e35b6623fe --- /dev/null +++ b/clients/admin-ui/src/types/api/models/DiffStatusDistribution.ts @@ -0,0 +1,27 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * DiffStatusDistribution + * + * Distribution of diff statuses across generated tables + */ +export type DiffStatusDistribution = { + /** + * Addition + * + * Proportion of tables with ADDITION status (0.0 to 1.0) + */ + addition?: number; + /** + * Classifying + * + * Proportion of tables with CLASSIFYING status (0.0 to 1.0) + */ + classifying?: number; + /** + * Classification Addition + * + * Proportion of tables with CLASSIFICATION_ADDITION status (0.0 to 1.0) + */ + classification_addition?: number; +}; diff --git a/clients/admin-ui/src/types/api/models/DigestConditionType.ts b/clients/admin-ui/src/types/api/models/DigestConditionType.ts index cae5b0413d7..c23c9c212c6 100644 --- a/clients/admin-ui/src/types/api/models/DigestConditionType.ts +++ b/clients/admin-ui/src/types/api/models/DigestConditionType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DigestConditionType + * * Types of digest conditions - each can have their own tree. * * Types: diff --git a/clients/admin-ui/src/types/api/models/DigestConfigListResponse.ts b/clients/admin-ui/src/types/api/models/DigestConfigListResponse.ts deleted file mode 100644 index 5f5e251b726..00000000000 --- a/clients/admin-ui/src/types/api/models/DigestConfigListResponse.ts +++ /dev/null @@ -1,15 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { DigestConfigResponse } from "./DigestConfigResponse"; - -/** - * Response schema for listing digest configurations. - */ -export type DigestConfigListResponse = { - items: Array; - total: number; - page?: number; - size?: number; -}; diff --git a/clients/admin-ui/src/types/api/models/DigestConfigRequest.ts b/clients/admin-ui/src/types/api/models/DigestConfigRequest.ts index a5c81fc152d..33bd67cec51 100644 --- a/clients/admin-ui/src/types/api/models/DigestConfigRequest.ts +++ b/clients/admin-ui/src/types/api/models/DigestConfigRequest.ts @@ -1,19 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { DigestType } from "./DigestType"; -import type { MessagingMethod } from "./MessagingMethod"; +import { DigestType } from "./DigestType"; +import { MessagingMethod } from "./MessagingMethod"; /** + * DigestConfigRequest + * * Request schema for creating or updating digest configurations. */ export type DigestConfigRequest = { /** + * Name + * * Human-readable name for the digest configuration */ name: string; /** + * Description + * * Optional description of the digest configuration */ description?: string | null; @@ -22,23 +26,33 @@ export type DigestConfigRequest = { */ digest_type: DigestType; /** + * Enabled + * * Whether digest notifications are enabled */ enabled: boolean; /** * Type of messaging service (email, sms, etc.) */ - messaging_service_type?: MessagingMethod | null; + messaging_service_type?: MessagingMethod; /** + * Cron Expression + * * Cron expression for digest scheduling (default: weekly on Monday at 9 AM) */ cron_expression: string; /** + * Timezone + * * Timezone for digest scheduling */ timezone: string; /** + * Config Metadata + * * Additional configuration metadata (service-specific settings) */ - config_metadata?: null; + config_metadata?: { + [key: string]: unknown; + } | null; }; diff --git a/clients/admin-ui/src/types/api/models/DigestConfigResponse.ts b/clients/admin-ui/src/types/api/models/DigestConfigResponse.ts index 34011e472e0..b7aa5ef2e15 100644 --- a/clients/admin-ui/src/types/api/models/DigestConfigResponse.ts +++ b/clients/admin-ui/src/types/api/models/DigestConfigResponse.ts @@ -1,69 +1,98 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConditionGroup } from "./ConditionGroup"; import type { ConditionLeaf } from "./ConditionLeaf"; -import type { DigestType } from "./DigestType"; -import type { MessagingMethod } from "./MessagingMethod"; +import { DigestConditionType } from "./DigestConditionType"; +import { DigestType } from "./DigestType"; +import { MessagingMethod } from "./MessagingMethod"; /** + * DigestConfigResponse + * * Response schema for digest configurations. */ export type DigestConfigResponse = { /** - * Digest configuration ID - */ - id: string; - /** - * Digest configuration name + * Name + * + * Human-readable name for the digest configuration */ name: string; /** - * Digest configuration description + * Description + * + * Optional description of the digest configuration */ - description: string | null; + description?: string | null; /** * Digest type */ digest_type: DigestType; /** + * Enabled + * * Whether digest notifications are enabled */ enabled: boolean; /** * Type of messaging service (email, sms, etc.) */ - messaging_service_type: MessagingMethod; + messaging_service_type?: MessagingMethod; /** + * Cron Expression + * * Cron expression for digest scheduling (default: weekly on Monday at 9 AM) */ cron_expression: string; /** + * Timezone + * * Timezone for digest scheduling */ timezone: string; /** + * Config Metadata + * * Additional configuration metadata (service-specific settings) */ - config_metadata: null; + config_metadata?: { + [key: string]: unknown; + } | null; + /** + * Id + * + * Digest configuration ID + */ + id: string; /** + * Conditions + * * Digest conditions */ - conditions: Record; + conditions: { + [key in DigestConditionType]?: ConditionLeaf | ConditionGroup; + }; /** + * Created At + * * Creation timestamp */ created_at: string; /** + * Updated At + * * Last update timestamp */ updated_at: string; /** + * Last Sent At + * * Last sent timestamp */ last_sent_at: string | null; /** + * Next Scheduled At + * * Next scheduled timestamp */ next_scheduled_at: string | null; diff --git a/clients/admin-ui/src/types/api/models/DigestType.ts b/clients/admin-ui/src/types/api/models/DigestType.ts index a18acff74df..1b52fa4aff0 100644 --- a/clients/admin-ui/src/types/api/models/DigestType.ts +++ b/clients/admin-ui/src/types/api/models/DigestType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DigestType + * * Types of digests that can be configured. */ export enum DigestType { diff --git a/clients/admin-ui/src/types/api/models/DiscoveryMonitorsConfig.ts b/clients/admin-ui/src/types/api/models/DiscoveryMonitorsConfig.ts new file mode 100644 index 00000000000..99a65cc3ddf --- /dev/null +++ b/clients/admin-ui/src/types/api/models/DiscoveryMonitorsConfig.ts @@ -0,0 +1,40 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { BigQueryMonitorConfig } from "./BigQueryMonitorConfig"; +import type { OktaMonitorConfig } from "./OktaMonitorConfig"; +import type { WebsiteMonitorConfig } from "./WebsiteMonitorConfig"; + +/** + * DiscoveryMonitorsConfig + * + * Configuration for discovery monitors. + * + * Groups the seed inputs for all supported monitor types. + * See also: MonitorClassifyParams (for llm_model_override). + */ +export type DiscoveryMonitorsConfig = { + /** + * BigQuery monitor configuration + */ + bigquery?: BigQueryMonitorConfig | null; + /** + * Website monitor configuration + */ + website?: WebsiteMonitorConfig | null; + /** + * Okta (Identity Provider) monitor configuration + */ + okta?: OktaMonitorConfig | null; + /** + * Llm Model Override + * + * LLM model to use for classification (e.g., bedrock/us.anthropic.claude-haiku-4-5-20251001-v1:0) + */ + llm_model_override?: string; + /** + * Wait For Completion + * + * Whether to wait for monitor executions to complete before marking the seed as done. When False (default), monitors are started but the seed completes without waiting for them to finish. + */ + wait_for_completion?: boolean; +}; diff --git a/clients/admin-ui/src/types/api/models/DrpAction.ts b/clients/admin-ui/src/types/api/models/DrpAction.ts index 6332faaeb42..c9b6bbd4aa9 100644 --- a/clients/admin-ui/src/types/api/models/DrpAction.ts +++ b/clients/admin-ui/src/types/api/models/DrpAction.ts @@ -1,16 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DrpAction + * * Enum to hold valid DRP actions. For more details, see: * https://github.com/consumer-reports-digital-lab/data-rights-protocol#301-supported-rights-actions */ export enum DrpAction { ACCESS = "access", DELETION = "deletion", - SALE_OPT_OUT = "sale:opt_out", - SALE_OPT_IN = "sale:opt_in", - ACCESS_CATEGORIES = "access:categories", - ACCESS_SPECIFIC = "access:specific", + "SALE:OPT_OUT" = "sale:opt_out", + "SALE:OPT_IN" = "sale:opt_in", + "ACCESS:CATEGORIES" = "access:categories", + "ACCESS:SPECIFIC" = "access:specific", } diff --git a/clients/admin-ui/src/types/api/models/DrpDataRightsResponse.ts b/clients/admin-ui/src/types/api/models/DrpDataRightsResponse.ts index ec31318a378..8e04213018b 100644 --- a/clients/admin-ui/src/types/api/models/DrpDataRightsResponse.ts +++ b/clients/admin-ui/src/types/api/models/DrpDataRightsResponse.ts @@ -1,15 +1,27 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { DrpAction } from "./DrpAction"; +import { DrpAction } from "./DrpAction"; /** + * DrpDataRightsResponse + * * Drp data rights response */ export type DrpDataRightsResponse = { + /** + * Version + */ version: string; + /** + * Api Base + */ api_base?: string | null; + /** + * Actions + */ actions: Array; + /** + * User Relationships + */ user_relationships?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/DrpMeta.ts b/clients/admin-ui/src/types/api/models/DrpMeta.ts index 89b38fc9a6b..a619fdc08fc 100644 --- a/clients/admin-ui/src/types/api/models/DrpMeta.ts +++ b/clients/admin-ui/src/types/api/models/DrpMeta.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DrpMeta + * * Enum to hold Drp metadata. Only version is supported at this time */ export type DrpMeta = { + /** + * Version + */ version: string; }; diff --git a/clients/admin-ui/src/types/api/models/DrpPrivacyRequestCreate.ts b/clients/admin-ui/src/types/api/models/DrpPrivacyRequestCreate.ts index e98d990fb7f..0f33be67676 100644 --- a/clients/admin-ui/src/types/api/models/DrpPrivacyRequestCreate.ts +++ b/clients/admin-ui/src/types/api/models/DrpPrivacyRequestCreate.ts @@ -1,19 +1,31 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { DrpAction } from "./DrpAction"; +import { DrpAction } from "./DrpAction"; import type { DrpMeta } from "./DrpMeta"; -import type { DrpRegime } from "./DrpRegime"; +import { DrpRegime } from "./DrpRegime"; /** + * DrpPrivacyRequestCreate + * * Data required to create a DRP PrivacyRequest */ export type DrpPrivacyRequestCreate = { meta: DrpMeta; regime?: DrpRegime | null; + /** + * Exercise + */ exercise: Array; + /** + * Relationships + */ relationships?: Array | null; + /** + * Identity + */ identity: string; + /** + * Status Callback + */ status_callback?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/DrpRegime.ts b/clients/admin-ui/src/types/api/models/DrpRegime.ts index 1b2fe9ad19a..510c5842c71 100644 --- a/clients/admin-ui/src/types/api/models/DrpRegime.ts +++ b/clients/admin-ui/src/types/api/models/DrpRegime.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DrpRegime + * * Enum to hold Drp Regime. Only ccpa supported at this time */ export enum DrpRegime { diff --git a/clients/admin-ui/src/types/api/models/DrpRevokeRequest.ts b/clients/admin-ui/src/types/api/models/DrpRevokeRequest.ts index 74ea59b3453..1fec780582e 100644 --- a/clients/admin-ui/src/types/api/models/DrpRevokeRequest.ts +++ b/clients/admin-ui/src/types/api/models/DrpRevokeRequest.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DrpRevokeRequest + * * DRP Data Rights Revoke Request Body */ export type DrpRevokeRequest = { + /** + * Request Id + */ request_id: string; + /** + * Reason + */ reason?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/DryRunDatasetResponse.ts b/clients/admin-ui/src/types/api/models/DryRunDatasetResponse.ts index 4d55cc5f44f..73091cc7618 100644 --- a/clients/admin-ui/src/types/api/models/DryRunDatasetResponse.ts +++ b/clients/admin-ui/src/types/api/models/DryRunDatasetResponse.ts @@ -1,13 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { CollectionAddressResponse } from "./CollectionAddressResponse"; /** + * DryRunDatasetResponse + * * Response model for dataset dry run */ export type DryRunDatasetResponse = { collectionAddress: CollectionAddressResponse; - query: any; + /** + * Query + */ + query: unknown; }; diff --git a/clients/admin-ui/src/types/api/models/DuplicateDetectionApplicationConfig.ts b/clients/admin-ui/src/types/api/models/DuplicateDetectionApplicationConfig.ts index 24ab8b6e384..f3fb983d560 100644 --- a/clients/admin-ui/src/types/api/models/DuplicateDetectionApplicationConfig.ts +++ b/clients/admin-ui/src/types/api/models/DuplicateDetectionApplicationConfig.ts @@ -1,20 +1,26 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * DuplicateDetectionApplicationConfig + * * API model - configuration settings for duplicate privacy request detection. */ export type DuplicateDetectionApplicationConfig = { /** + * Enabled + * * Whether duplicate detection is enabled. Disabled by default. */ enabled?: boolean | null; /** + * Time Window Days + * * Time window in days for duplicate detection. Default is 1 year. */ time_window_days?: number | null; /** + * Match Identity Fields + * * Identity field names to match on for duplicate detection (e.g., 'email', 'phone_number'). Default is email only. */ match_identity_fields?: Array | null; diff --git a/clients/admin-ui/src/types/api/models/DynamicErasureEmailDocsSchema.ts b/clients/admin-ui/src/types/api/models/DynamicErasureEmailDocsSchema.ts index b66d56f1211..84b7a9992c0 100644 --- a/clients/admin-ui/src/types/api/models/DynamicErasureEmailDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/DynamicErasureEmailDocsSchema.ts @@ -1,21 +1,28 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { AdvancedSettings } from "./AdvancedSettings"; import type { FidesDatasetReference } from "./FidesDatasetReference"; /** + * DynamicErasureEmailDocsSchema + * * DynamicErasureEmailDocsSchema Secrets Schema for API Docs */ export type DynamicErasureEmailDocsSchema = { + /** + * Test Email Address + */ test_email_address?: string | null; advanced_settings?: AdvancedSettings; /** + * Third party vendor name field + * * Dataset reference to the field containing the third party vendor name. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. */ third_party_vendor_name: FidesDatasetReference; /** + * Recipient email address field + * * Dataset reference to the field containing the recipient email address. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. */ recipient_email_address: FidesDatasetReference; diff --git a/clients/admin-ui/src/types/api/models/DynamoDBDocsSchema.ts b/clients/admin-ui/src/types/api/models/DynamoDBDocsSchema.ts index d47be6dbd24..254dc5a95d1 100644 --- a/clients/admin-ui/src/types/api/models/DynamoDBDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/DynamoDBDocsSchema.ts @@ -1,30 +1,40 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AWSAuthMethod } from "./AWSAuthMethod"; +import { AWSAuthMethod } from "./AWSAuthMethod"; /** + * DynamoDBDocsSchema + * * DynamoDB Secrets Schema for API Docs */ export type DynamoDBDocsSchema = { /** + * Authentication Method + * * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. */ auth_method: AWSAuthMethod; /** + * Access Key ID + * * Part of the credentials that provide access to your AWS account. */ aws_access_key_id?: string | null; /** + * Secret Access Key + * * Part of the credentials that provide access to your AWS account. */ aws_secret_access_key?: string | null; /** + * Assume Role ARN + * * If provided, the ARN of the role that should be assumed to connect to AWS. */ aws_assume_role_arn?: string | null; /** + * Region + * * The AWS region where your DynamoDB table is located (ex. us-west-2). */ region_name: string; diff --git a/clients/admin-ui/src/types/api/models/DynamoDBMonitorParams.ts b/clients/admin-ui/src/types/api/models/DynamoDBMonitorParams.ts index 76c31d0f7d1..0294068efa0 100644 --- a/clients/admin-ui/src/types/api/models/DynamoDBMonitorParams.ts +++ b/clients/admin-ui/src/types/api/models/DynamoDBMonitorParams.ts @@ -1,9 +1,12 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * DynamoDBMonitorParams + */ export type DynamoDBMonitorParams = { /** + * Single Dataset + * * Whether the DynamoDB monitor should put all tables found in Dynamo into a single Fides Dataset, or one Dataset per Dynamo table */ single_dataset?: boolean | null; diff --git a/clients/admin-ui/src/types/api/models/EdgeDirection.ts b/clients/admin-ui/src/types/api/models/EdgeDirection.ts index dcce420fd73..c1f80a32a77 100644 --- a/clients/admin-ui/src/types/api/models/EdgeDirection.ts +++ b/clients/admin-ui/src/types/api/models/EdgeDirection.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * EdgeDirection + * * Direction of a FidesDataSetReference */ export enum EdgeDirection { diff --git a/clients/admin-ui/src/types/api/models/EditableMonitorConfig.ts b/clients/admin-ui/src/types/api/models/EditableMonitorConfig.ts index 88f99fd9728..367ed67154a 100644 --- a/clients/admin-ui/src/types/api/models/EditableMonitorConfig.ts +++ b/clients/admin-ui/src/types/api/models/EditableMonitorConfig.ts @@ -1,31 +1,45 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { BigQueryMonitorParams } from "./BigQueryMonitorParams"; import type { DynamoDBMonitorParams } from "./DynamoDBMonitorParams"; import type { MonitorClassifyParams } from "./MonitorClassifyParams"; -import type { MonitorFrequency } from "./MonitorFrequency"; +import { MonitorFrequency } from "./MonitorFrequency"; import type { S3MonitorParams } from "./S3MonitorParams"; import type { TestMonitorParams } from "./TestMonitorParams"; import type { TestWebsiteMonitorParams } from "./TestWebsiteMonitorParams"; import type { WebsiteMonitorParams } from "./WebsiteMonitorParams"; /** + * EditableMonitorConfig + * * Base model for monitor config containing the fields that can be updated via API */ export type EditableMonitorConfig = { + /** + * Name + */ name: string; + /** + * Key + */ key?: string | null; + /** + * Connection Config Key + */ connection_config_key: string; /** * Parameters for classification of discovered resources */ classify_params?: MonitorClassifyParams | null; /** + * Datasource Params + * * The datasource specific parameters, specified in a dictionary */ datasource_params?: + | { + [key: string]: unknown; + } | DynamoDBMonitorParams | S3MonitorParams | WebsiteMonitorParams @@ -34,24 +48,37 @@ export type EditableMonitorConfig = { | BigQueryMonitorParams | null; /** + * Databases + * * The databases that the monitor is scoped to actively monitor */ databases?: Array; + /** + * Execution Start Date + */ execution_start_date?: string | null; execution_frequency?: MonitorFrequency | null; /** + * Excluded Databases + * * The databases that the monitor should exclude from monitoring */ excluded_databases?: Array; /** + * Enabled + * * Indicates whether the monitor is enabled or not. Disabled monitors won't be executed */ enabled?: boolean | null; /** + * Shared Config Id + * * Reference to a shared monitor configuration */ shared_config_id?: string | null; /** + * Stewards + * * List of user IDs to set as stewards for this monitor */ stewards?: Array; diff --git a/clients/admin-ui/src/types/api/models/EmailDocsSchema.ts b/clients/admin-ui/src/types/api/models/EmailDocsSchema.ts index d7a6c34445e..f5317686579 100644 --- a/clients/admin-ui/src/types/api/models/EmailDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/EmailDocsSchema.ts @@ -1,15 +1,24 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { AdvancedSettings } from "./AdvancedSettings"; /** + * EmailDocsSchema + * * EmailDocsSchema Secrets Schema for API Docs */ export type EmailDocsSchema = { + /** + * Test Email Address + */ test_email_address?: string | null; advanced_settings?: AdvancedSettings; + /** + * Third Party Vendor Name + */ third_party_vendor_name: string; + /** + * Recipient Email Address + */ recipient_email_address: string; }; diff --git a/clients/admin-ui/src/types/api/models/EmbeddedLineItem.ts b/clients/admin-ui/src/types/api/models/EmbeddedLineItem.ts index 85723319372..ff3dae7e986 100644 --- a/clients/admin-ui/src/types/api/models/EmbeddedLineItem.ts +++ b/clients/admin-ui/src/types/api/models/EmbeddedLineItem.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * EmbeddedLineItem + * * Sparse details for an embedded TCF line item within another TCF component. Read-only. */ export type EmbeddedLineItem = { + /** + * Id + */ id: number; + /** + * Name + */ name: string; }; diff --git a/clients/admin-ui/src/types/api/models/EmbeddedPrivacyNoticeResponse.ts b/clients/admin-ui/src/types/api/models/EmbeddedPrivacyNoticeResponse.ts index 009e096a675..9241f48ad81 100644 --- a/clients/admin-ui/src/types/api/models/EmbeddedPrivacyNoticeResponse.ts +++ b/clients/admin-ui/src/types/api/models/EmbeddedPrivacyNoticeResponse.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * EmbeddedPrivacyNoticeResponse + * * Simple schema for embedding privacy notices in the experience config response */ export type EmbeddedPrivacyNoticeResponse = { + /** + * Id + */ id: string; + /** + * Name + */ name: string; }; diff --git a/clients/admin-ui/src/types/api/models/EmbeddedPurpose.ts b/clients/admin-ui/src/types/api/models/EmbeddedPurpose.ts index 8c2a511c981..dea62bc2b77 100644 --- a/clients/admin-ui/src/types/api/models/EmbeddedPurpose.ts +++ b/clients/admin-ui/src/types/api/models/EmbeddedPurpose.ts @@ -1,12 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * EmbeddedPurpose + * * Sparse details for an embedded purpose beneath a system or vendor section. Read-only. */ export type EmbeddedPurpose = { + /** + * Id + */ id: number; + /** + * Name + */ name: string; + /** + * Retention Period + */ retention_period?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/EmbeddedVendor.ts b/clients/admin-ui/src/types/api/models/EmbeddedVendor.ts index 268c49046fc..652fdf74b78 100644 --- a/clients/admin-ui/src/types/api/models/EmbeddedVendor.ts +++ b/clients/admin-ui/src/types/api/models/EmbeddedVendor.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * EmbeddedVendor + * * Sparse details for an embedded vendor beneath a purpose or feature section. Read-only. */ export type EmbeddedVendor = { + /** + * Id + */ id: string; + /** + * Name + */ name: string; }; diff --git a/clients/admin-ui/src/types/api/models/Endpoint.ts b/clients/admin-ui/src/types/api/models/Endpoint.ts index 06c46cf3054..09306fa3e51 100644 --- a/clients/admin-ui/src/types/api/models/Endpoint.ts +++ b/clients/admin-ui/src/types/api/models/Endpoint.ts @@ -1,16 +1,28 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { SaaSRequestMap } from "./SaaSRequestMap"; /** + * Endpoint + * * A collection of read/update/delete requests which corresponds to a FidesDataset collection (by name) */ export type Endpoint = { + /** + * Name + */ name: string; requests: SaaSRequestMap; + /** + * Skip Processing + */ skip_processing?: boolean; + /** + * After + */ after?: Array; + /** + * Erase After + */ erase_after?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/EnforcementLevel.ts b/clients/admin-ui/src/types/api/models/EnforcementLevel.ts index 74cdcb0fbbd..f541e34e6c0 100644 --- a/clients/admin-ui/src/types/api/models/EnforcementLevel.ts +++ b/clients/admin-ui/src/types/api/models/EnforcementLevel.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * EnforcementLevel + * * Enum is not formalized in the DB because it may be subject to frequent change */ export enum EnforcementLevel { diff --git a/clients/admin-ui/src/types/api/models/ErrorNotificationMode.ts b/clients/admin-ui/src/types/api/models/ErrorNotificationMode.ts index 2d1dd27428d..3b654190c04 100644 --- a/clients/admin-ui/src/types/api/models/ErrorNotificationMode.ts +++ b/clients/admin-ui/src/types/api/models/ErrorNotificationMode.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ErrorNotificationMode + */ export enum ErrorNotificationMode { CONSOLE_ONLY = "console_only", TOAST = "toast", diff --git a/clients/admin-ui/src/types/api/models/ErrorType.ts b/clients/admin-ui/src/types/api/models/ErrorType.ts index 79ccc954bc8..1a972cca42a 100644 --- a/clients/admin-ui/src/types/api/models/ErrorType.ts +++ b/clients/admin-ui/src/types/api/models/ErrorType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ErrorType + * * Enum for the type of error */ export enum ErrorType { diff --git a/clients/admin-ui/src/types/api/models/Evaluation.ts b/clients/admin-ui/src/types/api/models/Evaluation.ts index 6915acf1b3d..b6677ee7c4d 100644 --- a/clients/admin-ui/src/types/api/models/Evaluation.ts +++ b/clients/admin-ui/src/types/api/models/Evaluation.ts @@ -1,26 +1,32 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { StatusEnum } from "./StatusEnum"; +import { StatusEnum } from "./StatusEnum"; import type { Violation } from "./Violation"; /** + * Evaluation + * * The Evaluation resource model. * * This resource is created after an evaluation is executed. */ export type Evaluation = { /** + * Fides Key + * * A uuid generated for each unique evaluation. */ fides_key: string; status: StatusEnum; /** + * Violations + * * The model for violations within an evaluation. */ violations?: Array; /** + * Message + * * A human-readable string response for the evaluation. */ message?: string; diff --git a/clients/admin-ui/src/types/api/models/EventAuditResponse.ts b/clients/admin-ui/src/types/api/models/EventAuditResponse.ts index c4a009001ad..80e0c4f01b2 100644 --- a/clients/admin-ui/src/types/api/models/EventAuditResponse.ts +++ b/clients/admin-ui/src/types/api/models/EventAuditResponse.ts @@ -1,18 +1,47 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * EventAuditResponse + * * Response model for event audit log entries. */ export type EventAuditResponse = { + /** + * Id + */ id: string; + /** + * Created At + */ created_at: string; + /** + * Event Type + */ event_type: string; + /** + * Status + */ status: string; + /** + * Resource Type + */ resource_type?: string | null; + /** + * Resource Identifier + */ resource_identifier?: string | null; + /** + * Description + */ description?: string | null; - event_details?: null; + /** + * Event Details + */ + event_details?: { + [key: string]: unknown; + } | null; + /** + * User Id + */ user_id?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/ExecutePromptRequest.ts b/clients/admin-ui/src/types/api/models/ExecutePromptRequest.ts new file mode 100644 index 00000000000..2de5de77bf1 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ExecutePromptRequest.ts @@ -0,0 +1,20 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { PromptType } from "./PromptType"; + +/** + * ExecutePromptRequest + * + * Request to execute a prompt against the LLM. + */ +export type ExecutePromptRequest = { + /** + * Prompt + */ + prompt: string; + /** + * Model + */ + model?: string | null; + prompt_type?: PromptType | null; +}; diff --git a/clients/admin-ui/src/types/api/models/ExecutePromptResponse.ts b/clients/admin-ui/src/types/api/models/ExecutePromptResponse.ts new file mode 100644 index 00000000000..61f78854281 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ExecutePromptResponse.ts @@ -0,0 +1,23 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * ExecutePromptResponse + * + * Response from executing a prompt. + */ +export type ExecutePromptResponse = { + /** + * Model + */ + model: string; + /** + * Response Text + */ + response_text: string; + /** + * Raw Response + */ + raw_response?: { + [key: string]: unknown; + }; +}; diff --git a/clients/admin-ui/src/types/api/models/ExecutionAndAuditLogResponse.ts b/clients/admin-ui/src/types/api/models/ExecutionAndAuditLogResponse.ts index 6c0b3d46237..df6f09f02b3 100644 --- a/clients/admin-ui/src/types/api/models/ExecutionAndAuditLogResponse.ts +++ b/clients/admin-ui/src/types/api/models/ExecutionAndAuditLogResponse.ts @@ -1,23 +1,44 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ActionType } from "./ActionType"; -import type { AuditLogAction } from "./AuditLogAction"; -import type { ExecutionLogStatus } from "./ExecutionLogStatus"; +import { ActionType } from "./ActionType"; +import { AuditLogAction } from "./AuditLogAction"; +import { ExecutionLogStatus } from "./ExecutionLogStatus"; import type { FieldsAffectedResponse } from "./FieldsAffectedResponse"; /** + * ExecutionAndAuditLogResponse + * * Schema for the combined ExecutionLogs and Audit Logs * associated with a PrivacyRequest */ export type ExecutionAndAuditLogResponse = { + /** + * Connection Key + */ connection_key?: string | null; + /** + * Collection Name + */ collection_name?: string | null; + /** + * Fields Affected + */ fields_affected?: Array | null; + /** + * Message + */ message?: string | null; action_type?: ActionType | null; + /** + * Status + */ status?: ExecutionLogStatus | AuditLogAction | string | null; + /** + * Updated At + */ updated_at?: string | null; + /** + * User Id + */ user_id?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/ExecutionApplicationConfig.ts b/clients/admin-ui/src/types/api/models/ExecutionApplicationConfig.ts index 2e740bd11bf..5545dcd43ab 100644 --- a/clients/admin-ui/src/types/api/models/ExecutionApplicationConfig.ts +++ b/clients/admin-ui/src/types/api/models/ExecutionApplicationConfig.ts @@ -1,13 +1,26 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { SqlDryRunMode } from "./SqlDryRunMode"; +import { SqlDryRunMode } from "./SqlDryRunMode"; +/** + * ExecutionApplicationConfig + */ export type ExecutionApplicationConfig = { + /** + * Subject Identity Verification Required + */ subject_identity_verification_required?: boolean | null; + /** + * Disable Consent Identity Verification + */ disable_consent_identity_verification?: boolean | null; + /** + * Require Manual Request Approval + */ require_manual_request_approval?: boolean | null; + /** + * Memory Watchdog Enabled + */ memory_watchdog_enabled?: boolean | null; sql_dry_run?: SqlDryRunMode | null; }; diff --git a/clients/admin-ui/src/types/api/models/ExecutionLogDetailResponse.ts b/clients/admin-ui/src/types/api/models/ExecutionLogDetailResponse.ts index 77f255f782e..0e002d6483f 100644 --- a/clients/admin-ui/src/types/api/models/ExecutionLogDetailResponse.ts +++ b/clients/admin-ui/src/types/api/models/ExecutionLogDetailResponse.ts @@ -1,21 +1,39 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ActionType } from "./ActionType"; -import type { ExecutionLogStatus } from "./ExecutionLogStatus"; +import { ActionType } from "./ActionType"; +import { ExecutionLogStatus } from "./ExecutionLogStatus"; import type { FieldsAffectedResponse } from "./FieldsAffectedResponse"; /** + * ExecutionLogDetailResponse + * * Schema for the detailed ExecutionLogs when accessed directly */ export type ExecutionLogDetailResponse = { status: ExecutionLogStatus; + /** + * Collection Name + */ collection_name?: string | null; + /** + * Fields Affected + */ fields_affected?: Array | null; + /** + * Message + */ message?: string | null; action_type: ActionType; + /** + * Updated At + */ updated_at?: string | null; + /** + * Connection Key + */ connection_key?: string | null; + /** + * Dataset Name + */ dataset_name?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/ExecutionLogResponse.ts b/clients/admin-ui/src/types/api/models/ExecutionLogResponse.ts index 187be53e3a2..fd9fd7ebb2f 100644 --- a/clients/admin-ui/src/types/api/models/ExecutionLogResponse.ts +++ b/clients/admin-ui/src/types/api/models/ExecutionLogResponse.ts @@ -1,19 +1,34 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ExecutionLogStatus } from "./ExecutionLogStatus"; -import type { TaskRunType } from "./TaskRunType"; +import { ExecutionLogStatus } from "./ExecutionLogStatus"; +import { TaskRunType } from "./TaskRunType"; /** + * ExecutionLogResponse + * * Response model for task execution logs */ export type ExecutionLogResponse = { + /** + * Id + */ id: string; + /** + * Celery Id + */ celery_id: string; status: ExecutionLogStatus; + /** + * Message + */ message?: string | null; run_type: TaskRunType; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at: string; }; diff --git a/clients/admin-ui/src/types/api/models/ExecutionLogStatus.ts b/clients/admin-ui/src/types/api/models/ExecutionLogStatus.ts index 8e58fe78238..3abbe6bf456 100644 --- a/clients/admin-ui/src/types/api/models/ExecutionLogStatus.ts +++ b/clients/admin-ui/src/types/api/models/ExecutionLogStatus.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ExecutionLogStatus + * * Enum for task execution log statuses, reflecting where they are in their workflow */ export enum ExecutionLogStatus { @@ -13,4 +13,5 @@ export enum ExecutionLogStatus { PAUSED = "paused", RETRYING = "retrying", SKIPPED = "skipped", + POLLING = "polling", } diff --git a/clients/admin-ui/src/types/api/models/ExperienceConfigCreate.ts b/clients/admin-ui/src/types/api/models/ExperienceConfigCreate.ts index f292a9b8cda..f1fa6030108 100644 --- a/clients/admin-ui/src/types/api/models/ExperienceConfigCreate.ts +++ b/clients/admin-ui/src/types/api/models/ExperienceConfigCreate.ts @@ -1,41 +1,84 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ComponentType } from "./ComponentType"; +import { ComponentType } from "./ComponentType"; import type { ExperienceTranslationCreate } from "./ExperienceTranslationCreate"; -import type { Layer1ButtonOption } from "./Layer1ButtonOption"; +import { Layer1ButtonOption } from "./Layer1ButtonOption"; import type { MinimalProperty } from "./MinimalProperty"; -import type { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; -import type { RejectAllMechanism } from "./RejectAllMechanism"; +import { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; +import { RejectAllMechanism } from "./RejectAllMechanism"; /** + * ExperienceConfigCreate + * * Schema for creating Experience Configs via the API * * Privacy notices are specified as a list of ids instead of keys like the template */ export type ExperienceConfigCreate = { + /** + * Name + */ name: string; + /** + * Disabled + */ disabled?: boolean | null; + /** + * Dismissable + */ dismissable?: boolean | null; + /** + * Show Layer1 Notices + */ show_layer1_notices?: boolean | null; layer1_button_options?: Layer1ButtonOption | null; + /** + * Allow Language Selection + */ allow_language_selection?: boolean | null; + /** + * Auto Detect Language + */ auto_detect_language?: boolean | null; + /** + * Auto Subdomain Cookie Deletion + */ auto_subdomain_cookie_deletion?: boolean | null; + /** + * Cookie Deletion Based On Host Domain + */ cookie_deletion_based_on_host_domain?: boolean | null; - /** Enable Vendor / Asset Disclosure */ + /** + * Allow Vendor Asset Disclosure + */ allow_vendor_asset_disclosure?: boolean | null; - /** Asset types to disclose */ + /** + * Asset Disclosure Include Types + */ asset_disclosure_include_types?: Array | null; + /** + * Regions + */ regions?: Array; + /** + * Tcf Configuration Id + */ tcf_configuration_id?: string | null; component: ComponentType; /** * Determines the behavior of the reject all button */ reject_all_mechanism?: RejectAllMechanism | null; + /** + * Privacy Notice Ids + */ privacy_notice_ids?: Array; + /** + * Translations + */ translations?: Array; + /** + * Properties + */ properties?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ExperienceConfigDisabledResponse.ts b/clients/admin-ui/src/types/api/models/ExperienceConfigDisabledResponse.ts index 6aa0bc5b709..d00a07a3d79 100644 --- a/clients/admin-ui/src/types/api/models/ExperienceConfigDisabledResponse.ts +++ b/clients/admin-ui/src/types/api/models/ExperienceConfigDisabledResponse.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ExperienceConfigDisabledResponse + * * A minimal response for updating just whether an Experience Config is disabled */ export type ExperienceConfigDisabledResponse = { + /** + * Disabled + */ disabled: boolean; + /** + * Id + */ id: string; }; diff --git a/clients/admin-ui/src/types/api/models/ExperienceConfigDisabledUpdate.ts b/clients/admin-ui/src/types/api/models/ExperienceConfigDisabledUpdate.ts index 1a6f845556b..6a1e8015f1b 100644 --- a/clients/admin-ui/src/types/api/models/ExperienceConfigDisabledUpdate.ts +++ b/clients/admin-ui/src/types/api/models/ExperienceConfigDisabledUpdate.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ExperienceConfigDisabledUpdate + * * A minimal request body that just allows you to update whether an Experience Config is disabled */ export type ExperienceConfigDisabledUpdate = { + /** + * Disabled + */ disabled: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/ExperienceConfigListViewResponse.ts b/clients/admin-ui/src/types/api/models/ExperienceConfigListViewResponse.ts index 69897ac1a6d..5dbb41ae62a 100644 --- a/clients/admin-ui/src/types/api/models/ExperienceConfigListViewResponse.ts +++ b/clients/admin-ui/src/types/api/models/ExperienceConfigListViewResponse.ts @@ -1,20 +1,38 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ComponentType } from "./ComponentType"; +import { ComponentType } from "./ComponentType"; import type { MinimalProperty } from "./MinimalProperty"; -import type { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; +import { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; /** + * ExperienceConfigListViewResponse + * * Limited schema that supplies the minimum details for the Experience Config list view */ export type ExperienceConfigListViewResponse = { + /** + * Id + */ id: string; + /** + * Name + */ name: string; + /** + * Regions + */ regions: Array; component: ComponentType; + /** + * Updated At + */ updated_at: string; + /** + * Disabled + */ disabled: boolean; + /** + * Properties + */ properties: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ExperienceConfigResponse.ts b/clients/admin-ui/src/types/api/models/ExperienceConfigResponse.ts index 4242988e140..292faa492b0 100644 --- a/clients/admin-ui/src/types/api/models/ExperienceConfigResponse.ts +++ b/clients/admin-ui/src/types/api/models/ExperienceConfigResponse.ts @@ -1,41 +1,96 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ComponentType } from "./ComponentType"; +import { ComponentType } from "./ComponentType"; import type { EmbeddedPrivacyNoticeResponse } from "./EmbeddedPrivacyNoticeResponse"; import type { ExperienceTranslationResponse } from "./ExperienceTranslationResponse"; -import type { Layer1ButtonOption } from "./Layer1ButtonOption"; +import { Layer1ButtonOption } from "./Layer1ButtonOption"; import type { MinimalProperty } from "./MinimalProperty"; -import type { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; -import type { RejectAllMechanism } from "./RejectAllMechanism"; +import { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; +import { RejectAllMechanism } from "./RejectAllMechanism"; /** + * ExperienceConfigResponse + * * An API representation of ExperienceConfig used for response payloads */ export type ExperienceConfigResponse = { + /** + * Name + */ name: string; + /** + * Disabled + */ disabled?: boolean | null; + /** + * Dismissable + */ dismissable?: boolean | null; + /** + * Show Layer1 Notices + */ show_layer1_notices?: boolean | null; layer1_button_options?: Layer1ButtonOption | null; + /** + * Allow Language Selection + */ allow_language_selection?: boolean | null; + /** + * Auto Detect Language + */ auto_detect_language?: boolean | null; + /** + * Auto Subdomain Cookie Deletion + */ auto_subdomain_cookie_deletion?: boolean | null; + /** + * Cookie Deletion Based On Host Domain + */ cookie_deletion_based_on_host_domain?: boolean | null; - /** Enable Vendor / Asset Disclosure */ + /** + * Allow Vendor Asset Disclosure + */ allow_vendor_asset_disclosure?: boolean | null; - /** Asset types to disclose */ + /** + * Asset Disclosure Include Types + */ asset_disclosure_include_types?: Array | null; + /** + * Regions + */ regions: Array; + /** + * Tcf Configuration Id + */ tcf_configuration_id?: string | null; + /** + * Id + */ id: string; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at: string; + /** + * Origin + */ origin?: string | null; component: ComponentType; + /** + * Privacy Notices + */ privacy_notices?: Array; + /** + * Translations + */ translations?: Array; + /** + * Properties + */ properties?: Array; /** * Determines the behavior of the reject all button diff --git a/clients/admin-ui/src/types/api/models/ExperienceConfigResponseNoNotices.ts b/clients/admin-ui/src/types/api/models/ExperienceConfigResponseNoNotices.ts index 4dcf2da03c0..bd2be60c52b 100644 --- a/clients/admin-ui/src/types/api/models/ExperienceConfigResponseNoNotices.ts +++ b/clients/admin-ui/src/types/api/models/ExperienceConfigResponseNoNotices.ts @@ -1,36 +1,89 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ComponentType } from "./ComponentType"; +import { ComponentType } from "./ComponentType"; import type { ExperienceTranslationResponse } from "./ExperienceTranslationResponse"; -import type { Layer1ButtonOption } from "./Layer1ButtonOption"; +import { Layer1ButtonOption } from "./Layer1ButtonOption"; import type { MinimalProperty } from "./MinimalProperty"; -import type { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; -import type { RejectAllMechanism } from "./RejectAllMechanism"; +import { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; +import { RejectAllMechanism } from "./RejectAllMechanism"; /** + * ExperienceConfigResponseNoNotices + * * Schema for embedding an Experience Config in a Privacy Experience response. * * - Privacy Notices aren't displayed here; they are instead going to be top-level. */ export type ExperienceConfigResponseNoNotices = { + /** + * Name + */ name: string; + /** + * Disabled + */ disabled?: boolean | null; + /** + * Dismissable + */ dismissable?: boolean | null; + /** + * Show Layer1 Notices + */ show_layer1_notices?: boolean | null; layer1_button_options?: Layer1ButtonOption | null; + /** + * Allow Language Selection + */ allow_language_selection?: boolean | null; + /** + * Auto Detect Language + */ auto_detect_language?: boolean | null; + /** + * Auto Subdomain Cookie Deletion + */ auto_subdomain_cookie_deletion?: boolean | null; + /** + * Cookie Deletion Based On Host Domain + */ cookie_deletion_based_on_host_domain?: boolean | null; + /** + * Allow Vendor Asset Disclosure + */ + allow_vendor_asset_disclosure?: boolean | null; + /** + * Asset Disclosure Include Types + */ + asset_disclosure_include_types?: Array | null; + /** + * Regions + */ regions: Array; + /** + * Tcf Configuration Id + */ tcf_configuration_id?: string | null; + /** + * Id + */ id: string; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at: string; component: ComponentType; + /** + * Translations + */ translations?: Array; + /** + * Properties + */ properties?: Array; /** * Determines the behavior of the reject all button diff --git a/clients/admin-ui/src/types/api/models/ExperienceConfigUpdate.ts b/clients/admin-ui/src/types/api/models/ExperienceConfigUpdate.ts index 09f06012892..15921d64c45 100644 --- a/clients/admin-ui/src/types/api/models/ExperienceConfigUpdate.ts +++ b/clients/admin-ui/src/types/api/models/ExperienceConfigUpdate.ts @@ -1,14 +1,14 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ExperienceTranslation } from "./ExperienceTranslation"; -import type { Layer1ButtonOption } from "./Layer1ButtonOption"; +import { Layer1ButtonOption } from "./Layer1ButtonOption"; import type { MinimalProperty } from "./MinimalProperty"; -import type { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; -import type { RejectAllMechanism } from "./RejectAllMechanism"; +import { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; +import { RejectAllMechanism } from "./RejectAllMechanism"; /** + * ExperienceConfigUpdate + * * The schema to update an ExperienceConfig via the API. * * Note that component cannot be updated once its created. @@ -19,23 +19,66 @@ import type { RejectAllMechanism } from "./RejectAllMechanism"; * schema after patch dry updates are applied. */ export type ExperienceConfigUpdate = { + /** + * Name + */ name?: string | null; + /** + * Disabled + */ disabled?: boolean | null; + /** + * Dismissable + */ dismissable?: boolean | null; + /** + * Show Layer1 Notices + */ show_layer1_notices?: boolean | null; layer1_button_options?: Layer1ButtonOption | null; + /** + * Allow Language Selection + */ allow_language_selection?: boolean | null; + /** + * Auto Detect Language + */ auto_detect_language?: boolean | null; + /** + * Auto Subdomain Cookie Deletion + */ auto_subdomain_cookie_deletion?: boolean | null; + /** + * Cookie Deletion Based On Host Domain + */ cookie_deletion_based_on_host_domain?: boolean | null; - /** Enable Vendor / Asset Disclosure */ + /** + * Allow Vendor Asset Disclosure + */ allow_vendor_asset_disclosure?: boolean | null; - /** Asset types to disclose */ + /** + * Asset Disclosure Include Types + */ asset_disclosure_include_types?: Array | null; + /** + * Regions + */ regions: Array; + /** + * Tcf Configuration Id + */ tcf_configuration_id?: string | null; + /** + * Translations + */ translations: Array; + /** + * Privacy Notice Ids + */ privacy_notice_ids: Array; + /** + * Properties + */ properties: Array; /** * Determines the behavior of the reject all button diff --git a/clients/admin-ui/src/types/api/models/ExperienceMeta.ts b/clients/admin-ui/src/types/api/models/ExperienceMeta.ts index f192bf96d19..10cff1ac207 100644 --- a/clients/admin-ui/src/types/api/models/ExperienceMeta.ts +++ b/clients/admin-ui/src/types/api/models/ExperienceMeta.ts @@ -1,26 +1,38 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { GPPMobileData } from "./GPPMobileData"; import type { TCMobileData } from "./TCMobileData"; /** + * ExperienceMeta + * * Supplements experience with developer-friendly meta information */ export type ExperienceMeta = { /** + * Version Hash + * * A hashed value that can be compared to previously-fetched hash values to determine if the Experience has meaningfully changed */ version_hash?: string | null; /** + * Accept All Fides String + * * The fides string (TC String + AC String) corresponding to a user opting in to all available options */ accept_all_fides_string?: string | null; + /** + * Accept All Fides Mobile Data + */ accept_all_fides_mobile_data?: TCMobileData | GPPMobileData | null; /** + * Reject All Fides String + * * The fides string (TC String + AC String) corresponding to a user opting out of all available options */ reject_all_fides_string?: string | null; + /** + * Reject All Fides Mobile Data + */ reject_all_fides_mobile_data?: TCMobileData | GPPMobileData | null; }; diff --git a/clients/admin-ui/src/types/api/models/ExperienceMinimalMeta.ts b/clients/admin-ui/src/types/api/models/ExperienceMinimalMeta.ts index 72988fabb27..525b0ec8dd6 100644 --- a/clients/admin-ui/src/types/api/models/ExperienceMinimalMeta.ts +++ b/clients/admin-ui/src/types/api/models/ExperienceMinimalMeta.ts @@ -1,12 +1,14 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ExperienceMinimalMeta + * * A subset of the Experience Meta information for use in the minimal TCF banner */ export type ExperienceMinimalMeta = { /** + * Version Hash + * * A hashed value that can be compared to previously-fetched hash values to determine if the Experience has meaningfully changed */ version_hash?: string | null; diff --git a/clients/admin-ui/src/types/api/models/ExperienceTranslation.ts b/clients/admin-ui/src/types/api/models/ExperienceTranslation.ts index 4ab77c445e4..5cea2f7b1dd 100644 --- a/clients/admin-ui/src/types/api/models/ExperienceTranslation.ts +++ b/clients/admin-ui/src/types/api/models/ExperienceTranslation.ts @@ -1,87 +1,125 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { SupportedLanguage } from "./SupportedLanguage"; +import { SupportedLanguage } from "./SupportedLanguage"; /** + * ExperienceTranslation + * * Experience Translation Schema */ export type ExperienceTranslation = { language: SupportedLanguage; /** + * Accept Button Label + * * Accept or confirmation button label */ accept_button_label?: string | null; /** + * Acknowledge Button Label + * * Acknowledge button label for notice only */ acknowledge_button_label?: string | null; /** + * Banner Title + * * Banner title */ banner_title?: string | null; /** + * Gpc Label + * * Label for Global Privacy Control (e.g. 'Global Privacy Control') */ gpc_label?: string | null; /** + * Gpc Description + * * Description shown when GPC preference is honored */ gpc_description?: string | null; /** + * Gpc Status Applied Label + * * Label shown when GPC is applied (e.g. 'Applied') */ gpc_status_applied_label?: string | null; /** + * Gpc Status Overridden Label + * * Label shown when GPC is overridden (e.g. 'Overridden') */ gpc_status_overridden_label?: string | null; /** + * Gpc Title + * * Title for GPC info section (e.g. 'Global Privacy Control detected') */ gpc_title?: string | null; /** + * Is Default + * * Whether the given translation is the default */ is_default?: boolean | null; /** + * Modal Link Label + * * Modal link label */ modal_link_label?: string | null; /** + * Privacy Policy Link Label + * * Privacy policy link label */ privacy_policy_link_label?: string | null; /** + * Privacy Policy Url + * * Privacy policy URL */ privacy_policy_url?: string | null; /** + * Privacy Preferences Link Label + * * Privacy preferences link label */ privacy_preferences_link_label?: string | null; /** + * Purpose Header + * * Header above TCF purposes list on the banner */ purpose_header?: string | null; /** + * Reject Button Label + * * Reject button label */ reject_button_label?: string | null; /** + * Save Button Label + * * Save button label */ save_button_label?: string | null; /** + * Title + * * Overall title */ title?: string | null; /** + * Banner Description + * * Banner description. HTML descriptions are supported so links can be included. */ banner_description?: string | null; /** + * Description + * * Overall description - used for banner as well if applicable. HTML descriptions are supported so links can be included. */ description?: string | null; diff --git a/clients/admin-ui/src/types/api/models/ExperienceTranslationCreate.ts b/clients/admin-ui/src/types/api/models/ExperienceTranslationCreate.ts index 335e2353d06..7867414df3c 100644 --- a/clients/admin-ui/src/types/api/models/ExperienceTranslationCreate.ts +++ b/clients/admin-ui/src/types/api/models/ExperienceTranslationCreate.ts @@ -1,82 +1,122 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { SupportedLanguage } from "./SupportedLanguage"; +import { SupportedLanguage } from "./SupportedLanguage"; /** + * ExperienceTranslationCreate + * * Overrides ExperienceTranslation fields to make some fields required on create */ export type ExperienceTranslationCreate = { language: SupportedLanguage; /** + * Accept Button Label + * * Accept or confirmation button label */ accept_button_label?: string | null; /** + * Acknowledge Button Label + * * Acknowledge button label for notice only */ acknowledge_button_label?: string | null; /** + * Banner Title + * * Banner title */ banner_title?: string | null; /** + * Gpc Label + * * Label for Global Privacy Control (e.g. 'Global Privacy Control') */ gpc_label?: string | null; /** + * Gpc Description + * * Description shown when GPC preference is honored */ gpc_description?: string | null; /** + * Gpc Status Applied Label + * * Label shown when GPC is applied (e.g. 'Applied') */ gpc_status_applied_label?: string | null; /** + * Gpc Status Overridden Label + * * Label shown when GPC is overridden (e.g. 'Overridden') */ gpc_status_overridden_label?: string | null; /** + * Gpc Title + * * Title for GPC info section (e.g. 'Global Privacy Control detected') */ gpc_title?: string | null; /** + * Is Default + * * Whether the given translation is the default */ is_default?: boolean | null; /** + * Modal Link Label + * * Modal link label */ modal_link_label?: string | null; /** + * Privacy Policy Link Label + * * Privacy policy link label */ privacy_policy_link_label?: string | null; /** + * Privacy Policy Url + * * Privacy policy URL */ privacy_policy_url?: string | null; /** + * Privacy Preferences Link Label + * * Privacy preferences link label */ privacy_preferences_link_label?: string | null; /** + * Purpose Header + * * Header above TCF purposes list on the banner */ purpose_header?: string | null; /** + * Reject Button Label + * * Reject button label */ reject_button_label?: string | null; /** + * Save Button Label + * * Save button label */ save_button_label?: string | null; + /** + * Title + */ title: string; /** + * Banner Description + * * Banner description. HTML descriptions are supported so links can be included. */ banner_description?: string | null; + /** + * Description + */ description: string; }; diff --git a/clients/admin-ui/src/types/api/models/ExperienceTranslationResponse.ts b/clients/admin-ui/src/types/api/models/ExperienceTranslationResponse.ts index 6c81beed17e..d504623a5c1 100644 --- a/clients/admin-ui/src/types/api/models/ExperienceTranslationResponse.ts +++ b/clients/admin-ui/src/types/api/models/ExperienceTranslationResponse.ts @@ -1,91 +1,131 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { SupportedLanguage } from "./SupportedLanguage"; +import { SupportedLanguage } from "./SupportedLanguage"; /** + * ExperienceTranslationResponse + * * Adds the historical id to the translation for the response */ export type ExperienceTranslationResponse = { language: SupportedLanguage; /** + * Accept Button Label + * * Accept or confirmation button label */ accept_button_label?: string | null; /** + * Acknowledge Button Label + * * Acknowledge button label for notice only */ acknowledge_button_label?: string | null; /** + * Banner Title + * * Banner title */ banner_title?: string | null; /** + * Gpc Label + * * Label for Global Privacy Control (e.g. 'Global Privacy Control') */ gpc_label?: string | null; /** + * Gpc Description + * * Description shown when GPC preference is honored */ gpc_description?: string | null; /** + * Gpc Status Applied Label + * * Label shown when GPC is applied (e.g. 'Applied') */ gpc_status_applied_label?: string | null; /** + * Gpc Status Overridden Label + * * Label shown when GPC is overridden (e.g. 'Overridden') */ gpc_status_overridden_label?: string | null; /** + * Gpc Title + * * Title for GPC info section (e.g. 'Global Privacy Control detected') */ gpc_title?: string | null; /** + * Is Default + * * Whether the given translation is the default */ is_default?: boolean | null; /** + * Modal Link Label + * * Modal link label */ modal_link_label?: string | null; /** + * Privacy Policy Link Label + * * Privacy policy link label */ privacy_policy_link_label?: string | null; /** + * Privacy Policy Url + * * Privacy policy URL */ privacy_policy_url?: string | null; /** + * Privacy Preferences Link Label + * * Privacy preferences link label */ privacy_preferences_link_label?: string | null; /** + * Purpose Header + * * Header above TCF purposes list on the banner */ purpose_header?: string | null; /** + * Reject Button Label + * * Reject button label */ reject_button_label?: string | null; /** + * Save Button Label + * * Save button label */ save_button_label?: string | null; /** + * Title + * * Overall title */ title?: string | null; /** + * Banner Description + * * Banner description. HTML descriptions are supported so links can be included. */ banner_description?: string | null; /** + * Description + * * Overall description - used for banner as well if applicable. HTML descriptions are supported so links can be included. */ description?: string | null; /** + * Privacy Experience Config History Id + * * The versioned artifact of the translation and its Experience Config. Should be supplied when saving privacy preferences for additional context. */ privacy_experience_config_history_id: string; diff --git a/clients/admin-ui/src/types/api/models/ExportFormat.ts b/clients/admin-ui/src/types/api/models/ExportFormat.ts new file mode 100644 index 00000000000..a6accac5509 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ExportFormat.ts @@ -0,0 +1,11 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * ExportFormat + * + * Export format enum. Add new formats here as needed. + */ +export enum ExportFormat { + CSV = "csv", + JSON = "json", +} diff --git a/clients/admin-ui/src/types/api/models/ExtendedIdentityTypes.ts b/clients/admin-ui/src/types/api/models/ExtendedIdentityTypes.ts index 81eef16b3ff..d3e93542117 100644 --- a/clients/admin-ui/src/types/api/models/ExtendedIdentityTypes.ts +++ b/clients/admin-ui/src/types/api/models/ExtendedIdentityTypes.ts @@ -1,12 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ExtendedIdentityTypes + * * Overrides basic IdentityTypes to add cookie_ids */ export type ExtendedIdentityTypes = { + /** + * Email + */ email: boolean; + /** + * Phone Number + */ phone_number: boolean; + /** + * Cookie Ids + */ cookie_ids?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ExternalDatasetReference.ts b/clients/admin-ui/src/types/api/models/ExternalDatasetReference.ts index 3eb6e482fd5..75efbcf23cf 100644 --- a/clients/admin-ui/src/types/api/models/ExternalDatasetReference.ts +++ b/clients/admin-ui/src/types/api/models/ExternalDatasetReference.ts @@ -1,9 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ExternalDatasetReference + */ export type ExternalDatasetReference = { + /** + * Name + */ name: string; + /** + * Label + */ label?: string | null; + /** + * Description + */ description?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/ExternalLoginOTPRequest.ts b/clients/admin-ui/src/types/api/models/ExternalLoginOTPRequest.ts index 7163c89e4ad..f6f5a905415 100644 --- a/clients/admin-ui/src/types/api/models/ExternalLoginOTPRequest.ts +++ b/clients/admin-ui/src/types/api/models/ExternalLoginOTPRequest.ts @@ -1,8 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ExternalLoginOTPRequest + */ export type ExternalLoginOTPRequest = { + /** + * Email + */ email: string; + /** + * Email Token + */ email_token: string; }; diff --git a/clients/admin-ui/src/types/api/models/ExternalLoginOTPResponse.ts b/clients/admin-ui/src/types/api/models/ExternalLoginOTPResponse.ts index f34a2ed0109..943a28f99c6 100644 --- a/clients/admin-ui/src/types/api/models/ExternalLoginOTPResponse.ts +++ b/clients/admin-ui/src/types/api/models/ExternalLoginOTPResponse.ts @@ -1,8 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ExternalLoginOTPResponse + */ export type ExternalLoginOTPResponse = { + /** + * Message + */ message: string; + /** + * Email + */ email: string; }; diff --git a/clients/admin-ui/src/types/api/models/ExternalLoginVerifyRequest.ts b/clients/admin-ui/src/types/api/models/ExternalLoginVerifyRequest.ts index 2803b17c0f9..34bb2cfd23b 100644 --- a/clients/admin-ui/src/types/api/models/ExternalLoginVerifyRequest.ts +++ b/clients/admin-ui/src/types/api/models/ExternalLoginVerifyRequest.ts @@ -1,8 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ExternalLoginVerifyRequest + */ export type ExternalLoginVerifyRequest = { + /** + * Email + */ email: string; + /** + * Otp Code + */ otp_code: string; }; diff --git a/clients/admin-ui/src/types/api/models/ExternalUserCreateRequest.ts b/clients/admin-ui/src/types/api/models/ExternalUserCreateRequest.ts index a3a90a04925..e839f19e55f 100644 --- a/clients/admin-ui/src/types/api/models/ExternalUserCreateRequest.ts +++ b/clients/admin-ui/src/types/api/models/ExternalUserCreateRequest.ts @@ -1,13 +1,25 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ExternalUserCreateRequest + * * Data required to create an external respondent user */ export type ExternalUserCreateRequest = { + /** + * Username + */ username: string; + /** + * Email Address + */ email_address: string; + /** + * First Name + */ first_name?: string | null; + /** + * Last Name + */ last_name?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/FidesCloudStatus.ts b/clients/admin-ui/src/types/api/models/FidesCloudStatus.ts index 0bb641ebc94..7b3c82bc195 100644 --- a/clients/admin-ui/src/types/api/models/FidesCloudStatus.ts +++ b/clients/admin-ui/src/types/api/models/FidesCloudStatus.ts @@ -1,7 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * FidesCloudStatus + */ export type FidesCloudStatus = { + /** + * Enabled + */ enabled?: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/FidesConsentMetaCreate.ts b/clients/admin-ui/src/types/api/models/FidesConsentMetaCreate.ts index 2e0a7df32a1..3d64ac4a3da 100644 --- a/clients/admin-ui/src/types/api/models/FidesConsentMetaCreate.ts +++ b/clients/admin-ui/src/types/api/models/FidesConsentMetaCreate.ts @@ -1,14 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConsentMethod } from "./ConsentMethod"; +import { ConsentMethod } from "./ConsentMethod"; /** + * FidesConsentMetaCreate + * * Privacy preference metadata fields defined by Fides. */ export type FidesConsentMetaCreate = { /** + * Geography + * * User geography, from the request */ geography?: string | null; @@ -17,19 +19,33 @@ export type FidesConsentMetaCreate = { */ method?: ConsentMethod | null; /** + * Request Origin + * * The request origin from the request headers */ request_origin?: string | null; /** + * Truncated Ip Address + * * Truncated IP address for reporting */ truncated_ip_address?: string | null; /** + * Recorded Url + * * The referrer from the request headers */ recorded_url?: string | null; /** + * User Agent + * * The user agent from the request headers */ user_agent?: string | null; + /** + * Property Id + * + * The Fides property ID + */ + property_id?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/FidesConsentMetaResponse.ts b/clients/admin-ui/src/types/api/models/FidesConsentMetaResponse.ts index a1d5f753a07..0d8f1bd1d65 100644 --- a/clients/admin-ui/src/types/api/models/FidesConsentMetaResponse.ts +++ b/clients/admin-ui/src/types/api/models/FidesConsentMetaResponse.ts @@ -1,14 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConsentMethod } from "./ConsentMethod"; +import { ConsentMethod } from "./ConsentMethod"; /** + * FidesConsentMetaResponse + * * Fides metadata for the consent request. */ export type FidesConsentMetaResponse = { /** + * Geography + * * User geography, from the request */ geography?: string | null; @@ -17,22 +19,38 @@ export type FidesConsentMetaResponse = { */ method?: ConsentMethod | null; /** + * Request Origin + * * The request origin from the request headers */ request_origin?: string | null; /** + * Truncated Ip Address + * * Truncated IP address for reporting */ truncated_ip_address?: string | null; /** + * Recorded Url + * * The referrer from the request headers */ recorded_url?: string | null; /** + * User Agent + * * The user agent from the request headers */ user_agent?: string | null; /** + * Property Id + * + * The Fides property ID + */ + property_id?: string | null; + /** + * Created At + * * The timestamp when consent was created in Fides */ created_at: string; diff --git a/clients/admin-ui/src/types/api/models/FidesConsentScopes.ts b/clients/admin-ui/src/types/api/models/FidesConsentScopes.ts index c5240885f08..e3ed395da6e 100644 --- a/clients/admin-ui/src/types/api/models/FidesConsentScopes.ts +++ b/clients/admin-ui/src/types/api/models/FidesConsentScopes.ts @@ -1,12 +1,14 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * FidesConsentScopes + * * Scopes with special purposes defined by Fides. */ export type FidesConsentScopes = { /** + * Property Id + * * The Fides property ID */ property_id?: string | null; diff --git a/clients/admin-ui/src/types/api/models/FidesDatasetReference.ts b/clients/admin-ui/src/types/api/models/FidesDatasetReference.ts index 9d5b1fa7c13..8f6a2d86db3 100644 --- a/clients/admin-ui/src/types/api/models/FidesDatasetReference.ts +++ b/clients/admin-ui/src/types/api/models/FidesDatasetReference.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { EdgeDirection } from "./EdgeDirection"; +import { EdgeDirection } from "./EdgeDirection"; /** + * FidesDatasetReference + * * Reference to a field from another Collection */ export type FidesDatasetReference = { + /** + * Dataset + */ dataset: string; + /** + * Field + */ field: string; direction?: EdgeDirection | null; }; diff --git a/clients/admin-ui/src/types/api/models/FidesDocsSchema.ts b/clients/admin-ui/src/types/api/models/FidesDocsSchema.ts index 6c3770524f6..13f5a249b22 100644 --- a/clients/admin-ui/src/types/api/models/FidesDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/FidesDocsSchema.ts @@ -1,14 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * FidesDocsSchema + * * Fides Child Secrets Schema for API docs */ export type FidesDocsSchema = { + /** + * Uri + */ uri: string; + /** + * Username + */ username: string; + /** + * Password + */ password: string; + /** + * Polling Timeout + */ polling_timeout?: number | null; + /** + * Polling Interval + */ polling_interval?: number | null; }; diff --git a/clients/admin-ui/src/types/api/models/FidesMeta.ts b/clients/admin-ui/src/types/api/models/FidesMeta.ts index 8d7f1c30528..23c0289876a 100644 --- a/clients/admin-ui/src/types/api/models/FidesMeta.ts +++ b/clients/admin-ui/src/types/api/models/FidesMeta.ts @@ -1,43 +1,59 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { FidesDatasetReference } from "./FidesDatasetReference"; import type { FieldMaskingStrategyOverride } from "./FieldMaskingStrategyOverride"; /** + * FidesMeta + * * Supplementary metadata used by the Fides application for additional features. */ export type FidesMeta = { /** + * References + * * Fields that current field references or is referenced by. Used for drawing the edges of a DSR graph. */ references?: Array | null; /** + * Identity + * * The type of the identity data that should be used to query this collection for a DSR. */ identity?: string | null; /** + * Primary Key + * * Whether the current field can be considered a primary key of the current collection */ primary_key?: boolean | null; /** + * Data Type + * * Optionally specify the data type. Fides will attempt to cast values to this type when querying. */ data_type?: string | null; /** + * Length + * * Optionally specify the allowable field length. Fides will not generate values that exceed this size. */ length?: number | null; /** + * Return All Elements + * * Optionally specify to query for the entire array if the array is an entrypoint into the node. Default is False. */ return_all_elements?: boolean | null; /** + * Read Only + * * Optionally specify if a field is read-only, meaning it can't be updated or deleted. */ read_only?: boolean | null; /** + * Custom Request Field + * * Optionally specify that a field may be used as a custom request field in DSRs. The value is the name of the field in the DSR. */ custom_request_field?: string | null; @@ -46,7 +62,9 @@ export type FidesMeta = { */ masking_strategy_override?: FieldMaskingStrategyOverride | null; /** - * Optionally specify that this entity's name should be redacted in DSR reports. When set to "name", the entity will be redacted using the indexed format (e.g., "dataset_1", "collection_1", "field_1"). + * Redact + * + * Specify 'name' to indicate the field name should be redacted. */ redact?: "name" | null; }; diff --git a/clients/admin-ui/src/types/api/models/Field.ts b/clients/admin-ui/src/types/api/models/Field.ts index 2efabaa06f5..b76eb6f28c0 100644 --- a/clients/admin-ui/src/types/api/models/Field.ts +++ b/clients/admin-ui/src/types/api/models/Field.ts @@ -1,13 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ClassificationWithConfidence } from "./ClassificationWithConfidence"; -import type { DiffStatus } from "./DiffStatus"; +import { DiffStatus } from "./DiffStatus"; import type { ResourceError } from "./ResourceError"; -import type { StagedResourceTypeValue } from "./StagedResourceTypeValue"; +import { StagedResourceTypeValue } from "./StagedResourceTypeValue"; /** + * Field + * * The Field model is also used to represent "sub-fields" that are nested under a * top-level field in a data source. * @@ -18,17 +18,43 @@ import type { StagedResourceTypeValue } from "./StagedResourceTypeValue"; * which is only populated if the Field is a sub-field. */ export type Field = { + /** + * Urn + */ urn: string; + /** + * User Assigned Data Categories + */ user_assigned_data_categories?: Array | null; /** + * User Assigned Data Uses + * * User assigned data uses overriding auto assigned data uses */ user_assigned_data_uses?: Array | null; + /** + * User Assigned System Key + */ user_assigned_system_key?: string | null; + /** + * Name + */ name?: string | null; + /** + * System Key + */ system_key?: string | null; + /** + * Description + */ description?: string | null; + /** + * Monitor Config Id + */ monitor_config_id?: string | null; + /** + * Updated At + */ updated_at?: string | null; /** * The diff status of the staged resource @@ -36,25 +62,111 @@ export type Field = { diff_status?: DiffStatus | null; resource_type?: StagedResourceTypeValue | null; /** + * Data Uses + * * The data uses associated with the staged resource */ data_uses?: Array | null; /** + * Errors + * * List of errors encountered during processing */ errors?: Array; + /** + * Source Modified + */ source_modified?: string | null; + /** + * Classifications + */ classifications?: Array; + /** + * Database Name + */ database_name?: string | null; + /** + * Schema Name + */ schema_name: string; + /** + * Parent Table Urn + */ parent_table_urn: string; + /** + * Table Name + */ table_name: string; + /** + * Data Type + */ data_type?: string | null; + /** + * Sub Field Urns + */ sub_field_urns?: Array; + /** + * Direct Child Urns + */ direct_child_urns?: Array; + /** + * Top Level Field Name + */ top_level_field_name?: string | null; + /** + * Top Level Field Urn + */ top_level_field_urn?: string | null; + /** + * Source Data Type + */ source_data_type?: string | null; + /** + * Sub Fields + */ sub_fields?: Array | null; - preferred_data_categories?: Array | null; + [key: string]: + | unknown + | string + | Array + | null + | Array + | null + | string + | null + | string + | null + | string + | null + | string + | null + | string + | null + | string + | null + | DiffStatus + | null + | StagedResourceTypeValue + | null + | Array + | null + | Array + | string + | null + | Array + | string + | null + | string + | null + | Array + | Array + | string + | null + | string + | null + | string + | null + | Array + | null + | undefined; }; diff --git a/clients/admin-ui/src/types/api/models/FieldAccuracyDetail.ts b/clients/admin-ui/src/types/api/models/FieldAccuracyDetail.ts new file mode 100644 index 00000000000..772ed9ee66d --- /dev/null +++ b/clients/admin-ui/src/types/api/models/FieldAccuracyDetail.ts @@ -0,0 +1,63 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * FieldAccuracyDetail + * + * Detailed accuracy information for a single field. + */ +export type FieldAccuracyDetail = { + /** + * Field Urn + * + * URN of the field being evaluated + */ + field_urn: string; + /** + * Staged Resource Categories + * + * Categories assigned by the system + */ + staged_resource_categories: Array; + /** + * Ground Truth Categories + * + * Ground truth categories from dataset + */ + ground_truth_categories: Array; + /** + * Is Correct + * + * Whether the field was classified correctly + */ + is_correct: boolean; + /** + * False Positives + * + * Categories that were incorrectly classified (false positives) + */ + false_positives: Array; + /** + * True Positives + * + * Categories that were correctly classified (true positives) + */ + true_positives: Array; + /** + * False Negatives + * + * Categories that were missed (false negatives) + */ + false_negatives: Array; + /** + * True Negatives + * + * Categories that were correctly classified as the default category (true negatives) + */ + true_negatives: Array; + /** + * Classification Error + * + * Whether the classification is an error, e.g. if our default tag is applied alongside other tags + */ + classification_error: boolean; +}; diff --git a/clients/admin-ui/src/types/api/models/FieldActionType.ts b/clients/admin-ui/src/types/api/models/FieldActionType.ts index 5207c3e5092..f21cce9d951 100644 --- a/clients/admin-ui/src/types/api/models/FieldActionType.ts +++ b/clients/admin-ui/src/types/api/models/FieldActionType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * FieldActionType + * * Supported action types for filtered field operations. */ export enum FieldActionType { diff --git a/clients/admin-ui/src/types/api/models/FieldMaskingStrategyOverride.ts b/clients/admin-ui/src/types/api/models/FieldMaskingStrategyOverride.ts index d47b2b2a10a..fa68e816588 100644 --- a/clients/admin-ui/src/types/api/models/FieldMaskingStrategyOverride.ts +++ b/clients/admin-ui/src/types/api/models/FieldMaskingStrategyOverride.ts @@ -1,11 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * FieldMaskingStrategyOverride + * * Overrides field-level masking strategies. */ export type FieldMaskingStrategyOverride = { + /** + * Strategy + */ strategy: string; - configuration?: null; + /** + * Configuration + */ + configuration?: { + [key: string]: unknown; + } | null; }; diff --git a/clients/admin-ui/src/types/api/models/FieldsAffectedResponse.ts b/clients/admin-ui/src/types/api/models/FieldsAffectedResponse.ts index 66d26daccc4..451193a6f1f 100644 --- a/clients/admin-ui/src/types/api/models/FieldsAffectedResponse.ts +++ b/clients/admin-ui/src/types/api/models/FieldsAffectedResponse.ts @@ -1,12 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * FieldsAffectedResponse + * * Schema detailing the individual fields affected by a particular query detailed in the ExecutionLog */ export type FieldsAffectedResponse = { + /** + * Path + */ path: string | null; + /** + * Field Name + */ field_name: string | null; + /** + * Data Categories + */ data_categories: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/FilteredFieldActionRequest.ts b/clients/admin-ui/src/types/api/models/FilteredFieldActionRequest.ts index 9409217308c..01ec67452c1 100644 --- a/clients/admin-ui/src/types/api/models/FilteredFieldActionRequest.ts +++ b/clients/admin-ui/src/types/api/models/FilteredFieldActionRequest.ts @@ -1,12 +1,14 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * FilteredFieldActionRequest + * * Request model for performing actions on filtered fields with optional exclusions */ export type FilteredFieldActionRequest = { /** + * Excluded Resource Urns + * * List of resource URNs to exclude from the action */ excluded_resource_urns?: Array; diff --git a/clients/admin-ui/src/types/api/models/FilteredPrivacyRequestResults.ts b/clients/admin-ui/src/types/api/models/FilteredPrivacyRequestResults.ts index 8205302d90a..55afc3481a7 100644 --- a/clients/admin-ui/src/types/api/models/FilteredPrivacyRequestResults.ts +++ b/clients/admin-ui/src/types/api/models/FilteredPrivacyRequestResults.ts @@ -1,14 +1,24 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { PrivacyRequestStatus } from "./PrivacyRequestStatus"; +import { PrivacyRequestStatus } from "./PrivacyRequestStatus"; /** + * FilteredPrivacyRequestResults + * * Schema representing the status and results of a test privacy request */ export type FilteredPrivacyRequestResults = { + /** + * Privacy Request Id + */ privacy_request_id: string; status: PrivacyRequestStatus; - results: string; + /** + * Results + */ + results: + | { + [key: string]: unknown; + } + | string; }; diff --git a/clients/admin-ui/src/types/api/models/GCSAuthMethod.ts b/clients/admin-ui/src/types/api/models/GCSAuthMethod.ts index 34406e338ff..aaf900db8e3 100644 --- a/clients/admin-ui/src/types/api/models/GCSAuthMethod.ts +++ b/clients/admin-ui/src/types/api/models/GCSAuthMethod.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * GCSAuthMethod + */ export enum GCSAuthMethod { ADC = "adc", SERVICE_ACCOUNT_KEYS = "service_account_keys", diff --git a/clients/admin-ui/src/types/api/models/GPPApplicationConfig.ts b/clients/admin-ui/src/types/api/models/GPPApplicationConfig.ts index 1b72f4dd0e2..cef2f1f65fb 100644 --- a/clients/admin-ui/src/types/api/models/GPPApplicationConfig.ts +++ b/clients/admin-ui/src/types/api/models/GPPApplicationConfig.ts @@ -1,13 +1,26 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { GPPUSApproach } from "./GPPUSApproach"; +import { GPPUSApproach } from "./GPPUSApproach"; +/** + * GPPApplicationConfig + */ export type GPPApplicationConfig = { us_approach?: GPPUSApproach | null; + /** + * Mspa Service Provider Mode + */ mspa_service_provider_mode?: boolean | null; + /** + * Mspa Opt Out Option Mode + */ mspa_opt_out_option_mode?: boolean | null; + /** + * Mspa Covered Transactions + */ mspa_covered_transactions?: boolean | null; + /** + * Enable Tcfeu String + */ enable_tcfeu_string?: boolean | null; }; diff --git a/clients/admin-ui/src/types/api/models/GPPFieldMapping.ts b/clients/admin-ui/src/types/api/models/GPPFieldMapping.ts index fc2495b8f40..9eb95a318f5 100644 --- a/clients/admin-ui/src/types/api/models/GPPFieldMapping.ts +++ b/clients/admin-ui/src/types/api/models/GPPFieldMapping.ts @@ -1,12 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { GPPMechanismMapping } from "./GPPMechanismMapping"; -import type { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; +import { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; +/** + * GPPFieldMapping + */ export type GPPFieldMapping = { region: PrivacyNoticeRegion; + /** + * Notice + */ notice?: Array | null; + /** + * Mechanism + */ mechanism?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/GPPFieldMappingCreate.ts b/clients/admin-ui/src/types/api/models/GPPFieldMappingCreate.ts index 20f5705f057..8edb5b921e2 100644 --- a/clients/admin-ui/src/types/api/models/GPPFieldMappingCreate.ts +++ b/clients/admin-ui/src/types/api/models/GPPFieldMappingCreate.ts @@ -1,12 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { GPPMechanismMapping } from "./GPPMechanismMapping"; -import type { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; +import { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; +/** + * GPPFieldMappingCreate + */ export type GPPFieldMappingCreate = { region: PrivacyNoticeRegion; + /** + * Notice + */ notice?: Array | null; + /** + * Mechanism + */ mechanism?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/GPPMechanismMapping.ts b/clients/admin-ui/src/types/api/models/GPPMechanismMapping.ts index c44c07f3d2d..c4f51b8bfd8 100644 --- a/clients/admin-ui/src/types/api/models/GPPMechanismMapping.ts +++ b/clients/admin-ui/src/types/api/models/GPPMechanismMapping.ts @@ -1,10 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * GPPMechanismMapping + */ export type GPPMechanismMapping = { + /** + * Field + */ field: string; + /** + * Not Available + */ not_available: string; + /** + * Opt Out + */ opt_out: string; + /** + * Not Opt Out + */ not_opt_out: string; }; diff --git a/clients/admin-ui/src/types/api/models/GPPMobileData.ts b/clients/admin-ui/src/types/api/models/GPPMobileData.ts index 9d84aad4642..e27663a15c9 100644 --- a/clients/admin-ui/src/types/api/models/GPPMobileData.ts +++ b/clients/admin-ui/src/types/api/models/GPPMobileData.ts @@ -1,25 +1,34 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * GPPMobileData + * * Pre-parsed GPP data and GPP string for a CMP SDK */ export type GPPMobileData = { /** + * Iabgpp Hdr Version + * * GPP version */ IABGPP_HDR_Version: string; /** + * Iabgpp Hdr Sections + * * List of section IDs */ IABGPP_HDR_Sections: string; /** + * Iabgpp Hdr Gppstring + * * Full consent string in its encoded form */ IABGPP_HDR_GppString: string; /** + * Iabgpp Gppsid + * * Section ID(s) considered to be in force. Multiple IDs are separated by underscores */ IABGPP_GppSID: string; + [key: string]: unknown | string | string; }; diff --git a/clients/admin-ui/src/types/api/models/GPPUSApproach.ts b/clients/admin-ui/src/types/api/models/GPPUSApproach.ts index 528413c3dd8..3a484f7f502 100644 --- a/clients/admin-ui/src/types/api/models/GPPUSApproach.ts +++ b/clients/admin-ui/src/types/api/models/GPPUSApproach.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * GPPUSApproach + */ export enum GPPUSApproach { ALL = "all", NATIONAL = "national", diff --git a/clients/admin-ui/src/types/api/models/Generate.ts b/clients/admin-ui/src/types/api/models/Generate.ts index 33782aedd32..c098d158831 100644 --- a/clients/admin-ui/src/types/api/models/Generate.ts +++ b/clients/admin-ui/src/types/api/models/Generate.ts @@ -1,18 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { AWSConfig } from "./AWSConfig"; import type { BigQueryConfig } from "./BigQueryConfig"; import type { DatabaseConfig } from "./DatabaseConfig"; -import type { GenerateTypes } from "./GenerateTypes"; +import { GenerateTypes } from "./GenerateTypes"; import type { OktaConfig } from "./OktaConfig"; -import type { ValidTargets } from "./ValidTargets"; +import { ValidTargets } from "./ValidTargets"; /** + * Generate + * * Defines attributes for generating resources included in a request. */ export type Generate = { + /** + * Config + */ config: AWSConfig | OktaConfig | DatabaseConfig | BigQueryConfig; target: ValidTargets; type: GenerateTypes; diff --git a/clients/admin-ui/src/types/api/models/GenerateRequestPayload.ts b/clients/admin-ui/src/types/api/models/GenerateRequestPayload.ts index 55524c784a4..5d35fc3e716 100644 --- a/clients/admin-ui/src/types/api/models/GenerateRequestPayload.ts +++ b/clients/admin-ui/src/types/api/models/GenerateRequestPayload.ts @@ -1,13 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { Generate } from "./Generate"; /** + * GenerateRequestPayload + * * The model for the request body housing generate information. */ export type GenerateRequestPayload = { + /** + * Organization Key + */ organization_key: string; generate: Generate; }; diff --git a/clients/admin-ui/src/types/api/models/GenerateResponse.ts b/clients/admin-ui/src/types/api/models/GenerateResponse.ts index 0d9d9f0d65d..9629222db34 100644 --- a/clients/admin-ui/src/types/api/models/GenerateResponse.ts +++ b/clients/admin-ui/src/types/api/models/GenerateResponse.ts @@ -1,10 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts + +import type { Dataset } from "./Dataset"; +import type { System } from "./System"; /** + * GenerateResponse + * * The model to house the response for generated infrastructure. */ export type GenerateResponse = { - generate_results?: null; + /** + * Generate Results + */ + generate_results?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/GenerateTestDataRequest.ts b/clients/admin-ui/src/types/api/models/GenerateTestDataRequest.ts new file mode 100644 index 00000000000..54812a40713 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/GenerateTestDataRequest.ts @@ -0,0 +1,90 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { DiffStatusDistribution } from "./DiffStatusDistribution"; + +/** + * GenerateTestDataRequest + * + * Request body for generating test staged resources. + * + * Extends TestMonitorParams with additional fields for diff status distribution + * and database naming. + */ +export type GenerateTestDataRequest = { + /** + * Sharded Table Pattern + * + * Regex pattern to identify sharded tables + */ + sharded_table_pattern?: string | null; + /** + * Num Databases + * + * Number of databases to generate + */ + num_databases?: number; + /** + * Num Schemas Per Db + * + * Number of schemas to generate per database + */ + num_schemas_per_db?: number; + /** + * Num Tables Per Schema + * + * Number of tables to generate per schema + */ + num_tables_per_schema?: number; + /** + * Num Fields Per Table + * + * Number of fields to generate per table + */ + num_fields_per_table?: number; + /** + * Field Sample Data + * + * Sample data to return for field sampling + */ + field_sample_data?: Array; + /** + * Max Nesting Level + * + * Maximum depth of nested fields + */ + max_nesting_level?: number; + /** + * Nested Field Percentage + * + * Percentage of fields that should be nested (0.0 to 1.0) + */ + nested_field_percentage?: number; + /** + * Num Fields Per Nested + * + * Number of fields to generate for each nested field + */ + num_fields_per_nested?: number; + /** + * Simulate Classification + * + * Whether to simulate classification when calling the /classify endpoint + */ + simulate_classification?: boolean; + /** + * Classification Sleep Seconds + * + * Number of seconds to sleep during classification to simulate processing time + */ + classification_sleep_seconds?: number; + /** + * Db Base Name + * + * Optional base name prefix for generated databases + */ + db_base_name?: string; + /** + * Distribution of diff statuses across generated tables. Default: 50% ADDITION, 0% CLASSIFYING, 50% CLASSIFICATION_ADDITION + */ + diff_status_distribution?: DiffStatusDistribution; +}; diff --git a/clients/admin-ui/src/types/api/models/GenerateTypes.ts b/clients/admin-ui/src/types/api/models/GenerateTypes.ts index 3c3692062f0..82d8589f6db 100644 --- a/clients/admin-ui/src/types/api/models/GenerateTypes.ts +++ b/clients/admin-ui/src/types/api/models/GenerateTypes.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * GenerateTypes + * * Generate Type Enum to capture the discrete possible values * for a valid type of resource to generate. */ diff --git a/clients/admin-ui/src/types/api/models/GetRegistrationStatusResponse.ts b/clients/admin-ui/src/types/api/models/GetRegistrationStatusResponse.ts index 04c408207d5..111090c51cf 100644 --- a/clients/admin-ui/src/types/api/models/GetRegistrationStatusResponse.ts +++ b/clients/admin-ui/src/types/api/models/GetRegistrationStatusResponse.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * GetRegistrationStatusResponse + * * Reflects the registration status of a Fides deployment. */ export type GetRegistrationStatusResponse = { + /** + * Opt In + */ opt_in?: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/GoogleCloudSQLIPType.ts b/clients/admin-ui/src/types/api/models/GoogleCloudSQLIPType.ts index 298c8e24d59..e9fb543a2e9 100644 --- a/clients/admin-ui/src/types/api/models/GoogleCloudSQLIPType.ts +++ b/clients/admin-ui/src/types/api/models/GoogleCloudSQLIPType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * GoogleCloudSQLIPType + * * Enum for Google Cloud SQL IP types */ export enum GoogleCloudSQLIPType { diff --git a/clients/admin-ui/src/types/api/models/GoogleCloudSQLMySQLDocsSchema.ts b/clients/admin-ui/src/types/api/models/GoogleCloudSQLMySQLDocsSchema.ts index 82455f4109c..bfee676d698 100644 --- a/clients/admin-ui/src/types/api/models/GoogleCloudSQLMySQLDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/GoogleCloudSQLMySQLDocsSchema.ts @@ -1,28 +1,39 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds } from "./fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds"; -import type { GoogleCloudSQLIPType } from "./GoogleCloudSQLIPType"; +import { GoogleCloudSQLIPType } from "./GoogleCloudSQLIPType"; /** + * GoogleCloudSQLMySQLDocsSchema + * * Google Cloud SQL MySQL Secrets Schema for API Docs */ export type GoogleCloudSQLMySQLDocsSchema = { /** + * DB IAM user + * * example: service-account@test.iam.gserviceaccount.com */ db_iam_user: string; /** + * Instance connection name + * * example: friendly-tower-424214-n8:us-central1:test-ethyca */ instance_connection_name: string; + /** + * Database name + */ dbname: string; /** + * Keyfile creds + * * The contents of the key file that contains authentication credentials for a service account in GCP. */ keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds; /** + * IP type + * * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview */ ip_type?: GoogleCloudSQLIPType | null; diff --git a/clients/admin-ui/src/types/api/models/GoogleCloudSQLPostgresDocsSchema.ts b/clients/admin-ui/src/types/api/models/GoogleCloudSQLPostgresDocsSchema.ts index d563a4d96ca..f66603eb955 100644 --- a/clients/admin-ui/src/types/api/models/GoogleCloudSQLPostgresDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/GoogleCloudSQLPostgresDocsSchema.ts @@ -1,32 +1,45 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds } from "./fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds"; -import type { GoogleCloudSQLIPType } from "./GoogleCloudSQLIPType"; +import { GoogleCloudSQLIPType } from "./GoogleCloudSQLIPType"; /** + * GoogleCloudSQLPostgresDocsSchema + * * Google Cloud SQL Postgres Secrets Schema for API Docs */ export type GoogleCloudSQLPostgresDocsSchema = { /** + * DB IAM user + * * example: service-account@test.iam.gserviceaccount.com */ db_iam_user: string; /** + * Instance connection name + * * example: friendly-tower-424214-n8:us-central1:test-ethyca */ instance_connection_name: string; + /** + * Database name + */ dbname?: string | null; /** + * Schema + * * The default schema to be used for the database connection (defaults to public). */ db_schema?: string | null; /** + * Keyfile creds + * * The contents of the key file that contains authentication credentials for a service account in GCP. */ keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds; /** + * IP type + * * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview */ ip_type?: GoogleCloudSQLIPType | null; diff --git a/clients/admin-ui/src/types/api/models/GroupOperator.ts b/clients/admin-ui/src/types/api/models/GroupOperator.ts index 435308c38b2..9ede8924917 100644 --- a/clients/admin-ui/src/types/api/models/GroupOperator.ts +++ b/clients/admin-ui/src/types/api/models/GroupOperator.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * GroupOperator + */ export enum GroupOperator { AND = "and", OR = "or", diff --git a/clients/admin-ui/src/types/api/models/HTTPMethod.ts b/clients/admin-ui/src/types/api/models/HTTPMethod.ts index d1336ae97ca..9da6de10394 100644 --- a/clients/admin-ui/src/types/api/models/HTTPMethod.ts +++ b/clients/admin-ui/src/types/api/models/HTTPMethod.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * HTTPMethod + * * Enum to represent HTTP Methods */ export enum HTTPMethod { diff --git a/clients/admin-ui/src/types/api/models/HTTPValidationError.ts b/clients/admin-ui/src/types/api/models/HTTPValidationError.ts index 842405324c8..f41f12fa0f4 100644 --- a/clients/admin-ui/src/types/api/models/HTTPValidationError.ts +++ b/clients/admin-ui/src/types/api/models/HTTPValidationError.ts @@ -1,9 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ValidationError } from "./ValidationError"; +/** + * HTTPValidationError + */ export type HTTPValidationError = { + /** + * Detail + */ detail?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/Header.ts b/clients/admin-ui/src/types/api/models/Header.ts index b8179b07089..21b4db34ec6 100644 --- a/clients/admin-ui/src/types/api/models/Header.ts +++ b/clients/admin-ui/src/types/api/models/Header.ts @@ -1,8 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * Header + */ export type Header = { + /** + * Name + */ name: string; + /** + * Value + */ value: string; }; diff --git a/clients/admin-ui/src/types/api/models/HealthCheck.ts b/clients/admin-ui/src/types/api/models/HealthCheck.ts index e89533e3732..791a339aca9 100644 --- a/clients/admin-ui/src/types/api/models/HealthCheck.ts +++ b/clients/admin-ui/src/types/api/models/HealthCheck.ts @@ -1,6 +1,4 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { DictionaryStatus } from "./DictionaryStatus"; import type { FidesCloudStatus } from "./FidesCloudStatus"; @@ -8,11 +6,22 @@ import type { SystemScannerStatus } from "./SystemScannerStatus"; import type { TCFStatus } from "./TCFStatus"; /** + * HealthCheck + * * Healthcheck schema */ export type HealthCheck = { + /** + * Core Fides Version + */ core_fides_version: string; + /** + * Fidesplus Version + */ fidesplus_version: string; + /** + * Fidesplus Server + */ fidesplus_server: string; system_scanner: SystemScannerStatus; dictionary: DictionaryStatus; diff --git a/clients/admin-ui/src/types/api/models/IDPActionType.ts b/clients/admin-ui/src/types/api/models/IDPActionType.ts new file mode 100644 index 00000000000..6cd151c98cc --- /dev/null +++ b/clients/admin-ui/src/types/api/models/IDPActionType.ts @@ -0,0 +1,12 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * IDPActionType + * + * Supported action types for IDP monitor bulk operations. + */ +export enum IDPActionType { + BULK_PROMOTE = "bulk-promote", + BULK_MUTE = "bulk-mute", + BULK_UNMUTE = "bulk-unmute", +} diff --git a/clients/admin-ui/src/types/api/models/IDPActionValidationErrorResponse.ts b/clients/admin-ui/src/types/api/models/IDPActionValidationErrorResponse.ts new file mode 100644 index 00000000000..66e6bef235f --- /dev/null +++ b/clients/admin-ui/src/types/api/models/IDPActionValidationErrorResponse.ts @@ -0,0 +1,36 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { DiffStatus } from "./DiffStatus"; +import { IDPActionType } from "./IDPActionType"; + +/** + * IDPActionValidationErrorResponse + * + * Response returned when an IDP bulk action is not valid for the selected resources. + */ +export type IDPActionValidationErrorResponse = { + /** + * The action that was attempted + */ + action: IDPActionType; + /** + * Allowed Statuses + * + * The diff_statuses that this action can operate on + */ + allowed_statuses: Array; + /** + * Disallowed Statuses With Counts + * + * Map of disallowed diff_status to count of resources with that status + */ + disallowed_statuses_with_counts: { + [key in DiffStatus]?: number; + }; + /** + * Message + * + * Human-readable explanation of why the action is not allowed + */ + message: string; +}; diff --git a/clients/admin-ui/src/types/api/models/IDPAllowedActionsResponse.ts b/clients/admin-ui/src/types/api/models/IDPAllowedActionsResponse.ts new file mode 100644 index 00000000000..d7b50c2e01e --- /dev/null +++ b/clients/admin-ui/src/types/api/models/IDPAllowedActionsResponse.ts @@ -0,0 +1,32 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { DiffStatus } from "./DiffStatus"; +import { IDPActionType } from "./IDPActionType"; + +/** + * IDPAllowedActionsResponse + * + * Response for the IDP allowed actions endpoint. + */ +export type IDPAllowedActionsResponse = { + /** + * Allowed Actions + * + * List of action types that are allowed for the filtered resources + */ + allowed_actions: Array; + /** + * Diff Statuses With Counts + * + * Map of diff_status to count of resources with that status + */ + diff_statuses_with_counts: { + [key in DiffStatus]?: number; + }; + /** + * Resource Count + * + * Total number of resources matching the current filters + */ + resource_count: number; +}; diff --git a/clients/admin-ui/src/types/api/models/IDPBulkActionResponse.ts b/clients/admin-ui/src/types/api/models/IDPBulkActionResponse.ts new file mode 100644 index 00000000000..87f8df9659a --- /dev/null +++ b/clients/admin-ui/src/types/api/models/IDPBulkActionResponse.ts @@ -0,0 +1,41 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { PromotedSystemInfo } from "./PromotedSystemInfo"; +import type { PromoteErrorInfo } from "./PromoteErrorInfo"; +import type { PromoteSummary } from "./PromoteSummary"; + +/** + * IDPBulkActionResponse + * + * Unified response for all IDP monitor bulk actions (promote, mute, unmute). + */ +export type IDPBulkActionResponse = { + /** + * Promoted + * + * List of successfully promoted systems (only for promote action) + */ + promoted?: Array | null; + /** + * Muted + * + * List of URNs successfully muted (only for mute action) + */ + muted?: Array | null; + /** + * Unmuted + * + * List of URNs successfully unmuted (only for unmute action) + */ + unmuted?: Array | null; + /** + * Errors + * + * List of errors encountered during the operation + */ + errors?: Array; + /** + * Summary of the bulk operation + */ + summary: PromoteSummary; +}; diff --git a/clients/admin-ui/src/types/api/models/IDPMonitorBulkSelection.ts b/clients/admin-ui/src/types/api/models/IDPMonitorBulkSelection.ts new file mode 100644 index 00000000000..4b6b5096603 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/IDPMonitorBulkSelection.ts @@ -0,0 +1,40 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { IDPMonitorResourcesFilter } from "./IDPMonitorResourcesFilter"; + +/** + * IDPMonitorBulkSelection + * + * Select IDP monitor resources for bulk actions using either explicit URNs or filters. + * + * If urns is provided, it will be used directly. + * If filters is provided (without urns), filters will be used to select resources, + * with optional exclusions via exclude_urns. + * + * For backwards compatibility, a plain list of URNs is also accepted and will be + * automatically converted to {"urns": [...]}. + */ +export type IDPMonitorBulkSelection = { + /** + * Urns + * + * List of resource URNs to act on. + */ + urns?: Array | null; + /** + * Filters to select resources (only used when urns is not provided) + */ + filters?: IDPMonitorResourcesFilter | null; + /** + * Exclude Urns + * + * List of resource URNs to exclude from the action (only used with filters) + */ + exclude_urns?: Array | null; + /** + * Organization Fides Key + * + * Organization fides_key to assign to all created Systems (only used for promote action). If not provided, will use default_organization or derive from connection config. + */ + organization_fides_key?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/IDPMonitorResourcesDynamicFilters.ts b/clients/admin-ui/src/types/api/models/IDPMonitorResourcesDynamicFilters.ts new file mode 100644 index 00000000000..2e10aa81a4d --- /dev/null +++ b/clients/admin-ui/src/types/api/models/IDPMonitorResourcesDynamicFilters.ts @@ -0,0 +1,21 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { DiffStatus } from "./DiffStatus"; + +/** + * IDPMonitorResourcesDynamicFilters + */ +export type IDPMonitorResourcesDynamicFilters = { + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Vendor Id + */ + vendor_id?: Array | null; + /** + * Data Uses + */ + data_uses?: Array | null; +}; diff --git a/clients/admin-ui/src/types/api/models/IDPMonitorResourcesFilter.ts b/clients/admin-ui/src/types/api/models/IDPMonitorResourcesFilter.ts new file mode 100644 index 00000000000..be5217882d4 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/IDPMonitorResourcesFilter.ts @@ -0,0 +1,33 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { DiffStatus } from "./DiffStatus"; + +/** + * IDPMonitorResourcesFilter + * + * Filter schema for IDP monitor resources that includes search and dynamic filters. + * + * Extends IDPMonitorResourcesDynamicFilters to include the search parameter. + * This ensures that changes to IDPMonitorResourcesDynamicFilters are automatically + * reflected in this schema, preventing drift. + */ +export type IDPMonitorResourcesFilter = { + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Vendor Id + */ + vendor_id?: Array | null; + /** + * Data Uses + */ + data_uses?: Array | null; + /** + * Search + * + * Search query to filter resources by name + */ + search?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/Identity.ts b/clients/admin-ui/src/types/api/models/Identity.ts deleted file mode 100644 index b9e23b6e179..00000000000 --- a/clients/admin-ui/src/types/api/models/Identity.ts +++ /dev/null @@ -1,15 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -/** - * Some PII grouping pertaining to a human - */ -export type Identity = { - phone_number?: string | null; - email?: string | null; - ga_client_id?: string | null; - ljt_readerID?: string | null; - fides_user_device_id?: string | null; - external_id?: string | null; -}; diff --git a/clients/admin-ui/src/types/api/models/IdentityBase.ts b/clients/admin-ui/src/types/api/models/IdentityBase.ts new file mode 100644 index 00000000000..c78708a818c --- /dev/null +++ b/clients/admin-ui/src/types/api/models/IdentityBase.ts @@ -0,0 +1,17 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * IdentityBase + * + * The minimum fields required to represent an identity. + */ +export type IdentityBase = { + /** + * Phone Number + */ + phone_number?: string | null; + /** + * Email + */ + email?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/IdentityDefinitionCreate.ts b/clients/admin-ui/src/types/api/models/IdentityDefinitionCreate.ts new file mode 100644 index 00000000000..c0b4816943d --- /dev/null +++ b/clients/admin-ui/src/types/api/models/IdentityDefinitionCreate.ts @@ -0,0 +1,24 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { IdentityDefinitionType } from "./IdentityDefinitionType"; + +/** + * IdentityDefinitionCreate + * + * Schema for creating an identity definition. + */ +export type IdentityDefinitionCreate = { + /** + * Identity Key + */ + identity_key: string; + /** + * Name + */ + name: string; + /** + * Description + */ + description?: string | null; + type: IdentityDefinitionType; +}; diff --git a/clients/admin-ui/src/types/api/models/IdentityDefinitionEntity.ts b/clients/admin-ui/src/types/api/models/IdentityDefinitionEntity.ts new file mode 100644 index 00000000000..f5ef06617ed --- /dev/null +++ b/clients/admin-ui/src/types/api/models/IdentityDefinitionEntity.ts @@ -0,0 +1,42 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { IdentityDefinitionType } from "./IdentityDefinitionType"; +import { IndexStatus } from "./IndexStatus"; + +/** + * IdentityDefinitionEntity + * + * Domain entity for identity definitions. + * + * Pydantic model, decoupled from SQLAlchemy ORM. + * Session-independent and can be freely passed around, serialized, and cached. + * Provides automatic validation and JSON serialization. + */ +export type IdentityDefinitionEntity = { + /** + * Identity Key + */ + identity_key: string; + /** + * Name + */ + name: string; + /** + * Description + */ + description?: string | null; + type: IdentityDefinitionType; + /** + * Created At + */ + created_at: string; + /** + * Updated At + */ + updated_at: string; + /** + * Created By + */ + created_by?: string | null; + index_status?: IndexStatus | null; +}; diff --git a/clients/admin-ui/src/types/api/models/IdentityDefinitionType.ts b/clients/admin-ui/src/types/api/models/IdentityDefinitionType.ts new file mode 100644 index 00000000000..f4504296012 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/IdentityDefinitionType.ts @@ -0,0 +1,14 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * IdentityDefinitionType + * + * Enum for the type of identity + */ +export enum IdentityDefinitionType { + EMAIL = "email", + PHONE_NUMBER = "phone_number", + UUID = "uuid", + STRING = "string", + INTEGER = "integer", +} diff --git a/clients/admin-ui/src/types/api/models/IdentityInputs.ts b/clients/admin-ui/src/types/api/models/IdentityInputs.ts index 71a8fcc1b29..c0b2ba17ded 100644 --- a/clients/admin-ui/src/types/api/models/IdentityInputs.ts +++ b/clients/admin-ui/src/types/api/models/IdentityInputs.ts @@ -1,12 +1,31 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { LocationIdentityField } from "./LocationIdentityField"; +// This file is auto-generated by @hey-api/openapi-ts +/** + * IdentityInputs + */ export type IdentityInputs = { + /** + * Name + */ name?: "optional" | "required" | null; + /** + * Email + */ email?: "optional" | "required" | null; + /** + * Phone + */ phone?: "optional" | "required" | null; - location?: "optional" | "required" | LocationIdentityField | null; + [key: string]: + | unknown + | "optional" + | "required" + | null + | "optional" + | "required" + | null + | "optional" + | "required" + | null + | undefined; }; diff --git a/clients/admin-ui/src/types/api/models/IdentityProvider.ts b/clients/admin-ui/src/types/api/models/IdentityProvider.ts new file mode 100644 index 00000000000..8882d962d2b --- /dev/null +++ b/clients/admin-ui/src/types/api/models/IdentityProvider.ts @@ -0,0 +1,10 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * IdentityProvider + * + * Supported identity provider types. + */ +export enum IdentityProvider { + OKTA = "okta", +} diff --git a/clients/admin-ui/src/types/api/models/IdentityProviderApplicationMetadata.ts b/clients/admin-ui/src/types/api/models/IdentityProviderApplicationMetadata.ts index d6017627575..9da7cdb6974 100644 --- a/clients/admin-ui/src/types/api/models/IdentityProviderApplicationMetadata.ts +++ b/clients/admin-ui/src/types/api/models/IdentityProviderApplicationMetadata.ts @@ -1,12 +1,12 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ApplicationStatus } from "./ApplicationStatus"; -import type { AuthenticationProtocol } from "./AuthenticationProtocol"; -import type { VendorMatchConfidence } from "./VendorMatchConfidence"; +import { ApplicationStatus } from "./ApplicationStatus"; +import { AuthenticationProtocol } from "./AuthenticationProtocol"; +import { VendorMatchConfidence } from "./VendorMatchConfidence"; /** + * IdentityProviderApplicationMetadata + * * Application metadata from Identity Providers. * * Stored in StagedResource.meta JSONB column. Matches frontend OktaAppMetadata @@ -22,10 +22,14 @@ export type IdentityProviderApplicationMetadata = { */ status?: ApplicationStatus | null; /** + * Created + * * ISO 8601 timestamp when application was created */ created?: string | null; /** + * Sign On Url + * * SSO login URL */ sign_on_url?: string | null; @@ -34,6 +38,8 @@ export type IdentityProviderApplicationMetadata = { */ vendor_match_confidence?: VendorMatchConfidence | null; /** + * Vendor Logo Url + * * URL to vendor logo image from Compass service */ vendor_logo_url?: string | null; diff --git a/clients/admin-ui/src/types/api/models/IdentityProviderMonitorConfig.ts b/clients/admin-ui/src/types/api/models/IdentityProviderMonitorConfig.ts new file mode 100644 index 00000000000..7b38a7fbac1 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/IdentityProviderMonitorConfig.ts @@ -0,0 +1,90 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { BigQueryMonitorParams } from "./BigQueryMonitorParams"; +import type { DynamoDBMonitorParams } from "./DynamoDBMonitorParams"; +import { IdentityProvider } from "./IdentityProvider"; +import type { MonitorClassifyParams } from "./MonitorClassifyParams"; +import { MonitorFrequency } from "./MonitorFrequency"; +import type { S3MonitorParams } from "./S3MonitorParams"; +import type { TestMonitorParams } from "./TestMonitorParams"; +import type { TestWebsiteMonitorParams } from "./TestWebsiteMonitorParams"; +import type { WebsiteMonitorParams } from "./WebsiteMonitorParams"; + +/** + * IdentityProviderMonitorConfig + * + * Configuration for Identity Provider discovery monitors. + */ +export type IdentityProviderMonitorConfig = { + /** + * Name + */ + name: string; + /** + * Key + */ + key?: string | null; + /** + * Connection Config Key + */ + connection_config_key: string; + /** + * Parameters for classification of discovered resources + */ + classify_params?: MonitorClassifyParams | null; + /** + * Datasource Params + * + * The datasource specific parameters, specified in a dictionary + */ + datasource_params?: + | { + [key: string]: unknown; + } + | DynamoDBMonitorParams + | S3MonitorParams + | WebsiteMonitorParams + | TestWebsiteMonitorParams + | TestMonitorParams + | BigQueryMonitorParams + | null; + /** + * Databases + * + * The databases that the monitor is scoped to actively monitor + */ + databases?: Array; + /** + * Execution Start Date + */ + execution_start_date?: string | null; + execution_frequency?: MonitorFrequency | null; + /** + * Excluded Databases + * + * The databases that the monitor should exclude from monitoring + */ + excluded_databases?: Array; + /** + * Enabled + * + * Whether the monitor is enabled for scheduled execution + */ + enabled?: boolean; + /** + * Shared Config Id + * + * Reference to a shared monitor configuration + */ + shared_config_id?: string | null; + /** + * Stewards + * + * List of user IDs to set as stewards for this monitor + */ + stewards?: Array; + /** + * Identity Provider type (currently only 'okta' is supported) + */ + provider?: IdentityProvider; +}; diff --git a/clients/admin-ui/src/types/api/models/IdentityTypes.ts b/clients/admin-ui/src/types/api/models/IdentityTypes.ts index 547368b82b7..fccf37e8e66 100644 --- a/clients/admin-ui/src/types/api/models/IdentityTypes.ts +++ b/clients/admin-ui/src/types/api/models/IdentityTypes.ts @@ -1,8 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * IdentityTypes + */ export type IdentityTypes = { + /** + * Email + */ email: boolean; + /** + * Phone Number + */ phone_number: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/IdentityValue.ts b/clients/admin-ui/src/types/api/models/IdentityValue.ts deleted file mode 100644 index 920c7df70a0..00000000000 --- a/clients/admin-ui/src/types/api/models/IdentityValue.ts +++ /dev/null @@ -1,8 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export type IdentityValue = { - label: string; - value?: string | null; -}; diff --git a/clients/admin-ui/src/types/api/models/IdentityVerificationConfigResponse.ts b/clients/admin-ui/src/types/api/models/IdentityVerificationConfigResponse.ts index 29e73d44359..48438cb0934 100644 --- a/clients/admin-ui/src/types/api/models/IdentityVerificationConfigResponse.ts +++ b/clients/admin-ui/src/types/api/models/IdentityVerificationConfigResponse.ts @@ -1,12 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * IdentityVerificationConfigResponse + * * Response for identity verification config info */ export type IdentityVerificationConfigResponse = { + /** + * Identity Verification Required + */ identity_verification_required: boolean; + /** + * Disable Consent Identity Verification + */ disable_consent_identity_verification: boolean; + /** + * Valid Email Config Exists + */ valid_email_config_exists: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/IncludeExcludeEnum.ts b/clients/admin-ui/src/types/api/models/IncludeExcludeEnum.ts index a04c90f2de1..bc2f1f2a5ce 100644 --- a/clients/admin-ui/src/types/api/models/IncludeExcludeEnum.ts +++ b/clients/admin-ui/src/types/api/models/IncludeExcludeEnum.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * IncludeExcludeEnum + * * Determine whether or not defined rights are * being included or excluded. */ diff --git a/clients/admin-ui/src/types/api/models/IndexStatus.ts b/clients/admin-ui/src/types/api/models/IndexStatus.ts new file mode 100644 index 00000000000..fcb4ba07908 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/IndexStatus.ts @@ -0,0 +1,16 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * IndexStatus + * + * Status of the database index for an identity definition. + * + * - ready: All partition indexes exist and are valid, ready to use + * - building: All partition indexes exist but PostgreSQL is actively building them (marked invalid) + * - error: No indexes exist OR partial indexes exist (creation failed or never completed) + */ +export enum IndexStatus { + READY = "ready", + BUILDING = "building", + ERROR = "error", +} diff --git a/clients/admin-ui/src/types/api/models/InfrastructureMonitorUpdates.ts b/clients/admin-ui/src/types/api/models/InfrastructureMonitorUpdates.ts index 1edbdc61685..fb1a4433cff 100644 --- a/clients/admin-ui/src/types/api/models/InfrastructureMonitorUpdates.ts +++ b/clients/admin-ui/src/types/api/models/InfrastructureMonitorUpdates.ts @@ -1,7 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * InfrastructureMonitorUpdates + */ export type InfrastructureMonitorUpdates = { - okta_app?: number; + /** + * Known + */ + known?: number; + /** + * Unknown + */ + unknown?: number; }; diff --git a/clients/admin-ui/src/types/api/models/IntegrationFeature.ts b/clients/admin-ui/src/types/api/models/IntegrationFeature.ts index d5be835d83d..41502acba84 100644 --- a/clients/admin-ui/src/types/api/models/IntegrationFeature.ts +++ b/clients/admin-ui/src/types/api/models/IntegrationFeature.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * IntegrationFeature + * * Features that can be enabled for different integration types. * These control which tabs and functionality are available in the integration detail view. */ diff --git a/clients/admin-ui/src/types/api/models/JiraIssueType.ts b/clients/admin-ui/src/types/api/models/JiraIssueType.ts new file mode 100644 index 00000000000..b2d704120ca --- /dev/null +++ b/clients/admin-ui/src/types/api/models/JiraIssueType.ts @@ -0,0 +1,36 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * JiraIssueType + * + * A Jira issue type available within a project. + * + * Returned by :meth:`JiraClient.list_issue_types` for issue type + * discovery during integration configuration. + */ +export type JiraIssueType = { + /** + * Id + * + * Jira issue type ID + */ + id: string; + /** + * Name + * + * Issue type name (e.g., 'Task', 'Story') + */ + name: string; + /** + * Description + * + * Issue type description + */ + description?: string | null; + /** + * Subtask + * + * Whether this is a subtask type + */ + subtask?: boolean; +}; diff --git a/clients/admin-ui/src/types/api/models/JiraOAuthInitiateRequest.ts b/clients/admin-ui/src/types/api/models/JiraOAuthInitiateRequest.ts new file mode 100644 index 00000000000..9ab7111eb1d --- /dev/null +++ b/clients/admin-ui/src/types/api/models/JiraOAuthInitiateRequest.ts @@ -0,0 +1,15 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * JiraOAuthInitiateRequest + * + * Request body for initiating Jira OAuth flow. + */ +export type JiraOAuthInitiateRequest = { + /** + * Connection Key + * + * Key of the ConnectionConfig for the Jira connection + */ + connection_key: string; +}; diff --git a/clients/admin-ui/src/types/api/models/JiraOAuthInitiateResponse.ts b/clients/admin-ui/src/types/api/models/JiraOAuthInitiateResponse.ts new file mode 100644 index 00000000000..4dd522bf2d0 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/JiraOAuthInitiateResponse.ts @@ -0,0 +1,13 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * JiraOAuthInitiateResponse + * + * Response containing the Atlassian authorization URL. + */ +export type JiraOAuthInitiateResponse = { + /** + * Authorization Url + */ + authorization_url: string; +}; diff --git a/clients/admin-ui/src/types/api/models/JiraPreviewRequest.ts b/clients/admin-ui/src/types/api/models/JiraPreviewRequest.ts new file mode 100644 index 00000000000..b748728a854 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/JiraPreviewRequest.ts @@ -0,0 +1,30 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * JiraPreviewRequest + * + * Request body for the Jira ticket preview endpoint. + * + * All fields are optional — the endpoint falls back to saved + * configuration from the connection's secrets. + */ +export type JiraPreviewRequest = { + /** + * Summary Template + * + * Override summary template; falls back to saved + */ + summary_template?: string | null; + /** + * Description Template + * + * Override description template; falls back to saved + */ + description_template?: string | null; + /** + * Privacy Request Id + * + * Load real privacy request data; falls back to sample values + */ + privacy_request_id?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/JiraProject.ts b/clients/admin-ui/src/types/api/models/JiraProject.ts new file mode 100644 index 00000000000..49f0513fd13 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/JiraProject.ts @@ -0,0 +1,30 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * JiraProject + * + * A Jira project available for ticket creation. + * + * Returned by :meth:`JiraClient.list_projects` for project discovery + * during integration configuration. + */ +export type JiraProject = { + /** + * Id + * + * Jira project ID + */ + id: string; + /** + * Key + * + * Jira project key (e.g., 'PRIV') + */ + key: string; + /** + * Name + * + * Jira project display name + */ + name: string; +}; diff --git a/clients/admin-ui/src/types/api/models/JiraStatusCategory.ts b/clients/admin-ui/src/types/api/models/JiraStatusCategory.ts new file mode 100644 index 00000000000..333892cfc13 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/JiraStatusCategory.ts @@ -0,0 +1,37 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * JiraStatusCategory + * + * A Jira status category for mapping closed statuses. + * + * Returned by :meth:`JiraClient.list_statuses` so administrators can + * configure which Jira statuses are considered "closed" for the purpose + * of completing the DSR workflow. + */ +export type JiraStatusCategory = { + /** + * Id + * + * Status category ID + */ + id: string; + /** + * Key + * + * Status category key (e.g., 'new', 'indeterminate', 'done') + */ + key: string; + /** + * Name + * + * Status category display name + */ + name: string; + /** + * Color Name + * + * Status category color + */ + color_name?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/JiraTicketData.ts b/clients/admin-ui/src/types/api/models/JiraTicketData.ts new file mode 100644 index 00000000000..58a0423d9c6 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/JiraTicketData.ts @@ -0,0 +1,42 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * JiraTicketData + * + * Data required to create a Jira ticket. + * + * Used by :meth:`~fidesplus.jira.jira_client.JiraClient.create_issue` and + * :meth:`~fidesplus.jira.jira_ticket_service.JiraTicketService.create_ticket_for_privacy_request`. + */ +export type JiraTicketData = { + /** + * Project Key + * + * Jira project key (e.g., 'PRIV') + */ + project_key: string; + /** + * Issue Type + * + * Jira issue type name (e.g., 'Task') + */ + issue_type: string; + /** + * Summary + * + * Rendered ticket title + */ + summary: string; + /** + * Description + * + * Rendered ticket description + */ + description: string; + /** + * Due Date + * + * Ticket due date + */ + due_date?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/JiraTicketDocsSchema.ts b/clients/admin-ui/src/types/api/models/JiraTicketDocsSchema.ts new file mode 100644 index 00000000000..ecbdebec517 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/JiraTicketDocsSchema.ts @@ -0,0 +1,29 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * JiraTicketDocsSchema + * + * Jira Ticket Secrets Schema for API Docs + */ +export type JiraTicketDocsSchema = { + /** + * Access Token + */ + access_token?: string | null; + /** + * Refresh Token + */ + refresh_token?: string | null; + /** + * Token Expiry + */ + token_expiry?: string | null; + /** + * Cloud Id + */ + cloud_id?: string | null; + /** + * Site Url + */ + site_url?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/LLMChatRequest.ts b/clients/admin-ui/src/types/api/models/LLMChatRequest.ts new file mode 100644 index 00000000000..3311ace9c86 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/LLMChatRequest.ts @@ -0,0 +1,15 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * LLMChatRequest + */ +export type LLMChatRequest = { + /** + * Prompt + */ + prompt: string; + /** + * Model + */ + model?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/LLMClassifyRequest.ts b/clients/admin-ui/src/types/api/models/LLMClassifyRequest.ts new file mode 100644 index 00000000000..28b6dc3fef2 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/LLMClassifyRequest.ts @@ -0,0 +1,15 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { ClassifyInput } from "./ClassifyInput"; +import type { ClassifyLlmParams } from "./ClassifyLlmParams"; + +/** + * LLMClassifyRequest + */ +export type LLMClassifyRequest = { + /** + * Data + */ + data: Array; + params?: ClassifyLlmParams; +}; diff --git a/clients/admin-ui/src/types/api/models/Language.ts b/clients/admin-ui/src/types/api/models/Language.ts index 4122bb06442..7787af1ae16 100644 --- a/clients/admin-ui/src/types/api/models/Language.ts +++ b/clients/admin-ui/src/types/api/models/Language.ts @@ -1,8 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * Language + */ export type Language = { + /** + * Id + */ id: string; + /** + * Name + */ name: string; }; diff --git a/clients/admin-ui/src/types/api/models/Layer1ButtonOption.ts b/clients/admin-ui/src/types/api/models/Layer1ButtonOption.ts index a188c1682b1..daed43713c4 100644 --- a/clients/admin-ui/src/types/api/models/Layer1ButtonOption.ts +++ b/clients/admin-ui/src/types/api/models/Layer1ButtonOption.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * Layer1ButtonOption + * * Layer 1 button options - not formalized in the db */ export enum Layer1ButtonOption { diff --git a/clients/admin-ui/src/types/api/models/LegalBasisForProcessingEnum.ts b/clients/admin-ui/src/types/api/models/LegalBasisForProcessingEnum.ts index 6cd70b6558b..99888a55a1a 100644 --- a/clients/admin-ui/src/types/api/models/LegalBasisForProcessingEnum.ts +++ b/clients/admin-ui/src/types/api/models/LegalBasisForProcessingEnum.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * LegalBasisForProcessingEnum + * * The model for allowable legal basis categories on privacy declarations. * * Based upon article 6 of the GDPR diff --git a/clients/admin-ui/src/types/api/models/LegalBasisForProfilingEnum.ts b/clients/admin-ui/src/types/api/models/LegalBasisForProfilingEnum.ts index 6b32dfd7f98..2a596c2decf 100644 --- a/clients/admin-ui/src/types/api/models/LegalBasisForProfilingEnum.ts +++ b/clients/admin-ui/src/types/api/models/LegalBasisForProfilingEnum.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * LegalBasisForProfilingEnum + * * The model for describing the legal basis under which profiling is performed */ export enum LegalBasisForProfilingEnum { diff --git a/clients/admin-ui/src/types/api/models/LimitedPrivacyNoticeResponseSchema.ts b/clients/admin-ui/src/types/api/models/LimitedPrivacyNoticeResponseSchema.ts index 87700f2c468..ce0da7c4e50 100644 --- a/clients/admin-ui/src/types/api/models/LimitedPrivacyNoticeResponseSchema.ts +++ b/clients/admin-ui/src/types/api/models/LimitedPrivacyNoticeResponseSchema.ts @@ -1,27 +1,50 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConsentMechanism } from "./ConsentMechanism"; -import type { PrivacyNoticeFramework } from "./PrivacyNoticeFramework"; -import type { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; +import { ConsentMechanism } from "./ConsentMechanism"; +import { PrivacyNoticeFramework } from "./PrivacyNoticeFramework"; +import { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; /** + * LimitedPrivacyNoticeResponseSchema + * * Limited Privacy Notice Schema for list View in Admin UI * For performance, only returns a subset of available fields for this view. */ export type LimitedPrivacyNoticeResponseSchema = { + /** + * Id + */ id: string; + /** + * Name + */ name: string; + /** + * Notice Key + */ notice_key: string; + /** + * Data Uses + */ data_uses: Array; consent_mechanism: ConsentMechanism; /** + * Configured Regions + * * A property calculated by observing which Experiences have linked this Notice */ configured_regions?: Array; + /** + * Systems Applicable + */ systems_applicable?: boolean; + /** + * Disabled + */ disabled: boolean; framework?: PrivacyNoticeFramework | null; + /** + * Children + */ children?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/LinkedDatasetInfo.ts b/clients/admin-ui/src/types/api/models/LinkedDatasetInfo.ts new file mode 100644 index 00000000000..6ab8b8dbf5a --- /dev/null +++ b/clients/admin-ui/src/types/api/models/LinkedDatasetInfo.ts @@ -0,0 +1,21 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * LinkedDatasetInfo + * + * Info about a fides Dataset linked to a monitor's staged resources + */ +export type LinkedDatasetInfo = { + /** + * Fides Key + * + * The fides_key of the linked dataset + */ + fides_key: string; + /** + * Name + * + * The name of the linked dataset + */ + name?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/LinkedSystemInfo.ts b/clients/admin-ui/src/types/api/models/LinkedSystemInfo.ts index cae6a64b108..97a15e65055 100644 --- a/clients/admin-ui/src/types/api/models/LinkedSystemInfo.ts +++ b/clients/admin-ui/src/types/api/models/LinkedSystemInfo.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * LinkedSystemInfo + * * Minimal system info embedded in connection config list responses. */ export type LinkedSystemInfo = { + /** + * Fides Key + */ fides_key: string; + /** + * Name + */ name?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/LlmClassificationSample.ts b/clients/admin-ui/src/types/api/models/LlmClassificationSample.ts new file mode 100644 index 00000000000..8aa1e76fba1 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/LlmClassificationSample.ts @@ -0,0 +1,75 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * LlmClassificationSample + * + * Sample of an LLM classification for review. + */ +export type LlmClassificationSample = { + /** + * Urn + * + * Resource URN + */ + urn: string; + /** + * Domain + * + * Resource domain + */ + domain: string; + /** + * Name + * + * Resource name + */ + name?: string | null; + /** + * Resource Type + * + * Type (cookie, script, request) + */ + resource_type: string; + /** + * Vendor Name + * + * LLM-identified vendor + */ + vendor_name?: string | null; + /** + * Category + * + * LLM-assigned category + */ + category?: string | null; + /** + * Confidence + * + * Confidence score 1-5 + */ + confidence?: number | null; + /** + * Rationale + * + * LLM rationale + */ + rationale?: string | null; + /** + * Compass Matched + * + * Whether matched to Compass + */ + compass_matched: boolean; + /** + * Flagged + * + * Whether flagged for review + */ + flagged: boolean; + /** + * Flag Reason + * + * Reason for flagging + */ + flag_reason?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/LoadingContext.ts b/clients/admin-ui/src/types/api/models/LoadingContext.ts index 4f708e271b2..9b227fdfabe 100644 --- a/clients/admin-ui/src/types/api/models/LoadingContext.ts +++ b/clients/admin-ui/src/types/api/models/LoadingContext.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * LoadingContext + * * Enum for the loading context of an asset */ export enum LoadingContext { diff --git a/clients/admin-ui/src/types/api/models/Location.ts b/clients/admin-ui/src/types/api/models/Location.ts index fc185f15274..a73431eca7b 100644 --- a/clients/admin-ui/src/types/api/models/Location.ts +++ b/clients/admin-ui/src/types/api/models/Location.ts @@ -1,19 +1,40 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { Continent } from "./Continent"; +import { Continent } from "./Continent"; /** + * Location + * * Location schema */ export type Location = { + /** + * Id + */ id: string; + /** + * Selected + */ selected?: boolean; + /** + * Name + */ name: string; continent?: Continent | null; + /** + * Default Selected + */ default_selected?: boolean; + /** + * Belongs To + */ belongs_to?: Array; + /** + * Regulation + */ regulation?: Array; + /** + * Is Country + */ is_country?: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/LocationCustomPrivacyRequestField.ts b/clients/admin-ui/src/types/api/models/LocationCustomPrivacyRequestField.ts index 68de4279a30..54d902ca4c4 100644 --- a/clients/admin-ui/src/types/api/models/LocationCustomPrivacyRequestField.ts +++ b/clients/admin-ui/src/types/api/models/LocationCustomPrivacyRequestField.ts @@ -1,22 +1,37 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * LocationCustomPrivacyRequestField + * * Location field that doesn't support options and includes IP geolocation hint */ export type LocationCustomPrivacyRequestField = { + /** + * Label + */ label: string; + /** + * Required + */ required?: boolean | null; + /** + * Default Value + */ default_value?: string | null; + /** + * Hidden + */ hidden?: boolean | null; + /** + * Query Param Key + */ query_param_key?: string | null; - field_type?: LocationCustomPrivacyRequestField.field_type; + /** + * Field Type + */ + field_type?: "location"; + /** + * Ip Geolocation Hint + */ ip_geolocation_hint?: boolean | null; }; - -export namespace LocationCustomPrivacyRequestField { - export enum field_type { - LOCATION = "location", - } -} diff --git a/clients/admin-ui/src/types/api/models/LocationGroup.ts b/clients/admin-ui/src/types/api/models/LocationGroup.ts index df361d0e3d7..084cab5e937 100644 --- a/clients/admin-ui/src/types/api/models/LocationGroup.ts +++ b/clients/admin-ui/src/types/api/models/LocationGroup.ts @@ -1,19 +1,40 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { Continent } from "./Continent"; +import { Continent } from "./Continent"; /** + * LocationGroup + * * Location Group schema, currently the same as a location */ export type LocationGroup = { + /** + * Id + */ id: string; + /** + * Selected + */ selected?: boolean; + /** + * Name + */ name: string; continent?: Continent | null; + /** + * Default Selected + */ default_selected?: boolean; + /** + * Belongs To + */ belongs_to?: Array; + /** + * Regulation + */ regulation?: Array; + /** + * Is Country + */ is_country?: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/LocationIdentityField.ts b/clients/admin-ui/src/types/api/models/LocationIdentityField.ts deleted file mode 100644 index ba79eeec85d..00000000000 --- a/clients/admin-ui/src/types/api/models/LocationIdentityField.ts +++ /dev/null @@ -1,14 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -/** - * Location field configuration that extends the useful parts of CustomPrivacyRequestField - */ -export type LocationIdentityField = { - label: string; - required?: boolean | null; - default_value?: string | null; - query_param_key?: string | null; - ip_geolocation_hint?: boolean | null; -}; diff --git a/clients/admin-ui/src/types/api/models/LocationRegulationBase.ts b/clients/admin-ui/src/types/api/models/LocationRegulationBase.ts index 14b35c69cac..8699ba1ea02 100644 --- a/clients/admin-ui/src/types/api/models/LocationRegulationBase.ts +++ b/clients/admin-ui/src/types/api/models/LocationRegulationBase.ts @@ -1,16 +1,28 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { Continent } from "./Continent"; +import { Continent } from "./Continent"; /** + * LocationRegulationBase + * * Base Location Regulation Schema */ export type LocationRegulationBase = { + /** + * Id + */ id: string; + /** + * Selected + */ selected?: boolean; + /** + * Name + */ name: string; continent?: Continent | null; + /** + * Default Selected + */ default_selected?: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/LocationRegulationResponse.ts b/clients/admin-ui/src/types/api/models/LocationRegulationResponse.ts index c7543ada1fa..610ad529732 100644 --- a/clients/admin-ui/src/types/api/models/LocationRegulationResponse.ts +++ b/clients/admin-ui/src/types/api/models/LocationRegulationResponse.ts @@ -1,13 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { Location } from "./Location"; import type { LocationGroup } from "./LocationGroup"; import type { LocationRegulationBase } from "./LocationRegulationBase"; +/** + * LocationRegulationResponse + */ export type LocationRegulationResponse = { + /** + * Locations + */ locations?: Array; + /** + * Location Groups + */ location_groups?: Array; + /** + * Regulations + */ regulations?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/LocationRegulationSelections.ts b/clients/admin-ui/src/types/api/models/LocationRegulationSelections.ts index c1063973de8..985a845e3eb 100644 --- a/clients/admin-ui/src/types/api/models/LocationRegulationSelections.ts +++ b/clients/admin-ui/src/types/api/models/LocationRegulationSelections.ts @@ -1,10 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { Selection } from "./Selection"; +/** + * LocationRegulationSelections + */ export type LocationRegulationSelections = { + /** + * Locations + */ locations?: Array; + /** + * Regulations + */ regulations?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/LogEntry.ts b/clients/admin-ui/src/types/api/models/LogEntry.ts index 11373d25787..4df5f339343 100644 --- a/clients/admin-ui/src/types/api/models/LogEntry.ts +++ b/clients/admin-ui/src/types/api/models/LogEntry.ts @@ -1,13 +1,25 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * LogEntry + * * Schema representing a single log entry */ export type LogEntry = { + /** + * Timestamp + */ timestamp: string; + /** + * Level + */ level: string; + /** + * Module Info + */ module_info: string; + /** + * Message + */ message: string; }; diff --git a/clients/admin-ui/src/types/api/models/MSSQLDocsSchema.ts b/clients/admin-ui/src/types/api/models/MSSQLDocsSchema.ts index f2e06a1b0a3..abcb469bce1 100644 --- a/clients/admin-ui/src/types/api/models/MSSQLDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/MSSQLDocsSchema.ts @@ -1,33 +1,45 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MSSQLDocsSchema + * * MS SQL Secrets Schema for API Docs */ export type MSSQLDocsSchema = { /** + * Host + * * The hostname or IP address of the server where the database is running. */ host: string; /** + * Port + * * The network port number on which the server is listening for incoming connections (default: 1433). */ port?: number; /** + * Username + * * The user account used to authenticate and access the database. */ username: string; /** + * Password + * * The password used to authenticate and access the database. */ password: string; /** + * Database + * * The name of the specific database within the database server that you want to connect to. */ dbname?: string | null; /** - * Additional connection details for the database. + * Read Only Connection + * + * Whether to connect to the database in read-only mode. */ - read_only_connection?: boolean; + read_only_connection?: boolean | null; }; diff --git a/clients/admin-ui/src/types/api/models/MailgunConfig.ts b/clients/admin-ui/src/types/api/models/MailgunConfig.ts new file mode 100644 index 00000000000..5e400173e8e --- /dev/null +++ b/clients/admin-ui/src/types/api/models/MailgunConfig.ts @@ -0,0 +1,24 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * MailgunConfig + * + * Mailgun configuration for messaging. + * + * Simplified seed input for configuring Mailgun messaging. + * See also: MessagingConfigRequest, MessagingServiceDetailsMailgun. + */ +export type MailgunConfig = { + /** + * Domain + * + * Mailgun domain + */ + domain: string; + /** + * Api Key + * + * Mailgun API key + */ + api_key: string; +}; diff --git a/clients/admin-ui/src/types/api/models/ManualAction.ts b/clients/admin-ui/src/types/api/models/ManualAction.ts index 3389294607b..be89989673d 100644 --- a/clients/admin-ui/src/types/api/models/ManualAction.ts +++ b/clients/admin-ui/src/types/api/models/ManualAction.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ManualAction + * * Surface how to retrieve or mask data in a database-agnostic way * * - 'locators' are similar to the SQL "WHERE" information. @@ -10,7 +10,20 @@ * - 'update' is a dictionary of fields and the replacement value/masking strategy */ export type ManualAction = { - locators: any; + /** + * Locators + */ + locators: { + [key: string]: unknown; + }; + /** + * Get + */ get: Array | null; - update: null; + /** + * Update + */ + update: { + [key: string]: unknown; + } | null; }; diff --git a/clients/admin-ui/src/types/api/models/ManualFieldCreate.ts b/clients/admin-ui/src/types/api/models/ManualFieldCreate.ts index d016f3edd74..b58aa4bea6d 100644 --- a/clients/admin-ui/src/types/api/models/ManualFieldCreate.ts +++ b/clients/admin-ui/src/types/api/models/ManualFieldCreate.ts @@ -1,23 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ManualFieldRequestType } from "./ManualFieldRequestType"; -import type { ManualTaskFieldType } from "./ManualTaskFieldType"; +import { ManualFieldRequestType } from "./ManualFieldRequestType"; +import { ManualTaskFieldType } from "./ManualTaskFieldType"; /** + * ManualFieldCreate + * * Simplified schema for creating a manual field. */ export type ManualFieldCreate = { /** + * Key + * * Unique key for the field */ key?: string | null; /** + * Label + * * Display label for the field */ label: string; /** + * Help Text + * * Help text/description for the field */ help_text: string; diff --git a/clients/admin-ui/src/types/api/models/ManualFieldListItem.ts b/clients/admin-ui/src/types/api/models/ManualFieldListItem.ts index a40c9da572b..3a37b92c033 100644 --- a/clients/admin-ui/src/types/api/models/ManualFieldListItem.ts +++ b/clients/admin-ui/src/types/api/models/ManualFieldListItem.ts @@ -1,34 +1,59 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { CommentResponse } from "./CommentResponse"; import type { ManualFieldPrivacyRequest } from "./ManualFieldPrivacyRequest"; -import type { ManualFieldRequestType } from "./ManualFieldRequestType"; -import type { ManualFieldStatus } from "./ManualFieldStatus"; +import { ManualFieldRequestType } from "./ManualFieldRequestType"; +import { ManualFieldStatus } from "./ManualFieldStatus"; import type { ManualFieldSystem } from "./ManualFieldSystem"; import type { ManualFieldUser } from "./ManualFieldUser"; -import type { ManualTaskFieldType } from "./ManualTaskFieldType"; +import { ManualTaskFieldType } from "./ManualTaskFieldType"; /** + * ManualFieldListItem + * * Single row returned by the search endpoint. */ export type ManualFieldListItem = { /** + * Manual Field Id + * * Unique identifier for the manual field instance */ manual_field_id: string; + /** + * Name + */ name: string; + /** + * Description + */ description?: string | null; input_type: ManualTaskFieldType; request_type: ManualFieldRequestType; status: ManualFieldStatus; + /** + * Assigned Users + */ assigned_users?: Array; privacy_request: ManualFieldPrivacyRequest; system?: ManualFieldSystem | null; submission_user?: ManualFieldUser | null; + /** + * Comments + */ comments?: Array; - attachments?: Array>; + /** + * Attachments + */ + attachments?: Array<{ + [key: string]: string; + }>; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at: string; }; diff --git a/clients/admin-ui/src/types/api/models/ManualFieldPrivacyRequest.ts b/clients/admin-ui/src/types/api/models/ManualFieldPrivacyRequest.ts index 5190a778f6a..9140ce65330 100644 --- a/clients/admin-ui/src/types/api/models/ManualFieldPrivacyRequest.ts +++ b/clients/admin-ui/src/types/api/models/ManualFieldPrivacyRequest.ts @@ -1,19 +1,42 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ManualFieldRequestType } from "./ManualFieldRequestType"; +import { ManualFieldRequestType } from "./ManualFieldRequestType"; /** + * ManualFieldPrivacyRequest + * * Privacy request snapshot with identity fields. */ export type ManualFieldPrivacyRequest = { + /** + * Id + */ id: string; /** + * Days Left + * * Days remaining until due date */ days_left?: number | null; request_type: ManualFieldRequestType; - subject_identities: any; - custom_fields: any; + /** + * Subject Identities + */ + subject_identities: { + [key: string]: unknown; + }; + /** + * Custom Fields + */ + custom_fields: { + [key: string]: unknown; + }; + /** + * Custom Field Labels + * + * Mapping of custom field keys to their display labels + */ + custom_field_labels?: { + [key: string]: string; + }; }; diff --git a/clients/admin-ui/src/types/api/models/ManualFieldRequestType.ts b/clients/admin-ui/src/types/api/models/ManualFieldRequestType.ts index e0aa868e84b..e149b1fd37e 100644 --- a/clients/admin-ui/src/types/api/models/ManualFieldRequestType.ts +++ b/clients/admin-ui/src/types/api/models/ManualFieldRequestType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ManualFieldRequestType + * * Request types supported by manual fields (subset of ActionType) */ export enum ManualFieldRequestType { diff --git a/clients/admin-ui/src/types/api/models/ManualFieldResponse.ts b/clients/admin-ui/src/types/api/models/ManualFieldResponse.ts index f7769b8dfb6..2f6217041bd 100644 --- a/clients/admin-ui/src/types/api/models/ManualFieldResponse.ts +++ b/clients/admin-ui/src/types/api/models/ManualFieldResponse.ts @@ -1,27 +1,35 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ManualFieldRequestType } from "./ManualFieldRequestType"; -import type { ManualTaskFieldType } from "./ManualTaskFieldType"; +import { ManualFieldRequestType } from "./ManualFieldRequestType"; +import { ManualTaskFieldType } from "./ManualTaskFieldType"; /** + * ManualFieldResponse + * * Simplified schema for manual field response. */ export type ManualFieldResponse = { /** + * Id + * * Field ID */ id: string; /** + * Key + * * Unique key for the field */ key: string; /** + * Label + * * Display label for the field */ label: string; /** + * Help Text + * * Help text/description for the field */ help_text: string; diff --git a/clients/admin-ui/src/types/api/models/ManualFieldSearchFilterOptions.ts b/clients/admin-ui/src/types/api/models/ManualFieldSearchFilterOptions.ts index 37c3f74ff75..f6ead0031c0 100644 --- a/clients/admin-ui/src/types/api/models/ManualFieldSearchFilterOptions.ts +++ b/clients/admin-ui/src/types/api/models/ManualFieldSearchFilterOptions.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ManualFieldSystem } from "./ManualFieldSystem"; import type { ManualFieldUser } from "./ManualFieldUser"; /** + * ManualFieldSearchFilterOptions + * * Optional filter dropdown values returned alongside the result set. */ export type ManualFieldSearchFilterOptions = { + /** + * Assigned Users + */ assigned_users?: Array; + /** + * Systems + */ systems?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ManualFieldSearchResponse.ts b/clients/admin-ui/src/types/api/models/ManualFieldSearchResponse.ts index f931fb9a6dc..84ba69b73f4 100644 --- a/clients/admin-ui/src/types/api/models/ManualFieldSearchResponse.ts +++ b/clients/admin-ui/src/types/api/models/ManualFieldSearchResponse.ts @@ -1,18 +1,33 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ManualFieldListItem } from "./ManualFieldListItem"; import type { ManualFieldSearchFilterOptions } from "./ManualFieldSearchFilterOptions"; /** + * ManualFieldSearchResponse + * * Full paginated response returned by the endpoint. */ export type ManualFieldSearchResponse = { + /** + * Items + */ items: Array; + /** + * Total + */ total: number; + /** + * Page + */ page: number; + /** + * Size + */ size: number; + /** + * Pages + */ pages: number; filter_options: ManualFieldSearchFilterOptions; }; diff --git a/clients/admin-ui/src/types/api/models/ManualFieldStatus.ts b/clients/admin-ui/src/types/api/models/ManualFieldStatus.ts index 9e209003ccb..3383b19999d 100644 --- a/clients/admin-ui/src/types/api/models/ManualFieldStatus.ts +++ b/clients/admin-ui/src/types/api/models/ManualFieldStatus.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ManualFieldStatus + * * Status of a manual field relative to a particular task instance. */ export enum ManualFieldStatus { diff --git a/clients/admin-ui/src/types/api/models/ManualFieldSystem.ts b/clients/admin-ui/src/types/api/models/ManualFieldSystem.ts index b51d0431f26..c65dc8b4ea9 100644 --- a/clients/admin-ui/src/types/api/models/ManualFieldSystem.ts +++ b/clients/admin-ui/src/types/api/models/ManualFieldSystem.ts @@ -1,8 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ManualFieldSystem + */ export type ManualFieldSystem = { + /** + * Id + */ id: string; + /** + * Name + */ name: string; }; diff --git a/clients/admin-ui/src/types/api/models/ManualFieldUpdate.ts b/clients/admin-ui/src/types/api/models/ManualFieldUpdate.ts index 8bf0bd8e99f..00131e32825 100644 --- a/clients/admin-ui/src/types/api/models/ManualFieldUpdate.ts +++ b/clients/admin-ui/src/types/api/models/ManualFieldUpdate.ts @@ -1,19 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ManualFieldRequestType } from "./ManualFieldRequestType"; -import type { ManualTaskFieldType } from "./ManualTaskFieldType"; +import { ManualFieldRequestType } from "./ManualFieldRequestType"; +import { ManualTaskFieldType } from "./ManualTaskFieldType"; /** + * ManualFieldUpdate + * * Simplified schema for updating a manual field. */ export type ManualFieldUpdate = { /** + * Label + * * Display label for the field */ label: string; /** + * Help Text + * * Help text/description for the field */ help_text: string; diff --git a/clients/admin-ui/src/types/api/models/ManualFieldUser.ts b/clients/admin-ui/src/types/api/models/ManualFieldUser.ts index a7bc7d60ce1..e98c8b0557c 100644 --- a/clients/admin-ui/src/types/api/models/ManualFieldUser.ts +++ b/clients/admin-ui/src/types/api/models/ManualFieldUser.ts @@ -1,10 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ManualFieldUser + */ export type ManualFieldUser = { + /** + * Id + */ id: string; + /** + * Email Address + */ email_address?: string | null; + /** + * First Name + */ first_name?: string | null; + /** + * Last Name + */ last_name?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/ManualTaskConfigCreate.ts b/clients/admin-ui/src/types/api/models/ManualTaskConfigCreate.ts index b57d2ba2f49..9e682f853b5 100644 --- a/clients/admin-ui/src/types/api/models/ManualTaskConfigCreate.ts +++ b/clients/admin-ui/src/types/api/models/ManualTaskConfigCreate.ts @@ -1,14 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ManualTaskConfigurationType } from "./ManualTaskConfigurationType"; +import { ActionType } from "./ActionType"; import type { ManualTaskFieldBase } from "./ManualTaskFieldBase"; /** + * ManualTaskConfigCreate + * * Request model for creating manual task configuration. */ export type ManualTaskConfigCreate = { - config_type: ManualTaskConfigurationType; + config_type: ActionType; + /** + * Fields + */ fields: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ManualTaskConfigResponse.ts b/clients/admin-ui/src/types/api/models/ManualTaskConfigResponse.ts index fcfcd9a0385..1a72c3d591f 100644 --- a/clients/admin-ui/src/types/api/models/ManualTaskConfigResponse.ts +++ b/clients/admin-ui/src/types/api/models/ManualTaskConfigResponse.ts @@ -1,43 +1,57 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ManualTaskConfigurationType } from "./ManualTaskConfigurationType"; +import { ActionType } from "./ActionType"; import type { ManualTaskFieldBase } from "./ManualTaskFieldBase"; /** + * ManualTaskConfigResponse + * * Schema for manual task configuration response. */ export type ManualTaskConfigResponse = { /** + * Id + * * Configuration ID */ id: string; /** + * Manual Task Id + * * Manual task ID */ manual_task_id: string; /** * Type of configuration */ - config_type: ManualTaskConfigurationType; + config_type: ActionType; /** + * Version + * * Version of the configuration */ version: number; /** + * Is Current + * * Whether this is the current version */ is_current: boolean; /** + * Fields + * * List of field definitions */ fields: Array; /** + * Created At + * * Creation timestamp */ created_at: string; /** + * Updated At + * * Last update timestamp */ updated_at: string; diff --git a/clients/admin-ui/src/types/api/models/ManualTaskConfigUpdate.ts b/clients/admin-ui/src/types/api/models/ManualTaskConfigUpdate.ts index a57a3f46309..c530a5a970f 100644 --- a/clients/admin-ui/src/types/api/models/ManualTaskConfigUpdate.ts +++ b/clients/admin-ui/src/types/api/models/ManualTaskConfigUpdate.ts @@ -1,14 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ManualTaskConfigurationType } from "./ManualTaskConfigurationType"; +import { ActionType } from "./ActionType"; import type { ManualTaskFieldBase } from "./ManualTaskFieldBase"; /** + * ManualTaskConfigUpdate + * * Request model for updating manual task configuration. */ export type ManualTaskConfigUpdate = { - config_type: ManualTaskConfigurationType; + config_type: ActionType; + /** + * Fields + */ fields: Array; }; diff --git a/clients/admin-ui/src/types/api/models/ManualTaskConfigurationType.ts b/clients/admin-ui/src/types/api/models/ManualTaskConfigurationType.ts deleted file mode 100644 index 102faa9eea8..00000000000 --- a/clients/admin-ui/src/types/api/models/ManualTaskConfigurationType.ts +++ /dev/null @@ -1,11 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -/** - * Enum for manual task configuration types. - */ -export enum ManualTaskConfigurationType { - ACCESS_PRIVACY_REQUEST = "access_privacy_request", - ERASURE_PRIVACY_REQUEST = "erasure_privacy_request", -} diff --git a/clients/admin-ui/src/types/api/models/ManualTaskExportRequest.ts b/clients/admin-ui/src/types/api/models/ManualTaskExportRequest.ts new file mode 100644 index 00000000000..c21bb181e7a --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ManualTaskExportRequest.ts @@ -0,0 +1,28 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { ExportFormat } from "./ExportFormat"; + +/** + * ManualTaskExportRequest + * + * Request schema for manual task export with field validation. + * + * Filter parameters (status, request_type, system_name, assigned_user_id, privacy_request_id) + * are passed as QUERY PARAMETERS to match the search endpoint - users export what they see. + * + * Example: + * POST /api/v1/manual-fields/export?status=new&request_type=access + * Body: {"format": "csv", "fields": ["name", "status", "created_at"]} + */ +export type ManualTaskExportRequest = { + /** + * Export format + */ + format?: ExportFormat; + /** + * Fields + * + * List of field keys to include. Must be explicitly specified to ensure intentional data export, especially when PII is involved. + */ + fields: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/ManualTaskFieldBase.ts b/clients/admin-ui/src/types/api/models/ManualTaskFieldBase.ts index 520a7297a8e..705c8f41a96 100644 --- a/clients/admin-ui/src/types/api/models/ManualTaskFieldBase.ts +++ b/clients/admin-ui/src/types/api/models/ManualTaskFieldBase.ts @@ -1,15 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ManualTaskFieldMetadata } from "./ManualTaskFieldMetadata"; -import type { ManualTaskFieldType } from "./ManualTaskFieldType"; +import { ManualTaskFieldType } from "./ManualTaskFieldType"; /** + * ManualTaskFieldBase + * * Base schema for all field definitions. */ export type ManualTaskFieldBase = { /** + * Field Key + * * Unique key for the field */ field_key: string; @@ -21,4 +23,9 @@ export type ManualTaskFieldBase = { * Field metadata and configuration */ field_metadata: ManualTaskFieldMetadata; + [key: string]: + | unknown + | string + | ManualTaskFieldType + | ManualTaskFieldMetadata; }; diff --git a/clients/admin-ui/src/types/api/models/ManualTaskFieldMetadata.ts b/clients/admin-ui/src/types/api/models/ManualTaskFieldMetadata.ts index a934132cf07..2be9bf2bfa7 100644 --- a/clients/admin-ui/src/types/api/models/ManualTaskFieldMetadata.ts +++ b/clients/admin-ui/src/types/api/models/ManualTaskFieldMetadata.ts @@ -1,25 +1,42 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ManualTaskFieldMetadata + * * Base schema for manual task field metadata. */ export type ManualTaskFieldMetadata = { /** + * Label + * * Display label for the field */ label: string; /** + * Required + * * Whether the field is required */ required?: boolean; /** + * Help Text + * * Help text to display with the field */ help_text?: string | null; /** + * Data Uses + * * List of data uses associated with this field */ data_uses?: Array | null; + [key: string]: + | unknown + | string + | boolean + | string + | null + | Array + | null + | undefined; }; diff --git a/clients/admin-ui/src/types/api/models/ManualTaskFieldType.ts b/clients/admin-ui/src/types/api/models/ManualTaskFieldType.ts index c4c57985755..ad90a864695 100644 --- a/clients/admin-ui/src/types/api/models/ManualTaskFieldType.ts +++ b/clients/admin-ui/src/types/api/models/ManualTaskFieldType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ManualTaskFieldType + * * Enum for manual task field types. */ export enum ManualTaskFieldType { diff --git a/clients/admin-ui/src/types/api/models/ManualTaskParentEntityType.ts b/clients/admin-ui/src/types/api/models/ManualTaskParentEntityType.ts index 4f3061f2042..642fa336579 100644 --- a/clients/admin-ui/src/types/api/models/ManualTaskParentEntityType.ts +++ b/clients/admin-ui/src/types/api/models/ManualTaskParentEntityType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ManualTaskParentEntityType + * * Enum for manual task parent entity types. */ export enum ManualTaskParentEntityType { diff --git a/clients/admin-ui/src/types/api/models/ManualTaskResponse.ts b/clients/admin-ui/src/types/api/models/ManualTaskResponse.ts index 6349e082652..359da062a06 100644 --- a/clients/admin-ui/src/types/api/models/ManualTaskResponse.ts +++ b/clients/admin-ui/src/types/api/models/ManualTaskResponse.ts @@ -1,21 +1,26 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { AssignedUserSummary } from "./AssignedUserSummary"; import type { ConditionGroup } from "./ConditionGroup"; -import type { ManualTaskParentEntityType } from "./ManualTaskParentEntityType"; -import type { StatusType } from "./StatusType"; +import type { ConditionLeaf } from "./ConditionLeaf"; +import { ManualTaskParentEntityType } from "./ManualTaskParentEntityType"; +import { StatusType } from "./StatusType"; /** + * ManualTaskResponse + * * Schema for manual task response. */ export type ManualTaskResponse = { /** + * Id + * * Task ID */ id: string; /** + * Parent Entity Id + * * Parent entity ID */ parent_entity_id: string; @@ -28,19 +33,51 @@ export type ManualTaskResponse = { */ status: StatusType; /** + * Created At + * * Creation timestamp */ created_at: string; /** + * Updated At + * * Last update timestamp */ updated_at: string; /** - * Users assigned to the manual task + * Assigned Users + * + * Users assigned to the task level */ assigned_users?: Array | null; /** - * Dependency conditions + * Dependency Conditions + * + * Dependency conditions at task level */ - dependency_conditions?: Array | null; + dependency_conditions?: Array | null; + /** + * Field Assigned Users + * + * Users assigned to specific fields, keyed by config_field_key + */ + field_assigned_users?: { + [key: string]: Array; + } | null; + /** + * Field Dependency Conditions + * + * Dependency conditions for specific fields, keyed by config_field_key + */ + field_dependency_conditions?: { + [key: string]: Array; + } | null; + /** + * Validation Warnings + * + * Validation warnings for dependency conditions + */ + validation_warnings?: { + [key: string]: unknown; + } | null; }; diff --git a/clients/admin-ui/src/types/api/models/ManualWebhookData.ts b/clients/admin-ui/src/types/api/models/ManualWebhookData.ts index 6abd82856bf..b0a40922045 100644 --- a/clients/admin-ui/src/types/api/models/ManualWebhookData.ts +++ b/clients/admin-ui/src/types/api/models/ManualWebhookData.ts @@ -1,8 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ManualWebhookData + */ export type ManualWebhookData = { + /** + * Checked + */ checked: boolean; - fields: any; + /** + * Fields + */ + fields: { + [key: string]: unknown; + }; }; diff --git a/clients/admin-ui/src/types/api/models/ManualWebhookDocsSchema.ts b/clients/admin-ui/src/types/api/models/ManualWebhookDocsSchema.ts index e09ffa92fbe..72365e3394e 100644 --- a/clients/admin-ui/src/types/api/models/ManualWebhookDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/ManualWebhookDocsSchema.ts @@ -1,8 +1,10 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ManualWebhookDocsSchema + * * Manual Webhooks Secrets Schema for API Docs */ -export type ManualWebhookDocsSchema = {}; +export type ManualWebhookDocsSchema = { + [key: string]: unknown; +}; diff --git a/clients/admin-ui/src/types/api/models/ManualWebhookField.ts b/clients/admin-ui/src/types/api/models/ManualWebhookField.ts index 8858fadf399..d3bb7cc9248 100644 --- a/clients/admin-ui/src/types/api/models/ManualWebhookField.ts +++ b/clients/admin-ui/src/types/api/models/ManualWebhookField.ts @@ -1,13 +1,25 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ManualWebhookField + * * Schema to describe the attributes on a manual webhook field */ export type ManualWebhookField = { + /** + * Pii Field + */ pii_field: string; + /** + * Types + */ types?: Array<"string" | "file">; + /** + * Dsr Package Label + */ dsr_package_label?: string | null; + /** + * Data Categories + */ data_categories?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/MappedPurpose.ts b/clients/admin-ui/src/types/api/models/MappedPurpose.ts index 9c2fc050b53..6fecb139b10 100644 --- a/clients/admin-ui/src/types/api/models/MappedPurpose.ts +++ b/clients/admin-ui/src/types/api/models/MappedPurpose.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MappedPurpose + * * Extension of the base GVL purpose model to include properties related to fideslang mappings. * * This is separated from the base GVL purpose model to keep that model a "pristine" representation @@ -10,22 +10,32 @@ */ export type MappedPurpose = { /** + * Id + * * Official GVL purpose ID. Used for linking with other records, e.g. vendors, cookies, etc. */ id: number; /** + * Name + * * Name of the GVL purpose. */ name: string; /** + * Description + * * Description of the GVL purpose. */ description: string; /** + * Illustrations + * * Illustrative examples of the purpose. */ illustrations: Array; /** + * Data Uses + * * The fideslang default taxonomy data uses that are associated with the purpose. */ data_uses: Array; diff --git a/clients/admin-ui/src/types/api/models/MariaDBDocsSchema.ts b/clients/admin-ui/src/types/api/models/MariaDBDocsSchema.ts index 3569845f0c1..0bf54d22dff 100644 --- a/clients/admin-ui/src/types/api/models/MariaDBDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/MariaDBDocsSchema.ts @@ -1,28 +1,38 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MariaDBDocsSchema + * * MariaDB Secrets Schema for API Docs */ export type MariaDBDocsSchema = { /** + * Host + * * The hostname or IP address of the server where the database is running. */ host: string; /** + * Port + * * The network port number on which the server is listening for incoming connections (default: 3306). */ port?: number; /** + * Username + * * The user account used to authenticate and access the database. */ username?: string | null; /** + * Password + * * The password used to authenticate and access the database. */ password?: string | null; /** + * Database + * * The name of the specific database within the database server that you want to connect to. */ dbname: string; diff --git a/clients/admin-ui/src/types/api/models/MaskingAPIRequest.ts b/clients/admin-ui/src/types/api/models/MaskingAPIRequest.ts index 7ecf0c70ac8..1a8ab093b81 100644 --- a/clients/admin-ui/src/types/api/models/MaskingAPIRequest.ts +++ b/clients/admin-ui/src/types/api/models/MaskingAPIRequest.ts @@ -1,14 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { PolicyMaskingSpec } from "./PolicyMaskingSpec"; /** + * MaskingAPIRequest + * * The API Request for masking operations */ export type MaskingAPIRequest = { + /** + * Values + */ values: Array; + /** + * Masking Strategy + */ masking_strategy: PolicyMaskingSpec | Array; + /** + * Masking Strategies + */ masking_strategies?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/MaskingAPIResponse.ts b/clients/admin-ui/src/types/api/models/MaskingAPIResponse.ts index 34fd04f9df2..dd3747ca1e5 100644 --- a/clients/admin-ui/src/types/api/models/MaskingAPIResponse.ts +++ b/clients/admin-ui/src/types/api/models/MaskingAPIResponse.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MaskingAPIResponse + * * The API Response returned upon masking completion */ export type MaskingAPIResponse = { + /** + * Plain + */ plain: Array; - masked_values: Array; + /** + * Masked Values + */ + masked_values: Array; }; diff --git a/clients/admin-ui/src/types/api/models/MaskingStrategies.ts b/clients/admin-ui/src/types/api/models/MaskingStrategies.ts index bd3566ae634..af8cbee684c 100644 --- a/clients/admin-ui/src/types/api/models/MaskingStrategies.ts +++ b/clients/admin-ui/src/types/api/models/MaskingStrategies.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MaskingStrategies + * * Possible options for masking strategy overrides */ export enum MaskingStrategies { diff --git a/clients/admin-ui/src/types/api/models/MaskingStrategyConfigurationDescription.ts b/clients/admin-ui/src/types/api/models/MaskingStrategyConfigurationDescription.ts index 5a0579a82b0..b0822bf8c77 100644 --- a/clients/admin-ui/src/types/api/models/MaskingStrategyConfigurationDescription.ts +++ b/clients/admin-ui/src/types/api/models/MaskingStrategyConfigurationDescription.ts @@ -1,12 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MaskingStrategyConfigurationDescription + * * The description model for a specific configuration in a masking strategy */ export type MaskingStrategyConfigurationDescription = { + /** + * Key + */ key: string; + /** + * Optional + */ optional?: boolean; + /** + * Description + */ description: string; }; diff --git a/clients/admin-ui/src/types/api/models/MaskingStrategyDescription.ts b/clients/admin-ui/src/types/api/models/MaskingStrategyDescription.ts index 9f8c761e821..a5d63fc8dba 100644 --- a/clients/admin-ui/src/types/api/models/MaskingStrategyDescription.ts +++ b/clients/admin-ui/src/types/api/models/MaskingStrategyDescription.ts @@ -1,14 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { MaskingStrategyConfigurationDescription } from "./MaskingStrategyConfigurationDescription"; /** + * MaskingStrategyDescription + * * The description model for a masking strategy */ export type MaskingStrategyDescription = { + /** + * Name + */ name: string; + /** + * Description + */ description: string; + /** + * Configurations + */ configurations: Array; }; diff --git a/clients/admin-ui/src/types/api/models/MaskingStrategyOverride.ts b/clients/admin-ui/src/types/api/models/MaskingStrategyOverride.ts index 13187f1a42a..4f21cc4208d 100644 --- a/clients/admin-ui/src/types/api/models/MaskingStrategyOverride.ts +++ b/clients/admin-ui/src/types/api/models/MaskingStrategyOverride.ts @@ -1,10 +1,10 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { MaskingStrategies } from "./MaskingStrategies"; +import { MaskingStrategies } from "./MaskingStrategies"; /** + * MaskingStrategyOverride + * * Overrides collection-level masking strategies. */ export type MaskingStrategyOverride = { diff --git a/clients/admin-ui/src/types/api/models/MatchesEnum.ts b/clients/admin-ui/src/types/api/models/MatchesEnum.ts index 151238f0c00..bdae06416fd 100644 --- a/clients/admin-ui/src/types/api/models/MatchesEnum.ts +++ b/clients/admin-ui/src/types/api/models/MatchesEnum.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MatchesEnum + * * The MatchesEnum resource model. * * Determines how the listed resources are matched in the evaluation logic. diff --git a/clients/admin-ui/src/types/api/models/MessagingActionType.ts b/clients/admin-ui/src/types/api/models/MessagingActionType.ts index 1a4d3a375a9..0e62bdd2edc 100644 --- a/clients/admin-ui/src/types/api/models/MessagingActionType.ts +++ b/clients/admin-ui/src/types/api/models/MessagingActionType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MessagingActionType + * * Enum for messaging action type */ export enum MessagingActionType { @@ -19,5 +19,6 @@ export enum MessagingActionType { PRIVACY_REQUEST_REVIEW_APPROVE = "privacy_request_review_approve", USER_INVITE = "user_invite", EXTERNAL_USER_WELCOME = "external_user_welcome", + MANUAL_TASK_DIGEST = "manual_task_digest", TEST_MESSAGE = "test_message", } diff --git a/clients/admin-ui/src/types/api/models/MessagingConfigRequest.ts b/clients/admin-ui/src/types/api/models/MessagingConfigRequest.ts index a388cfffcab..de5f10ce501 100644 --- a/clients/admin-ui/src/types/api/models/MessagingConfigRequest.ts +++ b/clients/admin-ui/src/types/api/models/MessagingConfigRequest.ts @@ -1,24 +1,101 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +import { AWSAuthMethod } from "./AWSAuthMethod"; import type { MessagingServiceDetailsAWS_SES } from "./MessagingServiceDetailsAWS_SES"; import type { MessagingServiceDetailsMailchimpTransactional } from "./MessagingServiceDetailsMailchimpTransactional"; import type { MessagingServiceDetailsMailgun } from "./MessagingServiceDetailsMailgun"; import type { MessagingServiceDetailsTwilioEmail } from "./MessagingServiceDetailsTwilioEmail"; -import type { MessagingServiceType } from "./MessagingServiceType"; +import { MessagingServiceType } from "./MessagingServiceType"; /** + * MessagingConfigRequest + * * Messaging Config Request Schema */ export type MessagingConfigRequest = { service_type: MessagingServiceType; + /** + * Details + */ details?: | MessagingServiceDetailsMailgun | MessagingServiceDetailsTwilioEmail | MessagingServiceDetailsMailchimpTransactional | MessagingServiceDetailsAWS_SES | null; - name: string; + /** + * Name + */ + name?: string | null; + /** + * Key + */ key?: string | null; + /** + * Secrets + */ + secrets?: + | { + /** + * Mailgun Api Key + */ + mailgun_api_key: string; + } + | { + /** + * Twilio Account Sid + */ + twilio_account_sid: string; + /** + * Twilio Auth Token + */ + twilio_auth_token: string; + /** + * Twilio Messaging Service Sid + */ + twilio_messaging_service_sid?: string | null; + /** + * Twilio Sender Phone Number + */ + twilio_sender_phone_number?: string | null; + } + | { + /** + * Twilio Api Key + */ + twilio_api_key: string; + } + | { + /** + * Mailchimp Transactional Api Key + */ + mailchimp_transactional_api_key: string; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + } + | null; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingConfigRequestBase.ts b/clients/admin-ui/src/types/api/models/MessagingConfigRequestBase.ts index fed8642b7c6..61f3df050cc 100644 --- a/clients/admin-ui/src/types/api/models/MessagingConfigRequestBase.ts +++ b/clients/admin-ui/src/types/api/models/MessagingConfigRequestBase.ts @@ -1,18 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { MessagingServiceDetailsAWS_SES } from "./MessagingServiceDetailsAWS_SES"; import type { MessagingServiceDetailsMailchimpTransactional } from "./MessagingServiceDetailsMailchimpTransactional"; import type { MessagingServiceDetailsMailgun } from "./MessagingServiceDetailsMailgun"; import type { MessagingServiceDetailsTwilioEmail } from "./MessagingServiceDetailsTwilioEmail"; -import type { MessagingServiceType } from "./MessagingServiceType"; +import { MessagingServiceType } from "./MessagingServiceType"; /** + * MessagingConfigRequestBase + * * Base model shared by messaging config requests to provide validation on request inputs */ export type MessagingConfigRequestBase = { service_type: MessagingServiceType; + /** + * Details + */ details?: | MessagingServiceDetailsMailgun | MessagingServiceDetailsTwilioEmail diff --git a/clients/admin-ui/src/types/api/models/MessagingConfigResponse.ts b/clients/admin-ui/src/types/api/models/MessagingConfigResponse.ts index cc87a582f07..fe9ce5bfaca 100644 --- a/clients/admin-ui/src/types/api/models/MessagingConfigResponse.ts +++ b/clients/admin-ui/src/types/api/models/MessagingConfigResponse.ts @@ -1,26 +1,41 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { MessagingServiceDetailsAWS_SES } from "./MessagingServiceDetailsAWS_SES"; import type { MessagingServiceDetailsMailchimpTransactional } from "./MessagingServiceDetailsMailchimpTransactional"; import type { MessagingServiceDetailsMailgun } from "./MessagingServiceDetailsMailgun"; import type { MessagingServiceDetailsTwilioEmail } from "./MessagingServiceDetailsTwilioEmail"; -import type { MessagingServiceType } from "./MessagingServiceType"; +import { MessagingServiceType } from "./MessagingServiceType"; /** + * MessagingConfigResponse + * * Messaging Config Response Schema */ export type MessagingConfigResponse = { service_type: MessagingServiceType; + /** + * Details + */ details?: | MessagingServiceDetailsMailgun | MessagingServiceDetailsTwilioEmail | MessagingServiceDetailsMailchimpTransactional | MessagingServiceDetailsAWS_SES | null; + /** + * Name + */ name: string; - last_test_timestamp: string; - last_test_succeeded: boolean; + /** + * Key + */ key: string; + /** + * Last Test Timestamp + */ + last_test_timestamp?: string | null; + /** + * Last Test Succeeded + */ + last_test_succeeded?: boolean | null; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingConfigStatus.ts b/clients/admin-ui/src/types/api/models/MessagingConfigStatus.ts index 232fe9eb84c..bfe1dc7b5d0 100644 --- a/clients/admin-ui/src/types/api/models/MessagingConfigStatus.ts +++ b/clients/admin-ui/src/types/api/models/MessagingConfigStatus.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MessagingConfigStatus + * * Enum for configuration statuses of a messaging config */ export enum MessagingConfigStatus { diff --git a/clients/admin-ui/src/types/api/models/MessagingConfigStatusMessage.ts b/clients/admin-ui/src/types/api/models/MessagingConfigStatusMessage.ts index 16d4e8ac02e..f647dd3dfd0 100644 --- a/clients/admin-ui/src/types/api/models/MessagingConfigStatusMessage.ts +++ b/clients/admin-ui/src/types/api/models/MessagingConfigStatusMessage.ts @@ -1,13 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { MessagingConfigStatus } from "./MessagingConfigStatus"; +import { MessagingConfigStatus } from "./MessagingConfigStatus"; /** + * MessagingConfigStatusMessage + * * A schema for checking configuration status of message config. */ export type MessagingConfigStatusMessage = { config_status?: MessagingConfigStatus | null; + /** + * Detail + */ detail?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingConnectionTestStatus.ts b/clients/admin-ui/src/types/api/models/MessagingConnectionTestStatus.ts index 59640f6e7c7..8bfa5af89c0 100644 --- a/clients/admin-ui/src/types/api/models/MessagingConnectionTestStatus.ts +++ b/clients/admin-ui/src/types/api/models/MessagingConnectionTestStatus.ts @@ -1,12 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MessagingConnectionTestStatus + * * Enum for supplying statuses of validating credentials for a messaging Config */ export enum MessagingConnectionTestStatus { SUCCEEDED = "succeeded", FAILED = "failed", - SKIPPED = "skipped", } diff --git a/clients/admin-ui/src/types/api/models/MessagingMethod.ts b/clients/admin-ui/src/types/api/models/MessagingMethod.ts index f8804c2cbd2..5f0537ad4b5 100644 --- a/clients/admin-ui/src/types/api/models/MessagingMethod.ts +++ b/clients/admin-ui/src/types/api/models/MessagingMethod.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MessagingMethod + * * Enum for messaging method */ export enum MessagingMethod { diff --git a/clients/admin-ui/src/types/api/models/MessagingSecretsMailgunDocs.ts b/clients/admin-ui/src/types/api/models/MessagingSecretsMailgunDocs.ts index d4263ff5f52..c344bc333c3 100644 --- a/clients/admin-ui/src/types/api/models/MessagingSecretsMailgunDocs.ts +++ b/clients/admin-ui/src/types/api/models/MessagingSecretsMailgunDocs.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MessagingSecretsMailgunDocs + * * The secrets required to connect to Mailgun, for documentation */ export type MessagingSecretsMailgunDocs = { + /** + * Mailgun Api Key + */ mailgun_api_key: string; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingSecretsTwilioEmailDocs.ts b/clients/admin-ui/src/types/api/models/MessagingSecretsTwilioEmailDocs.ts index 5ed665e470b..4e421413518 100644 --- a/clients/admin-ui/src/types/api/models/MessagingSecretsTwilioEmailDocs.ts +++ b/clients/admin-ui/src/types/api/models/MessagingSecretsTwilioEmailDocs.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MessagingSecretsTwilioEmailDocs + * * The secrets required to connect to Twilio email, for documentation */ export type MessagingSecretsTwilioEmailDocs = { + /** + * Twilio Api Key + */ twilio_api_key: string; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingSecretsTwilioSMSDocs.ts b/clients/admin-ui/src/types/api/models/MessagingSecretsTwilioSMSDocs.ts index c9433cd8c29..4235e7dd15d 100644 --- a/clients/admin-ui/src/types/api/models/MessagingSecretsTwilioSMSDocs.ts +++ b/clients/admin-ui/src/types/api/models/MessagingSecretsTwilioSMSDocs.ts @@ -1,13 +1,25 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MessagingSecretsTwilioSMSDocs + * * The secrets required to connect to Twilio sms, for documentation */ export type MessagingSecretsTwilioSMSDocs = { + /** + * Twilio Account Sid + */ twilio_account_sid: string; + /** + * Twilio Auth Token + */ twilio_auth_token: string; + /** + * Twilio Messaging Service Sid + */ twilio_messaging_service_sid?: string | null; + /** + * Twilio Sender Phone Number + */ twilio_sender_phone_number?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingServiceDetailsAWS_SES.ts b/clients/admin-ui/src/types/api/models/MessagingServiceDetailsAWS_SES.ts index 4aadf46357a..de6172df0d0 100644 --- a/clients/admin-ui/src/types/api/models/MessagingServiceDetailsAWS_SES.ts +++ b/clients/admin-ui/src/types/api/models/MessagingServiceDetailsAWS_SES.ts @@ -1,12 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MessagingServiceDetailsAWS_SES + * * The details required to represent an AWS SES email configuration. */ export type MessagingServiceDetailsAWS_SES = { + /** + * Email From + */ email_from?: string | null; + /** + * Domain + */ domain?: string | null; + /** + * Aws Region + */ aws_region: string; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingServiceDetailsMailchimpTransactional.ts b/clients/admin-ui/src/types/api/models/MessagingServiceDetailsMailchimpTransactional.ts index 698edeb0198..18da2cc317f 100644 --- a/clients/admin-ui/src/types/api/models/MessagingServiceDetailsMailchimpTransactional.ts +++ b/clients/admin-ui/src/types/api/models/MessagingServiceDetailsMailchimpTransactional.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MessagingServiceDetailsMailchimpTransactional + * * The details required to represent a Mailchimp Transactional email configuration. */ export type MessagingServiceDetailsMailchimpTransactional = { + /** + * Email From + */ email_from: string; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingServiceDetailsMailgun.ts b/clients/admin-ui/src/types/api/models/MessagingServiceDetailsMailgun.ts index cc1b0317138..1999aa3a49a 100644 --- a/clients/admin-ui/src/types/api/models/MessagingServiceDetailsMailgun.ts +++ b/clients/admin-ui/src/types/api/models/MessagingServiceDetailsMailgun.ts @@ -1,12 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MessagingServiceDetailsMailgun + * * The details required to represent a Mailgun email configuration. */ export type MessagingServiceDetailsMailgun = { + /** + * Is Eu Domain + */ is_eu_domain?: boolean | null; + /** + * Api Version + */ api_version?: string | null; + /** + * Domain + */ domain: string; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingServiceDetailsTwilioEmail.ts b/clients/admin-ui/src/types/api/models/MessagingServiceDetailsTwilioEmail.ts index b2d59c3f5b6..039ddeee278 100644 --- a/clients/admin-ui/src/types/api/models/MessagingServiceDetailsTwilioEmail.ts +++ b/clients/admin-ui/src/types/api/models/MessagingServiceDetailsTwilioEmail.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MessagingServiceDetailsTwilioEmail + * * The details required to represent a Twilio email configuration. */ export type MessagingServiceDetailsTwilioEmail = { + /** + * Twilio Email From + */ twilio_email_from: string; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingServiceSecretsAWS_SESDocs.ts b/clients/admin-ui/src/types/api/models/MessagingServiceSecretsAWS_SESDocs.ts index 9978c66b423..f9f06918a51 100644 --- a/clients/admin-ui/src/types/api/models/MessagingServiceSecretsAWS_SESDocs.ts +++ b/clients/admin-ui/src/types/api/models/MessagingServiceSecretsAWS_SESDocs.ts @@ -1,26 +1,34 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AWSAuthMethod } from "./AWSAuthMethod"; +import { AWSAuthMethod } from "./AWSAuthMethod"; /** + * MessagingServiceSecretsAWS_SESDocs + * * The secrets required to connect to AWS SES, for documentation */ export type MessagingServiceSecretsAWS_SESDocs = { /** + * Authentication Method + * * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. */ auth_method: AWSAuthMethod; /** + * Access Key ID + * * Part of the credentials that provide access to your AWS account. */ aws_access_key_id?: string | null; /** + * Secret Access Key + * * Part of the credentials that provide access to your AWS account. */ aws_secret_access_key?: string | null; /** + * Assume Role ARN + * * If provided, the ARN of the role that should be assumed to connect to AWS. */ aws_assume_role_arn?: string | null; diff --git a/clients/admin-ui/src/types/api/models/MessagingServiceSecretsMailchimpTransactionalDocs.ts b/clients/admin-ui/src/types/api/models/MessagingServiceSecretsMailchimpTransactionalDocs.ts index d44530e3638..755a5fb6596 100644 --- a/clients/admin-ui/src/types/api/models/MessagingServiceSecretsMailchimpTransactionalDocs.ts +++ b/clients/admin-ui/src/types/api/models/MessagingServiceSecretsMailchimpTransactionalDocs.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MessagingServiceSecretsMailchimpTransactionalDocs + * * The secrets required to connect Mailchimp Transactional, for documentation */ export type MessagingServiceSecretsMailchimpTransactionalDocs = { + /** + * Mailchimp Transactional Api Key + */ mailchimp_transactional_api_key: string; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingServiceType.ts b/clients/admin-ui/src/types/api/models/MessagingServiceType.ts index b5d1db0f452..6ac5b2d0bef 100644 --- a/clients/admin-ui/src/types/api/models/MessagingServiceType.ts +++ b/clients/admin-ui/src/types/api/models/MessagingServiceType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MessagingServiceType + * * Enum for messaging service type. */ export enum MessagingServiceType { diff --git a/clients/admin-ui/src/types/api/models/MessagingTemplateDefault.ts b/clients/admin-ui/src/types/api/models/MessagingTemplateDefault.ts index 8189c41f4be..6dfb8d559e9 100644 --- a/clients/admin-ui/src/types/api/models/MessagingTemplateDefault.ts +++ b/clients/admin-ui/src/types/api/models/MessagingTemplateDefault.ts @@ -1,9 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * MessagingTemplateDefault + */ export type MessagingTemplateDefault = { + /** + * Type + */ type: string; + /** + * Is Enabled + */ is_enabled: boolean; - content: any; + /** + * Content + */ + content: { + [key: string]: unknown; + }; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesBodyParams.ts b/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesBodyParams.ts index 772a1982849..f3127de23df 100644 --- a/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesBodyParams.ts +++ b/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesBodyParams.ts @@ -1,9 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * MessagingTemplateWithPropertiesBodyParams + */ export type MessagingTemplateWithPropertiesBodyParams = { - content: any; + /** + * Content + */ + content: { + [key: string]: unknown; + }; + /** + * Properties + */ properties?: Array | null; + /** + * Is Enabled + */ is_enabled: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesDetail.ts b/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesDetail.ts index 55cfbbdd4ba..ddbb17b3a01 100644 --- a/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesDetail.ts +++ b/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesDetail.ts @@ -1,13 +1,31 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { MinimalProperty } from "./MinimalProperty"; +/** + * MessagingTemplateWithPropertiesDetail + */ export type MessagingTemplateWithPropertiesDetail = { + /** + * Id + */ id: string; + /** + * Type + */ type: string; + /** + * Is Enabled + */ is_enabled: boolean; + /** + * Properties + */ properties?: Array | null; - content: any; + /** + * Content + */ + content: { + [key: string]: unknown; + }; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesPatchBodyParams.ts b/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesPatchBodyParams.ts index ea1e172885b..a7015916566 100644 --- a/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesPatchBodyParams.ts +++ b/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesPatchBodyParams.ts @@ -1,9 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * MessagingTemplateWithPropertiesPatchBodyParams + */ export type MessagingTemplateWithPropertiesPatchBodyParams = { - content?: null; + /** + * Content + */ + content?: { + [key: string]: unknown; + } | null; + /** + * Properties + */ properties?: Array | null; + /** + * Is Enabled + */ is_enabled?: boolean | null; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesSummary.ts b/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesSummary.ts index a1b201db6e2..f6680d8f42a 100644 --- a/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesSummary.ts +++ b/clients/admin-ui/src/types/api/models/MessagingTemplateWithPropertiesSummary.ts @@ -1,12 +1,25 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { MinimalProperty } from "./MinimalProperty"; +/** + * MessagingTemplateWithPropertiesSummary + */ export type MessagingTemplateWithPropertiesSummary = { + /** + * Id + */ id: string; + /** + * Type + */ type: string; + /** + * Is Enabled + */ is_enabled: boolean; + /** + * Properties + */ properties?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/MessagingTestBodyParams.ts b/clients/admin-ui/src/types/api/models/MessagingTestBodyParams.ts new file mode 100644 index 00000000000..4d6179ae3af --- /dev/null +++ b/clients/admin-ui/src/types/api/models/MessagingTestBodyParams.ts @@ -0,0 +1,12 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { IdentityBase } from "./IdentityBase"; + +/** + * MessagingTestBodyParams + * + * Body params required for testing messaging service + */ +export type MessagingTestBodyParams = { + to_identity: IdentityBase; +}; diff --git a/clients/admin-ui/src/types/api/models/MinimalAsset.ts b/clients/admin-ui/src/types/api/models/MinimalAsset.ts new file mode 100644 index 00000000000..014ba809838 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/MinimalAsset.ts @@ -0,0 +1,39 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * MinimalAsset + * + * Schema for a minimal asset response. Used in the privacy experience API. + * Purposely excludes the page field which can get very large when populated + * by the web monitor detection process. + */ +export type MinimalAsset = { + /** + * Name + */ + name: string; + /** + * Domain + */ + domain?: string | null; + /** + * Data Uses + */ + data_uses?: Array; + /** + * Description + */ + description?: string | null; + /** + * Duration + */ + duration?: string | null; + /** + * System Name + */ + system_name?: string | null; + /** + * System Fides Key + */ + system_fides_key?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/MinimalClassifyParams.ts b/clients/admin-ui/src/types/api/models/MinimalClassifyParams.ts index fbaf2e59c8e..0db8a0ae773 100644 --- a/clients/admin-ui/src/types/api/models/MinimalClassifyParams.ts +++ b/clients/admin-ui/src/types/api/models/MinimalClassifyParams.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MinimalClassifyParams + * * Minimal model for classify params that can be edited via the UI. */ export type MinimalClassifyParams = { - context_regex_pattern_mapping?: Array; + /** + * Context Regex Pattern Mapping + */ + context_regex_pattern_mapping?: Array<[string, string]>; }; diff --git a/clients/admin-ui/src/types/api/models/MinimalMessagingTemplate.ts b/clients/admin-ui/src/types/api/models/MinimalMessagingTemplate.ts index a9169cd2a4d..d5505f70975 100644 --- a/clients/admin-ui/src/types/api/models/MinimalMessagingTemplate.ts +++ b/clients/admin-ui/src/types/api/models/MinimalMessagingTemplate.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MinimalMessagingTemplate + * * Minimal representation of a messaging template. * * NOTE: Add to this schema with care. Any fields added to @@ -11,6 +11,12 @@ * sensitive information, it should NOT be added to this schema! */ export type MinimalMessagingTemplate = { + /** + * Id + */ id: string; + /** + * Type + */ type: string; }; diff --git a/clients/admin-ui/src/types/api/models/MinimalPrivacyExperienceConfig.ts b/clients/admin-ui/src/types/api/models/MinimalPrivacyExperienceConfig.ts index 99382003c50..2151f95b94f 100644 --- a/clients/admin-ui/src/types/api/models/MinimalPrivacyExperienceConfig.ts +++ b/clients/admin-ui/src/types/api/models/MinimalPrivacyExperienceConfig.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MinimalPrivacyExperienceConfig + * * Minimal representation of a privacy experience config, contains enough information * to select experience configs by name in the UI and an ID to link the selections in the database. * @@ -12,6 +12,12 @@ * sensitive information, it should NOT be added to this schema! */ export type MinimalPrivacyExperienceConfig = { + /** + * Id + */ id: string; + /** + * Name + */ name: string; }; diff --git a/clients/admin-ui/src/types/api/models/MinimalPrivacyNotice.ts b/clients/admin-ui/src/types/api/models/MinimalPrivacyNotice.ts index fe90757c951..0e3b889b4ac 100644 --- a/clients/admin-ui/src/types/api/models/MinimalPrivacyNotice.ts +++ b/clients/admin-ui/src/types/api/models/MinimalPrivacyNotice.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MinimalPrivacyNotice + * * Minimal schema to represent child privacy notices. */ export type MinimalPrivacyNotice = { + /** + * Id + */ id: string; + /** + * Name + */ name: string; }; diff --git a/clients/admin-ui/src/types/api/models/MinimalProperty.ts b/clients/admin-ui/src/types/api/models/MinimalProperty.ts index 3408a59a48d..712e0ccdcf7 100644 --- a/clients/admin-ui/src/types/api/models/MinimalProperty.ts +++ b/clients/admin-ui/src/types/api/models/MinimalProperty.ts @@ -1,8 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * MinimalProperty + */ export type MinimalProperty = { + /** + * Id + */ id: string; + /** + * Name + */ name: string; }; diff --git a/clients/admin-ui/src/types/api/models/MinimalTCFBannerTranslation.ts b/clients/admin-ui/src/types/api/models/MinimalTCFBannerTranslation.ts index d3c6792dc95..8b92bb411df 100644 --- a/clients/admin-ui/src/types/api/models/MinimalTCFBannerTranslation.ts +++ b/clients/admin-ui/src/types/api/models/MinimalTCFBannerTranslation.ts @@ -1,32 +1,42 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { SupportedLanguage } from "./SupportedLanguage"; +import { SupportedLanguage } from "./SupportedLanguage"; /** + * MinimalTCFBannerTranslation + * * A minimal ExperienceTranslation to support building a simple TCF banner * * Minimal TCF Experiences return this single translation */ export type MinimalTCFBannerTranslation = { /** + * Accept Button Label + * * Accept or confirmation button label */ accept_button_label?: string | null; /** + * Banner Description + * * Banner description. HTML descriptions are supported so links can be included. */ banner_description?: string | null; /** + * Banner Title + * * Banner title */ banner_title?: string | null; /** + * Description + * * Overall description - used for banner as well if applicable. HTML descriptions are supported so links can be included. */ description?: string | null; /** + * Is Default + * * Whether the given translation is the default */ is_default?: boolean | null; @@ -35,30 +45,44 @@ export type MinimalTCFBannerTranslation = { */ language: SupportedLanguage; /** + * Privacy Experience Config History Id + * * The versioned artifact of the translation and its Experience Config. Should be supplied when saving privacy preferences or notices served for additional context. */ privacy_experience_config_history_id: string; /** + * Privacy Policy Link Label + * * Privacy policy link label */ privacy_policy_link_label?: string | null; /** + * Privacy Policy Url + * * Privacy policy URL */ privacy_policy_url?: string | null; /** + * Privacy Preferences Link Label + * * Privacy preferences link label */ privacy_preferences_link_label?: string | null; /** + * Purpose Header + * * Purpose header for TCF banner */ purpose_header?: string | null; /** + * Reject Button Label + * * Reject button label */ reject_button_label?: string | null; /** + * Title + * * Overall title */ title?: string | null; diff --git a/clients/admin-ui/src/types/api/models/MinimalTCFExperienceConfig.ts b/clients/admin-ui/src/types/api/models/MinimalTCFExperienceConfig.ts index 9f7a2763456..6525015b7a4 100644 --- a/clients/admin-ui/src/types/api/models/MinimalTCFExperienceConfig.ts +++ b/clients/admin-ui/src/types/api/models/MinimalTCFExperienceConfig.ts @@ -1,23 +1,41 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ComponentType } from "./ComponentType"; -import type { Layer1ButtonOption } from "./Layer1ButtonOption"; +import { ComponentType } from "./ComponentType"; +import { Layer1ButtonOption } from "./Layer1ButtonOption"; import type { MinimalTCFBannerTranslation } from "./MinimalTCFBannerTranslation"; -import type { RejectAllMechanism } from "./RejectAllMechanism"; +import { RejectAllMechanism } from "./RejectAllMechanism"; /** + * MinimalTCFExperienceConfig + * * A minimal TCF Privacy Experience Config response, to show the smallest response body * needed to build the banner */ export type MinimalTCFExperienceConfig = { + /** + * Id + */ id: string; + /** + * Auto Detect Language + */ auto_detect_language?: boolean | null; + /** + * Auto Subdomain Cookie Deletion + */ auto_subdomain_cookie_deletion?: boolean | null; + /** + * Cookie Deletion Based On Host Domain + */ cookie_deletion_based_on_host_domain?: boolean | null; component: ComponentType; + /** + * Dismissable + */ dismissable?: boolean | null; + /** + * Translations + */ translations?: Array; /** * Determines the behavior of the reject all button diff --git a/clients/admin-ui/src/types/api/models/MongoDBDocsSchema.ts b/clients/admin-ui/src/types/api/models/MongoDBDocsSchema.ts index c9d4b3d89c7..0c1927ce493 100644 --- a/clients/admin-ui/src/types/api/models/MongoDBDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/MongoDBDocsSchema.ts @@ -1,37 +1,51 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MongoDBDocsSchema + * * Mongo DB Secrets Schema for API docs */ export type MongoDBDocsSchema = { /** + * Host + * * The hostname or IP address of the server where the database is running. */ host: string; /** - * The network port number on which the server is listening for incoming connections (default: 27017). + * Port + * + * The network port number on which the server is listening for incoming connections (default: 27017). Port will be ignored if using SRV. */ port?: number; /** + * Username + * * The user account used to authenticate and access the database. */ username: string; /** + * Password + * * The password used to authenticate and access the database. */ password: string; /** + * Default auth DB + * * Used to specify the default authentication database. */ defaultauthdb: string; /** + * Use SRV + * * Enable SRV record lookup for service discovery (mongodb+srv://). Required for MongoDB Atlas. Enables SSL by default. */ - use_srv?: boolean; + use_srv?: boolean | null; /** + * SSL enabled + * * Enable SSL/TLS encryption. With SRV: defaults to enabled (can override). Without SRV: defaults to disabled. */ - ssl_enabled?: boolean; + ssl_enabled?: boolean | null; }; diff --git a/clients/admin-ui/src/types/api/models/MonitorActionResponse.ts b/clients/admin-ui/src/types/api/models/MonitorActionResponse.ts index 1c3323ca965..2c6368dcdc1 100644 --- a/clients/admin-ui/src/types/api/models/MonitorActionResponse.ts +++ b/clients/admin-ui/src/types/api/models/MonitorActionResponse.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MonitorActionResponse + * * Generic response model for performing actions on monitor resources */ export type MonitorActionResponse = { + /** + * Task Ids + */ task_ids?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/MonitorClassifyParams.ts b/clients/admin-ui/src/types/api/models/MonitorClassifyParams.ts index c10ac9ebbfd..6327e5f5be6 100644 --- a/clients/admin-ui/src/types/api/models/MonitorClassifyParams.ts +++ b/clients/admin-ui/src/types/api/models/MonitorClassifyParams.ts @@ -1,36 +1,115 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ClassifyLlmPromptTemplateOptions } from "./ClassifyLlmPromptTemplateOptions"; +import { ClassifyLlmPromptTemplateOptions } from "./ClassifyLlmPromptTemplateOptions"; /** + * MonitorClassifyParams + * * Extension of base ClassifyParams to include some additional * classification parameters that can be used with Discovery monitors */ export type MonitorClassifyParams = { + /** + * Possible Targets + */ possible_targets?: Array | null; + /** + * Top N + */ top_n?: number; + /** + * Remove Stop Words + */ remove_stop_words?: boolean; + /** + * Pii Threshold + */ pii_threshold?: number; + /** + * Num Samples + */ num_samples?: number; + /** + * Num Threads + */ num_threads?: number; + /** + * Context Weight + */ context_weight?: number; + /** + * Content Weight + */ content_weight?: number; + /** + * Prefer Context + */ prefer_context?: boolean; - excluded_categories?: Array; + /** + * Excluded Categories + */ + excluded_categories?: Array; + /** + * Context Classification Enabled + */ context_classification_enabled?: boolean; + /** + * Context Classifier + */ context_classifier?: string; + /** + * Custom Llm Instructions + */ custom_llm_instructions?: string | null; + /** + * Llm Model Override + */ llm_model_override?: string | null; prompt_template?: ClassifyLlmPromptTemplateOptions | null; + /** + * Num Workers + */ num_workers?: number; + /** + * Max Tokens + */ + max_tokens?: number; + /** + * Classification Retry Count + * + * Number of times to retry classification if the LLM returns an invalid response (e.g., null tags, malformed XML). Set to 0 to disable retries. + */ + classification_retry_count?: number; + /** + * Language + */ language?: string; + /** + * Decision Method + */ decision_method?: string; + /** + * Aggregation Method + */ aggregation_method?: string; + /** + * Infer Not Pii + */ infer_not_pii?: boolean; + /** + * Content Model + */ content_model?: string; + /** + * Content Classification Enabled + */ content_classification_enabled?: boolean; - context_regex_pattern_mapping?: Array; + /** + * Context Regex Pattern Mapping + */ + context_regex_pattern_mapping?: Array<[string, string]>; + /** + * Ignore Classification Updates + */ ignore_classification_updates?: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/MonitorConfig.ts b/clients/admin-ui/src/types/api/models/MonitorConfig.ts index 4019b05526d..b2a41b90fe3 100644 --- a/clients/admin-ui/src/types/api/models/MonitorConfig.ts +++ b/clients/admin-ui/src/types/api/models/MonitorConfig.ts @@ -1,11 +1,9 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { BigQueryMonitorParams } from "./BigQueryMonitorParams"; import type { DynamoDBMonitorParams } from "./DynamoDBMonitorParams"; import type { MonitorClassifyParams } from "./MonitorClassifyParams"; -import type { MonitorFrequency } from "./MonitorFrequency"; +import { MonitorFrequency } from "./MonitorFrequency"; import type { MonitorStewardUserResponse } from "./MonitorStewardUserResponse"; import type { S3MonitorParams } from "./S3MonitorParams"; import type { TestMonitorParams } from "./TestMonitorParams"; @@ -13,20 +11,36 @@ import type { TestWebsiteMonitorParams } from "./TestWebsiteMonitorParams"; import type { WebsiteMonitorParams } from "./WebsiteMonitorParams"; /** + * MonitorConfig + * * Extends the EditableMonitorConfig with non-editable MonitorConfig fields. */ export type MonitorConfig = { + /** + * Name + */ name: string; + /** + * Key + */ key?: string | null; + /** + * Connection Config Key + */ connection_config_key: string; /** * Parameters for classification of discovered resources */ classify_params?: MonitorClassifyParams | null; /** + * Datasource Params + * * The datasource specific parameters, specified in a dictionary */ datasource_params?: + | { + [key: string]: unknown; + } | DynamoDBMonitorParams | S3MonitorParams | WebsiteMonitorParams @@ -35,26 +49,42 @@ export type MonitorConfig = { | BigQueryMonitorParams | null; /** + * Databases + * * The databases that the monitor is scoped to actively monitor */ databases?: Array; + /** + * Execution Start Date + */ execution_start_date?: string | null; execution_frequency?: MonitorFrequency | null; /** + * Excluded Databases + * * The databases that the monitor should exclude from monitoring */ excluded_databases?: Array; /** + * Enabled + * * Indicates whether the monitor is enabled or not. Disabled monitors won't be executed */ enabled?: boolean | null; /** + * Shared Config Id + * * Reference to a shared monitor configuration */ shared_config_id?: string | null; /** + * Stewards + * * List of users assigned as stewards for this monitor */ stewards?: Array; + /** + * Last Monitored + */ last_monitored?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/MonitorConfigStagedResourcesAggregateRecord.ts b/clients/admin-ui/src/types/api/models/MonitorConfigStagedResourcesAggregateRecord.ts index 2fbfb7a801d..c146c90ece8 100644 --- a/clients/admin-ui/src/types/api/models/MonitorConfigStagedResourcesAggregateRecord.ts +++ b/clients/admin-ui/src/types/api/models/MonitorConfigStagedResourcesAggregateRecord.ts @@ -1,8 +1,6 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConnectionType } from "./ConnectionType"; +import { ConnectionType } from "./ConnectionType"; import type { ConsentAlertInfo } from "./ConsentAlertInfo"; import type { DatastoreMonitorUpdates } from "./DatastoreMonitorUpdates"; import type { InfrastructureMonitorUpdates } from "./InfrastructureMonitorUpdates"; @@ -11,6 +9,8 @@ import type { SaaSConfigBase } from "./SaaSConfigBase"; import type { WebMonitorUpdates } from "./WebMonitorUpdates"; /** + * MonitorConfigStagedResourcesAggregateRecord + * * API response model for records of aggregated staged resources by monitor config. * * This model inherits from ConnectionConfigSecretsMixin, which handles the masking of @@ -19,18 +19,47 @@ import type { WebMonitorUpdates } from "./WebMonitorUpdates"; */ export type MonitorConfigStagedResourcesAggregateRecord = { connection_type: ConnectionType; - secrets?: null; + /** + * Secrets + */ + secrets?: { + [key: string]: unknown; + } | null; saas_config?: SaaSConfigBase | null; + /** + * Name + */ name: string; + /** + * Key + */ key?: string | null; + /** + * Last Monitored + */ last_monitored?: string | null; + /** + * Updates + */ updates?: | DatastoreMonitorUpdates | InfrastructureMonitorUpdates | WebMonitorUpdates; + /** + * Total Updates + */ total_updates?: number; consent_status?: ConsentAlertInfo | null; + /** + * Connection Name + */ connection_name?: string | null; + /** + * Has Failed Tasks + */ has_failed_tasks?: boolean | null; + /** + * Stewards + */ stewards?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/MonitorDeletionImpact.ts b/clients/admin-ui/src/types/api/models/MonitorDeletionImpact.ts new file mode 100644 index 00000000000..f3bcbf981a0 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/MonitorDeletionImpact.ts @@ -0,0 +1,37 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { LinkedDatasetInfo } from "./LinkedDatasetInfo"; + +/** + * MonitorDeletionImpact + * + * Response model describing the impact of deleting a monitor. + * + * Used to inform users about what will be affected before confirming deletion. + */ +export type MonitorDeletionImpact = { + /** + * Staged Resource Count + * + * Total number of staged resources that will be deleted + */ + staged_resource_count: number; + /** + * Linked Datasets + * + * Fides Datasets that are linked to this monitor's staged resources. These datasets will lose their linked data source metadata if the monitor is deleted. + */ + linked_datasets?: Array; + /** + * Active Task Count + * + * Number of active (pending or in-progress) tasks for this monitor. These tasks will be cancelled when the monitor is deleted. + */ + active_task_count?: number; + /** + * Associated System Count + * + * Number of distinct systems associated with this monitor's staged resources. + */ + associated_system_count?: number; +}; diff --git a/clients/admin-ui/src/types/api/models/MonitorExecution.ts b/clients/admin-ui/src/types/api/models/MonitorExecution.ts index ef86e61c2c3..d38cf17aea6 100644 --- a/clients/admin-ui/src/types/api/models/MonitorExecution.ts +++ b/clients/admin-ui/src/types/api/models/MonitorExecution.ts @@ -1,15 +1,34 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { MonitorExecutionStatus } from "./MonitorExecutionStatus"; +import { MonitorExecutionStatus } from "./MonitorExecutionStatus"; +/** + * MonitorExecution + */ export type MonitorExecution = { + /** + * Id + */ id: string; + /** + * Monitor Config Key + */ monitor_config_key: string; status?: MonitorExecutionStatus | null; + /** + * Started + */ started?: string | null; + /** + * Completed + */ completed?: string | null; + /** + * Classification Instances + */ classification_instances?: Array; + /** + * Messages + */ messages?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/MonitorExecutionRequestResponse.ts b/clients/admin-ui/src/types/api/models/MonitorExecutionRequestResponse.ts index 1b60e07e531..db118dff160 100644 --- a/clients/admin-ui/src/types/api/models/MonitorExecutionRequestResponse.ts +++ b/clients/admin-ui/src/types/api/models/MonitorExecutionRequestResponse.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MonitorExecutionRequestResponse + * * Schema for creating a MonitorExecution. */ export type MonitorExecutionRequestResponse = { + /** + * Monitor Execution Id + */ monitor_execution_id: string; + /** + * Task Id + */ task_id?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/MonitorExecutionStatus.ts b/clients/admin-ui/src/types/api/models/MonitorExecutionStatus.ts index 7cee4d550c0..61d30f2096e 100644 --- a/clients/admin-ui/src/types/api/models/MonitorExecutionStatus.ts +++ b/clients/admin-ui/src/types/api/models/MonitorExecutionStatus.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * MonitorExecutionStatus + */ export enum MonitorExecutionStatus { IN_PROGRESS = "In progress", COMPLETED = "Completed", diff --git a/clients/admin-ui/src/types/api/models/MonitorFrequency.ts b/clients/admin-ui/src/types/api/models/MonitorFrequency.ts index 75e4f285147..b5b0dd91324 100644 --- a/clients/admin-ui/src/types/api/models/MonitorFrequency.ts +++ b/clients/admin-ui/src/types/api/models/MonitorFrequency.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MonitorFrequency + * * Enum representing monitor frequency. Not used in DB but needed for translating to API schema */ export enum MonitorFrequency { diff --git a/clients/admin-ui/src/types/api/models/MonitorStatusResponse.ts b/clients/admin-ui/src/types/api/models/MonitorStatusResponse.ts index 92500b29303..0fdb3f55b5e 100644 --- a/clients/admin-ui/src/types/api/models/MonitorStatusResponse.ts +++ b/clients/admin-ui/src/types/api/models/MonitorStatusResponse.ts @@ -1,32 +1,47 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { BigQueryMonitorParams } from "./BigQueryMonitorParams"; import type { DynamoDBMonitorParams } from "./DynamoDBMonitorParams"; import type { MonitorClassifyParams } from "./MonitorClassifyParams"; import type { MonitorExecution } from "./MonitorExecution"; -import type { MonitorFrequency } from "./MonitorFrequency"; +import { MonitorFrequency } from "./MonitorFrequency"; +import type { MonitorStewardUserResponse } from "./MonitorStewardUserResponse"; import type { S3MonitorParams } from "./S3MonitorParams"; import type { TestMonitorParams } from "./TestMonitorParams"; import type { TestWebsiteMonitorParams } from "./TestWebsiteMonitorParams"; import type { WebsiteMonitorParams } from "./WebsiteMonitorParams"; /** + * MonitorStatusResponse + * * Response model for monitors including the latest execution record */ export type MonitorStatusResponse = { + /** + * Name + */ name: string; + /** + * Key + */ key?: string | null; + /** + * Connection Config Key + */ connection_config_key: string; /** * Parameters for classification of discovered resources */ classify_params?: MonitorClassifyParams | null; /** + * Datasource Params + * * The datasource specific parameters, specified in a dictionary */ datasource_params?: + | { + [key: string]: unknown; + } | DynamoDBMonitorParams | S3MonitorParams | WebsiteMonitorParams @@ -35,23 +50,46 @@ export type MonitorStatusResponse = { | BigQueryMonitorParams | null; /** + * Databases + * * The databases that the monitor is scoped to actively monitor */ databases?: Array; + /** + * Execution Start Date + */ execution_start_date?: string | null; execution_frequency?: MonitorFrequency | null; /** + * Excluded Databases + * * The databases that the monitor should exclude from monitoring */ excluded_databases?: Array; /** + * Enabled + * * Indicates whether the monitor is enabled or not. Disabled monitors won't be executed */ enabled?: boolean | null; /** + * Shared Config Id + * * Reference to a shared monitor configuration */ shared_config_id?: string | null; + /** + * Stewards + * + * List of users assigned as stewards for this monitor + */ + stewards?: Array; + /** + * Last Monitored + */ last_monitored?: string | null; + /** + * Execution Records + */ execution_records?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/MonitorStewardUserResponse.ts b/clients/admin-ui/src/types/api/models/MonitorStewardUserResponse.ts index 003266b4136..1356cef3aa8 100644 --- a/clients/admin-ui/src/types/api/models/MonitorStewardUserResponse.ts +++ b/clients/admin-ui/src/types/api/models/MonitorStewardUserResponse.ts @@ -1,14 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MonitorStewardUserResponse + * * Response schema for a user assigned as a monitor steward. */ export type MonitorStewardUserResponse = { + /** + * Id + */ id: string; + /** + * Username + */ username: string; + /** + * Email Address + */ email_address?: string | null; + /** + * First Name + */ first_name?: string | null; + /** + * Last Name + */ last_name?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/MonitorTaskDetailResponse.ts b/clients/admin-ui/src/types/api/models/MonitorTaskDetailResponse.ts index 8feb9913dce..cb3bcd3a59f 100644 --- a/clients/admin-ui/src/types/api/models/MonitorTaskDetailResponse.ts +++ b/clients/admin-ui/src/types/api/models/MonitorTaskDetailResponse.ts @@ -1,28 +1,84 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ExecutionLogResponse } from "./ExecutionLogResponse"; -import type { MonitorTaskType } from "./MonitorTaskType"; +import { ExecutionLogStatus } from "./ExecutionLogStatus"; +import { MonitorTaskType } from "./MonitorTaskType"; /** + * MonitorTaskDetailResponse + * * Detailed response model for monitor tasks including execution logs */ export type MonitorTaskDetailResponse = { + /** + * Id + */ id: string; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at: string; + /** + * Monitor Config Id + */ monitor_config_id?: string | null; + /** + * Monitor Config Key + */ + monitor_config_key?: string | null; action_type: MonitorTaskType; - status?: string | null; + /** + * Status + */ + status?: ExecutionLogStatus | string | null; + /** + * Message + */ + message?: string | null; + /** + * Celery Id + */ celery_id?: string | null; + /** + * Staged Resource Urns + */ staged_resource_urns?: Array; - child_resource_urns?: Array; - message?: string | null; - task_arguments?: any; - execution_logs?: Array; + /** + * Dismissed + */ + dismissed?: boolean | null; + /** + * Monitor Name + */ monitor_name?: string | null; + /** + * Connection Name + */ connection_name?: string | null; + /** + * Connection Type + */ connection_type?: string | null; + /** + * Field Count + */ field_count?: number | null; + /** + * Child Resource Urns + */ + child_resource_urns?: Array; + /** + * Task Arguments + */ + task_arguments?: { + [key: string]: unknown; + }; + /** + * Execution Logs + */ + execution_logs?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/MonitorTaskInProgressResponse.ts b/clients/admin-ui/src/types/api/models/MonitorTaskInProgressResponse.ts deleted file mode 100644 index 44f69a55772..00000000000 --- a/clients/admin-ui/src/types/api/models/MonitorTaskInProgressResponse.ts +++ /dev/null @@ -1,22 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -/** - * Response schema for in-progress monitor tasks in the Action Center. - */ -export type MonitorTaskInProgressResponse = { - id: string; - created_at: string; - updated_at: string; - monitor_config_id?: string | null; - monitor_name?: string | null; - action_type: string; - status: string; - message?: string | null; - staged_resource_urns?: Array | null; - dismissed?: boolean | null; - connection_type?: string | null; - connection_name?: string | null; - field_count?: number | null; -}; diff --git a/clients/admin-ui/src/types/api/models/MonitorTaskResponse.ts b/clients/admin-ui/src/types/api/models/MonitorTaskResponse.ts index 935f7e450ed..860ade19b28 100644 --- a/clients/admin-ui/src/types/api/models/MonitorTaskResponse.ts +++ b/clients/admin-ui/src/types/api/models/MonitorTaskResponse.ts @@ -1,24 +1,69 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { MonitorTaskType } from "./MonitorTaskType"; +import { ExecutionLogStatus } from "./ExecutionLogStatus"; +import { MonitorTaskType } from "./MonitorTaskType"; /** + * MonitorTaskResponse + * * Response model for monitor tasks */ export type MonitorTaskResponse = { + /** + * Id + */ id: string; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at: string; + /** + * Monitor Config Id + */ monitor_config_id?: string | null; + /** + * Monitor Config Key + */ + monitor_config_key?: string | null; action_type: MonitorTaskType; - status?: string | null; + /** + * Status + */ + status?: ExecutionLogStatus | string | null; + /** + * Message + */ + message?: string | null; + /** + * Celery Id + */ celery_id?: string | null; + /** + * Staged Resource Urns + */ staged_resource_urns?: Array; + /** + * Dismissed + */ dismissed?: boolean | null; + /** + * Monitor Name + */ monitor_name?: string | null; + /** + * Connection Name + */ connection_name?: string | null; + /** + * Connection Type + */ connection_type?: string | null; + /** + * Field Count + */ field_count?: number | null; }; diff --git a/clients/admin-ui/src/types/api/models/MonitorTaskType.ts b/clients/admin-ui/src/types/api/models/MonitorTaskType.ts index e4544f57627..ad7c6adc180 100644 --- a/clients/admin-ui/src/types/api/models/MonitorTaskType.ts +++ b/clients/admin-ui/src/types/api/models/MonitorTaskType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * MonitorTaskType + * * Types of tasks that can be executed by a worker. */ export enum MonitorTaskType { diff --git a/clients/admin-ui/src/types/api/models/MySQLDocsSchema.ts b/clients/admin-ui/src/types/api/models/MySQLDocsSchema.ts index 94af352e091..4ec5a80a00d 100644 --- a/clients/admin-ui/src/types/api/models/MySQLDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/MySQLDocsSchema.ts @@ -1,38 +1,52 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { MySQLSSLMode } from "./MySQLSSLMode"; +import { MySQLSSLMode } from "./MySQLSSLMode"; /** + * MySQLDocsSchema + * * MySQL Secrets Schema for API Docs */ export type MySQLDocsSchema = { /** + * Host + * * The hostname or IP address of the server where the database is running. */ host: string; /** + * Port + * * The network port number on which the server is listening for incoming connections (default: 3306). */ port?: number; /** + * Username + * * The user account used to authenticate and access the database. */ username?: string | null; /** + * Password + * * The password used to authenticate and access the database. */ password?: string | null; /** + * Database + * * The name of the specific database within the database server that you want to connect to. */ dbname: string; /** + * SSH required + * * Indicates whether an SSH tunnel is required for the connection. Enable this option if your MySQL server is behind a firewall and requires SSH tunneling for remote connections. */ ssh_required?: boolean; /** + * SSL Mode + * * The SSL mode to use for the connection. Accepted values are: 'required', 'preferred', 'disabled', or an empty value. */ ssl_mode?: MySQLSSLMode | null; diff --git a/clients/admin-ui/src/types/api/models/MySQLSSLMode.ts b/clients/admin-ui/src/types/api/models/MySQLSSLMode.ts index fcabcb641aa..63cd96e49ba 100644 --- a/clients/admin-ui/src/types/api/models/MySQLSSLMode.ts +++ b/clients/admin-ui/src/types/api/models/MySQLSSLMode.ts @@ -1,9 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * MySQLSSLMode + */ export enum MySQLSSLMode { PREFERRED = "preferred", REQUIRED = "required", DISABLED = "disabled", + "" = "", } diff --git a/clients/admin-ui/src/types/api/models/NestedFieldDict.ts b/clients/admin-ui/src/types/api/models/NestedFieldDict.ts new file mode 100644 index 00000000000..060446699de --- /dev/null +++ b/clients/admin-ui/src/types/api/models/NestedFieldDict.ts @@ -0,0 +1,15 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { PrivacyRequestFieldDefinition } from "./PrivacyRequestFieldDefinition"; + +/** + * NestedFieldDict + * + * Recursive model for nested field dictionaries. + * + * Each value can be either a PrivacyRequestFieldDefinition (leaf) or another + * NestedFieldDict (branch), allowing arbitrary nesting depth. + */ +export type NestedFieldDict = { + [key: string]: PrivacyRequestFieldDefinition | NestedFieldDict; +}; diff --git a/clients/admin-ui/src/types/api/models/NoticeTranslation.ts b/clients/admin-ui/src/types/api/models/NoticeTranslation.ts index 38c98f00153..5b93fe04863 100644 --- a/clients/admin-ui/src/types/api/models/NoticeTranslation.ts +++ b/clients/admin-ui/src/types/api/models/NoticeTranslation.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { SupportedLanguage } from "./SupportedLanguage"; +import { SupportedLanguage } from "./SupportedLanguage"; /** + * NoticeTranslation + * * Notice Translation Schema */ export type NoticeTranslation = { language: SupportedLanguage; + /** + * Title + */ title?: string | null; + /** + * Description + */ description?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/NoticeTranslationCreate.ts b/clients/admin-ui/src/types/api/models/NoticeTranslationCreate.ts index 8aa3f99c281..8db2e13ad6f 100644 --- a/clients/admin-ui/src/types/api/models/NoticeTranslationCreate.ts +++ b/clients/admin-ui/src/types/api/models/NoticeTranslationCreate.ts @@ -1,15 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { SupportedLanguage } from "./SupportedLanguage"; +import { SupportedLanguage } from "./SupportedLanguage"; /** + * NoticeTranslationCreate + * * Notice Translation Create Schema * Makes title non-optional on create */ export type NoticeTranslationCreate = { language: SupportedLanguage; + /** + * Title + */ title: string; + /** + * Description + */ description?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/NoticeTranslationResponse.ts b/clients/admin-ui/src/types/api/models/NoticeTranslationResponse.ts index c6dbda7d3a3..2e30354d1c3 100644 --- a/clients/admin-ui/src/types/api/models/NoticeTranslationResponse.ts +++ b/clients/admin-ui/src/types/api/models/NoticeTranslationResponse.ts @@ -1,19 +1,27 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { SupportedLanguage } from "./SupportedLanguage"; +import { SupportedLanguage } from "./SupportedLanguage"; /** + * NoticeTranslationResponse + * * Notice Translation Response Schema - adds the historical ID of the notice and translation * * Privacy preferences against Privacy Notices should be saved against the privacy_notice_history_id */ export type NoticeTranslationResponse = { language: SupportedLanguage; + /** + * Title + */ title?: string | null; + /** + * Description + */ description?: string | null; /** + * Privacy Notice History Id + * * The versioned artifact of the translation and its Privacy Notice. Should be supplied when saving privacy preferences. */ privacy_notice_history_id: string; diff --git a/clients/admin-ui/src/types/api/models/NotificationApplicationConfig.ts b/clients/admin-ui/src/types/api/models/NotificationApplicationConfig.ts index 482494d8322..04b2dea7171 100644 --- a/clients/admin-ui/src/types/api/models/NotificationApplicationConfig.ts +++ b/clients/admin-ui/src/types/api/models/NotificationApplicationConfig.ts @@ -1,15 +1,33 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * NotificationApplicationConfig + * * API model - configuration settings for data subject and/or data processor notifications */ export type NotificationApplicationConfig = { + /** + * Send Request Completion Notification + */ send_request_completion_notification?: boolean | null; + /** + * Send Request Receipt Notification + */ send_request_receipt_notification?: boolean | null; + /** + * Send Request Review Notification + */ send_request_review_notification?: boolean | null; + /** + * Notification Service Type + */ notification_service_type?: string | null; + /** + * Enable Property Specific Messaging + */ enable_property_specific_messaging?: boolean | null; + /** + * Privacy Assessments Channel + */ privacy_assessments_channel?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/OAuthConfigSchema.ts b/clients/admin-ui/src/types/api/models/OAuthConfigSchema.ts new file mode 100644 index 00000000000..523559c20c0 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/OAuthConfigSchema.ts @@ -0,0 +1,28 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { OAuthGrantType } from "./OAuthGrantType"; + +/** + * OAuthConfigSchema + * + * Schema for OAuth2 configuration used in API requests + */ +export type OAuthConfigSchema = { + grant_type?: OAuthGrantType | null; + /** + * Token Url + */ + token_url?: string | null; + /** + * Scope + */ + scope?: string | null; + /** + * Client Id + */ + client_id?: string | null; + /** + * Client Secret + */ + client_secret: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/OAuthGrantType.ts b/clients/admin-ui/src/types/api/models/OAuthGrantType.ts new file mode 100644 index 00000000000..d564ac4ad51 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/OAuthGrantType.ts @@ -0,0 +1,10 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * OAuthGrantType + * + * OAuth2 grant types supported by the system + */ +export enum OAuthGrantType { + CLIENT_CREDENTIALS = "client_credentials", +} diff --git a/clients/admin-ui/src/types/api/models/OktaConfig.ts b/clients/admin-ui/src/types/api/models/OktaConfig.ts index b248a87b2d9..c17ba5aa8e1 100644 --- a/clients/admin-ui/src/types/api/models/OktaConfig.ts +++ b/clients/admin-ui/src/types/api/models/OktaConfig.ts @@ -1,13 +1,25 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** - * The model for the connection config for Okta (OAuth2) + * OktaConfig + * + * The model for the connection config for Okta using OAuth2. */ export type OktaConfig = { + /** + * Orgurl + */ orgUrl: string; + /** + * Clientid + */ clientId: string; + /** + * Privatekey + */ privateKey: string; - scopes?: Array; + /** + * Scopes + */ + scopes?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/OktaDocsSchema.ts b/clients/admin-ui/src/types/api/models/OktaDocsSchema.ts index 3f6a91218d9..d1e2d9dd82e 100644 --- a/clients/admin-ui/src/types/api/models/OktaDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/OktaDocsSchema.ts @@ -1,21 +1,33 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * OktaDocsSchema + * * Okta Secrets Schema for API Docs */ export type OktaDocsSchema = { /** + * Organization URL + * * The URL of your Okta organization (e.g. https://your-org.okta.com) */ org_url: string; /** - * The API token used to authenticate with Okta + * OAuth2 Client ID + * + * The OAuth2 client ID from your Okta service application */ - api_token?: string; + client_id: string; /** - * The API token used to authenticate with Okta + * Private Key + * + * RSA private key in JWK (JSON) format for signing JWT assertions. Download from Okta: Applications > Your App > Sign On > Client Credentials > Edit > Generate new key. */ - access_token: string; + private_key: string; + /** + * OAuth2 Scopes + * + * OAuth2 scopes to request (default: okta.apps.read) + */ + scopes?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/OktaMonitorConfig.ts b/clients/admin-ui/src/types/api/models/OktaMonitorConfig.ts new file mode 100644 index 00000000000..7910bf83f0d --- /dev/null +++ b/clients/admin-ui/src/types/api/models/OktaMonitorConfig.ts @@ -0,0 +1,42 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * OktaMonitorConfig + * + * Okta (Identity Provider) monitor configuration. + * + * Simplified seed input for creating an Okta discovery monitor. + * See also: IdentityProviderMonitorConfig, EditableMonitorConfig. + */ +export type OktaMonitorConfig = { + /** + * Org Url + * + * Okta organization URL (e.g. https://dev-12345.okta.com) + */ + org_url: string; + /** + * Client Id + * + * Okta OAuth2 client ID + */ + client_id: string; + /** + * Private Key + * + * Okta private key (PEM or JSON) + */ + private_key: string; + /** + * Name + * + * Monitor name + */ + name?: string; + /** + * Execute After Creation + * + * Execute the monitor after creation + */ + execute_after_creation?: boolean; +}; diff --git a/clients/admin-ui/src/types/api/models/OpenIDProvider.ts b/clients/admin-ui/src/types/api/models/OpenIDProvider.ts index b62b2108127..170a570ebf4 100644 --- a/clients/admin-ui/src/types/api/models/OpenIDProvider.ts +++ b/clients/admin-ui/src/types/api/models/OpenIDProvider.ts @@ -1,25 +1,64 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ProviderEnum } from "./ProviderEnum"; +import { ProviderEnum } from "./ProviderEnum"; /** + * OpenIDProvider + * * Complete schema, does NOT include sensitive values. */ export type OpenIDProvider = { + /** + * Identifier + */ identifier: string; + /** + * Name + */ name: string; provider: ProviderEnum; + /** + * Authorization Url + */ authorization_url?: string | null; + /** + * Token Url + */ token_url?: string | null; + /** + * User Info Url + */ user_info_url?: string | null; + /** + * Domain + */ domain?: string | null; + /** + * Scopes + */ scopes?: Array | null; + /** + * Email Field + */ email_field?: string | null; + /** + * Verify Email + */ verify_email?: boolean | null; + /** + * Verify Email Field + */ verify_email_field?: string | null; + /** + * Id + */ id: string; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at: string; }; diff --git a/clients/admin-ui/src/types/api/models/OpenIDProviderCreate.ts b/clients/admin-ui/src/types/api/models/OpenIDProviderCreate.ts index 5cd833bcf42..24d9637f341 100644 --- a/clients/admin-ui/src/types/api/models/OpenIDProviderCreate.ts +++ b/clients/admin-ui/src/types/api/models/OpenIDProviderCreate.ts @@ -1,24 +1,60 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ProviderEnum } from "./ProviderEnum"; +import { ProviderEnum } from "./ProviderEnum"; /** + * OpenIDProviderCreate + * * Schema for creating an OpenIDProvider, including sensitive values client ID and secret. */ export type OpenIDProviderCreate = { + /** + * Identifier + */ identifier: string; + /** + * Name + */ name: string; provider: ProviderEnum; + /** + * Authorization Url + */ authorization_url?: string | null; + /** + * Token Url + */ token_url?: string | null; + /** + * User Info Url + */ user_info_url?: string | null; + /** + * Domain + */ domain?: string | null; + /** + * Scopes + */ scopes?: Array | null; + /** + * Email Field + */ email_field?: string | null; + /** + * Verify Email + */ verify_email?: boolean | null; + /** + * Verify Email Field + */ verify_email_field?: string | null; + /** + * Client Id + */ client_id: string; + /** + * Client Secret + */ client_secret: string; }; diff --git a/clients/admin-ui/src/types/api/models/OpenIDProviderSimple.ts b/clients/admin-ui/src/types/api/models/OpenIDProviderSimple.ts index 5095f92d9e4..0fd7515551a 100644 --- a/clients/admin-ui/src/types/api/models/OpenIDProviderSimple.ts +++ b/clients/admin-ui/src/types/api/models/OpenIDProviderSimple.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ProviderEnum } from "./ProviderEnum"; +import { ProviderEnum } from "./ProviderEnum"; /** + * OpenIDProviderSimple + * * Simple schema display providers in the login page. */ export type OpenIDProviderSimple = { + /** + * Name + */ name: string; + /** + * Identifier + */ identifier: string; provider: ProviderEnum; }; diff --git a/clients/admin-ui/src/types/api/models/Operator.ts b/clients/admin-ui/src/types/api/models/Operator.ts index 9731453bdd5..4f7ca295d7b 100644 --- a/clients/admin-ui/src/types/api/models/Operator.ts +++ b/clients/admin-ui/src/types/api/models/Operator.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * Operator + */ export enum Operator { EQ = "eq", NEQ = "neq", diff --git a/clients/admin-ui/src/types/api/models/OptionalStagedResourcesRequest.ts b/clients/admin-ui/src/types/api/models/OptionalStagedResourcesRequest.ts new file mode 100644 index 00000000000..bcf74425de1 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/OptionalStagedResourcesRequest.ts @@ -0,0 +1,15 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * OptionalStagedResourcesRequest + * + * Optional request model for bulk operations on staged resources. + */ +export type OptionalStagedResourcesRequest = { + /** + * Staged Resource Urns + * + * List of staged resource URNs to act on + */ + staged_resource_urns?: Array | null; +}; diff --git a/clients/admin-ui/src/types/api/models/Organization.ts b/clients/admin-ui/src/types/api/models/Organization.ts index 8b46e1d3202..62988f40af7 100644 --- a/clients/admin-ui/src/types/api/models/Organization.ts +++ b/clients/admin-ui/src/types/api/models/Organization.ts @@ -1,34 +1,47 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ContactDetails } from "./ContactDetails"; import type { OrganizationMetadata } from "./OrganizationMetadata"; /** + * Organization + * * The Organization resource model. * * This resource is used as a way to organize all other resources. */ export type Organization = { /** + * Fides Key + * * A unique key used to identify this resource. */ fides_key: string; /** + * Organization Fides Key + * * Defines the Organization that this resource belongs to. */ organization_fides_key?: string; + /** + * Tags + */ tags?: Array | null; /** + * Name + * * Human-Readable name for this resource. */ name?: string | null; /** + * Description + * * A detailed description of what this resource is. */ description?: string | null; /** + * Organization Parent Key + * * An inherited field from the FidesModel that is unused with an Organization. */ organization_parent_key?: null; @@ -77,6 +90,8 @@ export type Organization = { */ representative?: ContactDetails | null; /** + * Security Policy + * * Am optional URL to the organization security policy. */ security_policy?: string | null; diff --git a/clients/admin-ui/src/types/api/models/OrganizationMetadata.ts b/clients/admin-ui/src/types/api/models/OrganizationMetadata.ts index 6168d114c6e..129bae3ad26 100644 --- a/clients/admin-ui/src/types/api/models/OrganizationMetadata.ts +++ b/clients/admin-ui/src/types/api/models/OrganizationMetadata.ts @@ -1,16 +1,18 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ResourceFilter } from "./ResourceFilter"; /** + * OrganizationMetadata + * * The OrganizationMetadata resource model. * * Object used to hold application specific metadata for an organization */ export type OrganizationMetadata = { /** + * Resource Filters + * * A list of filters that can be used when generating or scanning systems. */ resource_filters?: Array | null; diff --git a/clients/admin-ui/src/types/api/models/OverrideMode.ts b/clients/admin-ui/src/types/api/models/OverrideMode.ts deleted file mode 100644 index de0d422ae33..00000000000 --- a/clients/admin-ui/src/types/api/models/OverrideMode.ts +++ /dev/null @@ -1,12 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -/** - * Mode for overriding preferences. - */ -export enum OverrideMode { - ANCESTORS = "ancestors", - DESCENDANTS = "descendants", - ALL = "all", -} diff --git a/clients/admin-ui/src/types/api/models/Page_AssessmentResponse_.ts b/clients/admin-ui/src/types/api/models/Page_AssessmentResponse_.ts index cf47c6fa9f7..1da29c64b04 100644 --- a/clients/admin-ui/src/types/api/models/Page_AssessmentResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_AssessmentResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { AssessmentResponse } from "./AssessmentResponse"; +/** + * Page[AssessmentResponse] + */ export type Page_AssessmentResponse_ = { + /** + * Items + */ items: Array; + /** + * Total + */ total: number; + /** + * Page + */ page: number; + /** + * Size + */ size: number; + /** + * Pages + */ pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_AssessmentTaskResponse_.ts b/clients/admin-ui/src/types/api/models/Page_AssessmentTaskResponse_.ts new file mode 100644 index 00000000000..a4fcd497aed --- /dev/null +++ b/clients/admin-ui/src/types/api/models/Page_AssessmentTaskResponse_.ts @@ -0,0 +1,29 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { AssessmentTaskResponse } from "./AssessmentTaskResponse"; + +/** + * Page[AssessmentTaskResponse] + */ +export type Page_AssessmentTaskResponse_ = { + /** + * Items + */ + items: Array; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; +}; diff --git a/clients/admin-ui/src/types/api/models/Page_Asset_.ts b/clients/admin-ui/src/types/api/models/Page_Asset_.ts index 6b9119e7ff2..6ece57aa03c 100644 --- a/clients/admin-ui/src/types/api/models/Page_Asset_.ts +++ b/clients/admin-ui/src/types/api/models/Page_Asset_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { Asset } from "./Asset"; +/** + * Page[Asset] + */ export type Page_Asset_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_AttachmentResponse_.ts b/clients/admin-ui/src/types/api/models/Page_AttachmentResponse_.ts index 119f53df763..ade353d6a65 100644 --- a/clients/admin-ui/src/types/api/models/Page_AttachmentResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_AttachmentResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { AttachmentResponse } from "./AttachmentResponse"; +/** + * Page[AttachmentResponse] + */ export type Page_AttachmentResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_BasicSystemResponseExtended_.ts b/clients/admin-ui/src/types/api/models/Page_BasicSystemResponseExtended_.ts index a28c7f9626c..b77fd01b969 100644 --- a/clients/admin-ui/src/types/api/models/Page_BasicSystemResponseExtended_.ts +++ b/clients/admin-ui/src/types/api/models/Page_BasicSystemResponseExtended_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { BasicSystemResponseExtended } from "./BasicSystemResponseExtended"; +/** + * Page[BasicSystemResponseExtended] + */ export type Page_BasicSystemResponseExtended_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_ClassificationBenchmarkSummary_.ts b/clients/admin-ui/src/types/api/models/Page_ClassificationBenchmarkSummary_.ts new file mode 100644 index 00000000000..cca36b847f2 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/Page_ClassificationBenchmarkSummary_.ts @@ -0,0 +1,29 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { ClassificationBenchmarkSummary } from "./ClassificationBenchmarkSummary"; + +/** + * Page[ClassificationBenchmarkSummary] + */ +export type Page_ClassificationBenchmarkSummary_ = { + /** + * Items + */ + items: Array; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; +}; diff --git a/clients/admin-ui/src/types/api/models/Page_ClassifyInstanceResponseValues_.ts b/clients/admin-ui/src/types/api/models/Page_ClassifyInstanceResponseValues_.ts index a1e0b0caad8..8b45a1ec0b4 100644 --- a/clients/admin-ui/src/types/api/models/Page_ClassifyInstanceResponseValues_.ts +++ b/clients/admin-ui/src/types/api/models/Page_ClassifyInstanceResponseValues_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ClassifyInstanceResponseValues } from "./ClassifyInstanceResponseValues"; +/** + * Page[ClassifyInstanceResponseValues] + */ export type Page_ClassifyInstanceResponseValues_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_CommentResponse_.ts b/clients/admin-ui/src/types/api/models/Page_CommentResponse_.ts index 2e5207fd995..803471baf34 100644 --- a/clients/admin-ui/src/types/api/models/Page_CommentResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_CommentResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { CommentResponse } from "./CommentResponse"; +/** + * Page[CommentResponse] + */ export type Page_CommentResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_ConnectionConfigurationResponse_.ts b/clients/admin-ui/src/types/api/models/Page_ConnectionConfigurationResponse_.ts index 9c48b66d483..31eae42fb29 100644 --- a/clients/admin-ui/src/types/api/models/Page_ConnectionConfigurationResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_ConnectionConfigurationResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConnectionConfigurationResponse } from "./ConnectionConfigurationResponse"; +/** + * Page[ConnectionConfigurationResponse] + */ export type Page_ConnectionConfigurationResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_ConnectionSystemTypeMap_.ts b/clients/admin-ui/src/types/api/models/Page_ConnectionSystemTypeMap_.ts index 7ac0b844827..794255f9422 100644 --- a/clients/admin-ui/src/types/api/models/Page_ConnectionSystemTypeMap_.ts +++ b/clients/admin-ui/src/types/api/models/Page_ConnectionSystemTypeMap_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConnectionSystemTypeMap } from "./ConnectionSystemTypeMap"; +/** + * Page[ConnectionSystemTypeMap] + */ export type Page_ConnectionSystemTypeMap_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_ConsentBreakdown_.ts b/clients/admin-ui/src/types/api/models/Page_ConsentBreakdown_.ts index 9004c79b17f..0292fdb8b6e 100644 --- a/clients/admin-ui/src/types/api/models/Page_ConsentBreakdown_.ts +++ b/clients/admin-ui/src/types/api/models/Page_ConsentBreakdown_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConsentBreakdown } from "./ConsentBreakdown"; +/** + * Page[ConsentBreakdown] + */ export type Page_ConsentBreakdown_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_ConsentReport_.ts b/clients/admin-ui/src/types/api/models/Page_ConsentReport_.ts index 251ca7badc4..b550c117914 100644 --- a/clients/admin-ui/src/types/api/models/Page_ConsentReport_.ts +++ b/clients/admin-ui/src/types/api/models/Page_ConsentReport_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConsentReport } from "./ConsentReport"; +/** + * Page[ConsentReport] + */ export type Page_ConsentReport_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_ConsentReportingSchema_.ts b/clients/admin-ui/src/types/api/models/Page_ConsentReportingSchema_.ts deleted file mode 100644 index 3d586896383..00000000000 --- a/clients/admin-ui/src/types/api/models/Page_ConsentReportingSchema_.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { ConsentReportingSchema } from "./ConsentReportingSchema"; - -export type Page_ConsentReportingSchema_ = { - items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; -}; diff --git a/clients/admin-ui/src/types/api/models/Page_CustomReportResponseMinimal_.ts b/clients/admin-ui/src/types/api/models/Page_CustomReportResponseMinimal_.ts index 7f05615f2d2..6ba1bfd4ab0 100644 --- a/clients/admin-ui/src/types/api/models/Page_CustomReportResponseMinimal_.ts +++ b/clients/admin-ui/src/types/api/models/Page_CustomReportResponseMinimal_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { CustomReportResponseMinimal } from "./CustomReportResponseMinimal"; +/** + * Page[CustomReportResponseMinimal] + */ export type Page_CustomReportResponseMinimal_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_CustomReportResponse_.ts b/clients/admin-ui/src/types/api/models/Page_CustomReportResponse_.ts index c526fc060c0..4abec969b56 100644 --- a/clients/admin-ui/src/types/api/models/Page_CustomReportResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_CustomReportResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { CustomReportResponse } from "./CustomReportResponse"; +/** + * Page[CustomReportResponse] + */ export type Page_CustomReportResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_DatamapReport_.ts b/clients/admin-ui/src/types/api/models/Page_DatamapReport_.ts index bdff5edbe3f..7f1c3413b56 100644 --- a/clients/admin-ui/src/types/api/models/Page_DatamapReport_.ts +++ b/clients/admin-ui/src/types/api/models/Page_DatamapReport_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { DatamapReport } from "./DatamapReport"; +/** + * Page[DatamapReport] + */ export type Page_DatamapReport_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_DatasetConfigSchema_.ts b/clients/admin-ui/src/types/api/models/Page_DatasetConfigSchema_.ts index 23a2e34e01a..0732f4cfd10 100644 --- a/clients/admin-ui/src/types/api/models/Page_DatasetConfigSchema_.ts +++ b/clients/admin-ui/src/types/api/models/Page_DatasetConfigSchema_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { DatasetConfigSchema } from "./DatasetConfigSchema"; +/** + * Page[DatasetConfigSchema] + */ export type Page_DatasetConfigSchema_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_DatasetResponse_.ts b/clients/admin-ui/src/types/api/models/Page_DatasetResponse_.ts index 3a2abee75e9..79cf059bc38 100644 --- a/clients/admin-ui/src/types/api/models/Page_DatasetResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_DatasetResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { DatasetResponse } from "./DatasetResponse"; +/** + * Page[DatasetResponse] + */ export type Page_DatasetResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_Dataset_.ts b/clients/admin-ui/src/types/api/models/Page_Dataset_.ts index a707f22aced..3e5d480f4b6 100644 --- a/clients/admin-ui/src/types/api/models/Page_Dataset_.ts +++ b/clients/admin-ui/src/types/api/models/Page_Dataset_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { Dataset } from "./Dataset"; +/** + * Page[Dataset] + */ export type Page_Dataset_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_DatastoreStagedResourceAPIResponse_.ts b/clients/admin-ui/src/types/api/models/Page_DatastoreStagedResourceAPIResponse_.ts index d70294c56dd..fe7d45b9022 100644 --- a/clients/admin-ui/src/types/api/models/Page_DatastoreStagedResourceAPIResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_DatastoreStagedResourceAPIResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { DatastoreStagedResourceAPIResponse } from "./DatastoreStagedResourceAPIResponse"; +/** + * Page[DatastoreStagedResourceAPIResponse] + */ export type Page_DatastoreStagedResourceAPIResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_DatastoreStagedResourceTreeAPIResponse_.ts b/clients/admin-ui/src/types/api/models/Page_DatastoreStagedResourceTreeAPIResponse_.ts deleted file mode 100644 index acb801e702f..00000000000 --- a/clients/admin-ui/src/types/api/models/Page_DatastoreStagedResourceTreeAPIResponse_.ts +++ /dev/null @@ -1,13 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { DatastoreStagedResourceTreeAPIResponse } from "./DatastoreStagedResourceTreeAPIResponse"; - -export type Page_DatastoreStagedResourceTreeAPIResponse_ = { - items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; -}; diff --git a/clients/admin-ui/src/types/api/models/Page_DigestConfigResponse_.ts b/clients/admin-ui/src/types/api/models/Page_DigestConfigResponse_.ts new file mode 100644 index 00000000000..5435f9f6a8a --- /dev/null +++ b/clients/admin-ui/src/types/api/models/Page_DigestConfigResponse_.ts @@ -0,0 +1,29 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { DigestConfigResponse } from "./DigestConfigResponse"; + +/** + * Page[DigestConfigResponse] + */ +export type Page_DigestConfigResponse_ = { + /** + * Items + */ + items: Array; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; +}; diff --git a/clients/admin-ui/src/types/api/models/Page_EventAuditResponse_.ts b/clients/admin-ui/src/types/api/models/Page_EventAuditResponse_.ts index 84e2901d627..28e994af3aa 100644 --- a/clients/admin-ui/src/types/api/models/Page_EventAuditResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_EventAuditResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { EventAuditResponse } from "./EventAuditResponse"; +/** + * Page[EventAuditResponse] + */ export type Page_EventAuditResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_ExecutionLogDetailResponse_.ts b/clients/admin-ui/src/types/api/models/Page_ExecutionLogDetailResponse_.ts index 6cefd0161f1..bacf10cc659 100644 --- a/clients/admin-ui/src/types/api/models/Page_ExecutionLogDetailResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_ExecutionLogDetailResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ExecutionLogDetailResponse } from "./ExecutionLogDetailResponse"; +/** + * Page[ExecutionLogDetailResponse] + */ export type Page_ExecutionLogDetailResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_ExperienceConfigListViewResponse_.ts b/clients/admin-ui/src/types/api/models/Page_ExperienceConfigListViewResponse_.ts index a0b11c441d9..a62188feb1e 100644 --- a/clients/admin-ui/src/types/api/models/Page_ExperienceConfigListViewResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_ExperienceConfigListViewResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ExperienceConfigListViewResponse } from "./ExperienceConfigListViewResponse"; +/** + * Page[ExperienceConfigListViewResponse] + */ export type Page_ExperienceConfigListViewResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_FieldAccuracyDetail_.ts b/clients/admin-ui/src/types/api/models/Page_FieldAccuracyDetail_.ts new file mode 100644 index 00000000000..c49a8b70650 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/Page_FieldAccuracyDetail_.ts @@ -0,0 +1,29 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { FieldAccuracyDetail } from "./FieldAccuracyDetail"; + +/** + * Page[FieldAccuracyDetail] + */ +export type Page_FieldAccuracyDetail_ = { + /** + * Items + */ + items: Array; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; +}; diff --git a/clients/admin-ui/src/types/api/models/Page_Language_.ts b/clients/admin-ui/src/types/api/models/Page_Language_.ts index 26b528acc56..15251735ca7 100644 --- a/clients/admin-ui/src/types/api/models/Page_Language_.ts +++ b/clients/admin-ui/src/types/api/models/Page_Language_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { Language } from "./Language"; +/** + * Page[Language] + */ export type Page_Language_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_LimitedPrivacyNoticeResponseSchema_.ts b/clients/admin-ui/src/types/api/models/Page_LimitedPrivacyNoticeResponseSchema_.ts index 4b181a4a4e5..5b4a311ed76 100644 --- a/clients/admin-ui/src/types/api/models/Page_LimitedPrivacyNoticeResponseSchema_.ts +++ b/clients/admin-ui/src/types/api/models/Page_LimitedPrivacyNoticeResponseSchema_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { LimitedPrivacyNoticeResponseSchema } from "./LimitedPrivacyNoticeResponseSchema"; +/** + * Page[LimitedPrivacyNoticeResponseSchema] + */ export type Page_LimitedPrivacyNoticeResponseSchema_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_ManualTaskConfigResponse_.ts b/clients/admin-ui/src/types/api/models/Page_ManualTaskConfigResponse_.ts index de59d310122..de247b4959b 100644 --- a/clients/admin-ui/src/types/api/models/Page_ManualTaskConfigResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_ManualTaskConfigResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ManualTaskConfigResponse } from "./ManualTaskConfigResponse"; +/** + * Page[ManualTaskConfigResponse] + */ export type Page_ManualTaskConfigResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_ManualTaskResponse_.ts b/clients/admin-ui/src/types/api/models/Page_ManualTaskResponse_.ts index c4860160568..91d7bfa7359 100644 --- a/clients/admin-ui/src/types/api/models/Page_ManualTaskResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_ManualTaskResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ManualTaskResponse } from "./ManualTaskResponse"; +/** + * Page[ManualTaskResponse] + */ export type Page_ManualTaskResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_MessagingConfigResponse_.ts b/clients/admin-ui/src/types/api/models/Page_MessagingConfigResponse_.ts index 5e28aa20ae7..33636f10beb 100644 --- a/clients/admin-ui/src/types/api/models/Page_MessagingConfigResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_MessagingConfigResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { MessagingConfigResponse } from "./MessagingConfigResponse"; +/** + * Page[MessagingConfigResponse] + */ export type Page_MessagingConfigResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_MessagingTemplateWithPropertiesSummary_.ts b/clients/admin-ui/src/types/api/models/Page_MessagingTemplateWithPropertiesSummary_.ts index 97cd85967f1..be64db915f2 100644 --- a/clients/admin-ui/src/types/api/models/Page_MessagingTemplateWithPropertiesSummary_.ts +++ b/clients/admin-ui/src/types/api/models/Page_MessagingTemplateWithPropertiesSummary_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { MessagingTemplateWithPropertiesSummary } from "./MessagingTemplateWithPropertiesSummary"; +/** + * Page[MessagingTemplateWithPropertiesSummary] + */ export type Page_MessagingTemplateWithPropertiesSummary_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_MonitorConfigStagedResourcesAggregateRecord_.ts b/clients/admin-ui/src/types/api/models/Page_MonitorConfigStagedResourcesAggregateRecord_.ts index c218cf358e2..35eb394d0c5 100644 --- a/clients/admin-ui/src/types/api/models/Page_MonitorConfigStagedResourcesAggregateRecord_.ts +++ b/clients/admin-ui/src/types/api/models/Page_MonitorConfigStagedResourcesAggregateRecord_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { MonitorConfigStagedResourcesAggregateRecord } from "./MonitorConfigStagedResourcesAggregateRecord"; +/** + * Page[MonitorConfigStagedResourcesAggregateRecord] + */ export type Page_MonitorConfigStagedResourcesAggregateRecord_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_MonitorExecution_.ts b/clients/admin-ui/src/types/api/models/Page_MonitorExecution_.ts index 186a68953d0..a6ba36e6c36 100644 --- a/clients/admin-ui/src/types/api/models/Page_MonitorExecution_.ts +++ b/clients/admin-ui/src/types/api/models/Page_MonitorExecution_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { MonitorExecution } from "./MonitorExecution"; +/** + * Page[MonitorExecution] + */ export type Page_MonitorExecution_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_MonitorStatusResponse_.ts b/clients/admin-ui/src/types/api/models/Page_MonitorStatusResponse_.ts index a8d057f4c11..e97d154df59 100644 --- a/clients/admin-ui/src/types/api/models/Page_MonitorStatusResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_MonitorStatusResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { MonitorStatusResponse } from "./MonitorStatusResponse"; +/** + * Page[MonitorStatusResponse] + */ export type Page_MonitorStatusResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_MonitorTaskResponse_.ts b/clients/admin-ui/src/types/api/models/Page_MonitorTaskResponse_.ts index 1a7bbe48936..dc3913580bb 100644 --- a/clients/admin-ui/src/types/api/models/Page_MonitorTaskResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_MonitorTaskResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { MonitorTaskResponse } from "./MonitorTaskResponse"; +/** + * Page[MonitorTaskResponse] + */ export type Page_MonitorTaskResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_PolicyResponse_.ts b/clients/admin-ui/src/types/api/models/Page_PolicyResponse_.ts index 175ca9ae52a..fa459d85ef6 100644 --- a/clients/admin-ui/src/types/api/models/Page_PolicyResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_PolicyResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { PolicyResponse } from "./PolicyResponse"; +/** + * Page[PolicyResponse] + */ export type Page_PolicyResponse_ = { + /** + * Items + */ items: Array; + /** + * Total + */ total: number; + /** + * Page + */ page: number; + /** + * Size + */ size: number; + /** + * Pages + */ pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_PolicyWebhookResponse_.ts b/clients/admin-ui/src/types/api/models/Page_PolicyWebhookResponse_.ts index 52f3ecf9642..387a1d48bd5 100644 --- a/clients/admin-ui/src/types/api/models/Page_PolicyWebhookResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_PolicyWebhookResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { PolicyWebhookResponse } from "./PolicyWebhookResponse"; +/** + * Page[PolicyWebhookResponse] + */ export type Page_PolicyWebhookResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_PreApprovalWebhookResponse_.ts b/clients/admin-ui/src/types/api/models/Page_PreApprovalWebhookResponse_.ts index 294bfc3c261..ae24ef945ad 100644 --- a/clients/admin-ui/src/types/api/models/Page_PreApprovalWebhookResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_PreApprovalWebhookResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { PreApprovalWebhookResponse } from "./PreApprovalWebhookResponse"; +/** + * Page[PreApprovalWebhookResponse] + */ export type Page_PreApprovalWebhookResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_PrivacyExperienceMetaResponse_.ts b/clients/admin-ui/src/types/api/models/Page_PrivacyExperienceMetaResponse_.ts index 0d24acd7071..d2536b8016a 100644 --- a/clients/admin-ui/src/types/api/models/Page_PrivacyExperienceMetaResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_PrivacyExperienceMetaResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { PrivacyExperienceMetaResponse } from "./PrivacyExperienceMetaResponse"; +/** + * Page[PrivacyExperienceMetaResponse] + */ export type Page_PrivacyExperienceMetaResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_Property_.ts b/clients/admin-ui/src/types/api/models/Page_Property_.ts index df6df75e2fe..f68867e8ff1 100644 --- a/clients/admin-ui/src/types/api/models/Page_Property_.ts +++ b/clients/admin-ui/src/types/api/models/Page_Property_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { Property } from "./Property"; +/** + * Page[Property] + */ export type Page_Property_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_RuleResponseWithTargets_.ts b/clients/admin-ui/src/types/api/models/Page_RuleResponseWithTargets_.ts index 992cd61b77e..1366a32ffcb 100644 --- a/clients/admin-ui/src/types/api/models/Page_RuleResponseWithTargets_.ts +++ b/clients/admin-ui/src/types/api/models/Page_RuleResponseWithTargets_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { RuleResponseWithTargets } from "./RuleResponseWithTargets"; +/** + * Page[RuleResponseWithTargets] + */ export type Page_RuleResponseWithTargets_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_RuleTarget_.ts b/clients/admin-ui/src/types/api/models/Page_RuleTarget_.ts index e53db526ecd..2a95ac3c0df 100644 --- a/clients/admin-ui/src/types/api/models/Page_RuleTarget_.ts +++ b/clients/admin-ui/src/types/api/models/Page_RuleTarget_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { RuleTarget } from "./RuleTarget"; +/** + * Page[RuleTarget] + */ export type Page_RuleTarget_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_SharedMonitorConfig_.ts b/clients/admin-ui/src/types/api/models/Page_SharedMonitorConfig_.ts index 492c980598b..589778f1fb7 100644 --- a/clients/admin-ui/src/types/api/models/Page_SharedMonitorConfig_.ts +++ b/clients/admin-ui/src/types/api/models/Page_SharedMonitorConfig_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { SharedMonitorConfig } from "./SharedMonitorConfig"; +/** + * Page[SharedMonitorConfig] + */ export type Page_SharedMonitorConfig_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_StagedResourceAPIResponse_.ts b/clients/admin-ui/src/types/api/models/Page_StagedResourceAPIResponse_.ts index 0c164900b92..6c4ae94cd0d 100644 --- a/clients/admin-ui/src/types/api/models/Page_StagedResourceAPIResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_StagedResourceAPIResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { StagedResourceAPIResponse } from "./StagedResourceAPIResponse"; +/** + * Page[StagedResourceAPIResponse] + */ export type Page_StagedResourceAPIResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_StorageDestinationResponse_.ts b/clients/admin-ui/src/types/api/models/Page_StorageDestinationResponse_.ts index 4692691cd6b..8127e670fe3 100644 --- a/clients/admin-ui/src/types/api/models/Page_StorageDestinationResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_StorageDestinationResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { StorageDestinationResponse } from "./StorageDestinationResponse"; +/** + * Page[StorageDestinationResponse] + */ export type Page_StorageDestinationResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_SystemHistoryResponse_.ts b/clients/admin-ui/src/types/api/models/Page_SystemHistoryResponse_.ts index 163d78e5d88..7607e581cc0 100644 --- a/clients/admin-ui/src/types/api/models/Page_SystemHistoryResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_SystemHistoryResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { SystemHistoryResponse } from "./SystemHistoryResponse"; +/** + * Page[SystemHistoryResponse] + */ export type Page_SystemHistoryResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_SystemStagedResourcesAggregateRecord_.ts b/clients/admin-ui/src/types/api/models/Page_SystemStagedResourcesAggregateRecord_.ts index d6bee2b9324..777f7fa4d19 100644 --- a/clients/admin-ui/src/types/api/models/Page_SystemStagedResourcesAggregateRecord_.ts +++ b/clients/admin-ui/src/types/api/models/Page_SystemStagedResourcesAggregateRecord_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { SystemStagedResourcesAggregateRecord } from "./SystemStagedResourcesAggregateRecord"; +/** + * Page[SystemStagedResourcesAggregateRecord] + */ export type Page_SystemStagedResourcesAggregateRecord_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_SystemSummary_.ts b/clients/admin-ui/src/types/api/models/Page_SystemSummary_.ts index 951449f6781..9b84e98bb94 100644 --- a/clients/admin-ui/src/types/api/models/Page_SystemSummary_.ts +++ b/clients/admin-ui/src/types/api/models/Page_SystemSummary_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { SystemSummary } from "./SystemSummary"; +/** + * Page[SystemSummary] + */ export type Page_SystemSummary_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_SystemWithMonitorKeys_.ts b/clients/admin-ui/src/types/api/models/Page_SystemWithMonitorKeys_.ts index e922a65fa67..6f35cf0d15b 100644 --- a/clients/admin-ui/src/types/api/models/Page_SystemWithMonitorKeys_.ts +++ b/clients/admin-ui/src/types/api/models/Page_SystemWithMonitorKeys_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { SystemWithMonitorKeys } from "./SystemWithMonitorKeys"; +/** + * Page[SystemWithMonitorKeys] + */ export type Page_SystemWithMonitorKeys_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_TCFConfigurationResponse_.ts b/clients/admin-ui/src/types/api/models/Page_TCFConfigurationResponse_.ts index 0426a74c8db..ff7fcf7963e 100644 --- a/clients/admin-ui/src/types/api/models/Page_TCFConfigurationResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_TCFConfigurationResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { TCFConfigurationResponse } from "./TCFConfigurationResponse"; +/** + * Page[TCFConfigurationResponse] + */ export type Page_TCFConfigurationResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_TCFPublisherRestrictionResponse_.ts b/clients/admin-ui/src/types/api/models/Page_TCFPublisherRestrictionResponse_.ts index bd212d75eb3..65624671823 100644 --- a/clients/admin-ui/src/types/api/models/Page_TCFPublisherRestrictionResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_TCFPublisherRestrictionResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRestrictionResponse } from "./fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRestrictionResponse"; +/** + * Page[TCFPublisherRestrictionResponse] + */ export type Page_TCFPublisherRestrictionResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_TemplateResponse_.ts b/clients/admin-ui/src/types/api/models/Page_TemplateResponse_.ts index 8587b060882..ad815c95c32 100644 --- a/clients/admin-ui/src/types/api/models/Page_TemplateResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_TemplateResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { TemplateResponse } from "./TemplateResponse"; +/** + * Page[TemplateResponse] + */ export type Page_TemplateResponse_ = { + /** + * Items + */ items: Array; + /** + * Total + */ total: number; + /** + * Page + */ page: number; + /** + * Size + */ size: number; + /** + * Pages + */ pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_Union_PrivacyExperienceResponse__TCFBannerExperienceMinimalResponse__.ts b/clients/admin-ui/src/types/api/models/Page_Union_PrivacyExperienceResponse__TCFBannerExperienceMinimalResponse__.ts index 6b459d8ff0e..5ffeef09e32 100644 --- a/clients/admin-ui/src/types/api/models/Page_Union_PrivacyExperienceResponse__TCFBannerExperienceMinimalResponse__.ts +++ b/clients/admin-ui/src/types/api/models/Page_Union_PrivacyExperienceResponse__TCFBannerExperienceMinimalResponse__.ts @@ -1,17 +1,33 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { PrivacyExperienceResponse } from "./PrivacyExperienceResponse"; import type { TCFBannerExperienceMinimalResponse } from "./TCFBannerExperienceMinimalResponse"; +/** + * Page[Union[PrivacyExperienceResponse, TCFBannerExperienceMinimalResponse]] + */ export type Page_Union_PrivacyExperienceResponse__TCFBannerExperienceMinimalResponse__ = { + /** + * Items + */ items: Array< PrivacyExperienceResponse | TCFBannerExperienceMinimalResponse >; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_Union_PrivacyRequestVerboseResponse__PrivacyRequestResponse__.ts b/clients/admin-ui/src/types/api/models/Page_Union_PrivacyRequestVerboseResponse__PrivacyRequestResponse__.ts index b3c72df7ee5..e5ba5f58604 100644 --- a/clients/admin-ui/src/types/api/models/Page_Union_PrivacyRequestVerboseResponse__PrivacyRequestResponse__.ts +++ b/clients/admin-ui/src/types/api/models/Page_Union_PrivacyRequestVerboseResponse__PrivacyRequestResponse__.ts @@ -1,15 +1,31 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { PrivacyRequestResponse } from "./PrivacyRequestResponse"; import type { PrivacyRequestVerboseResponse } from "./PrivacyRequestVerboseResponse"; +/** + * Page[Union[PrivacyRequestVerboseResponse, PrivacyRequestResponse]] + */ export type Page_Union_PrivacyRequestVerboseResponse__PrivacyRequestResponse__ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_UserResponse_.ts b/clients/admin-ui/src/types/api/models/Page_UserResponse_.ts index 518509b901e..e6a34936d42 100644 --- a/clients/admin-ui/src/types/api/models/Page_UserResponse_.ts +++ b/clients/admin-ui/src/types/api/models/Page_UserResponse_.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { UserResponse } from "./UserResponse"; +/** + * Page[UserResponse] + */ export type Page_UserResponse_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/Page_str_.ts b/clients/admin-ui/src/types/api/models/Page_str_.ts index cdbce2522b4..35e61039483 100644 --- a/clients/admin-ui/src/types/api/models/Page_str_.ts +++ b/clients/admin-ui/src/types/api/models/Page_str_.ts @@ -1,11 +1,27 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * Page[str] + */ export type Page_str_ = { + /** + * Items + */ items: Array; - total: number | null; - page: number | null; - size: number | null; - pages?: number | null; + /** + * Total + */ + total: number; + /** + * Page + */ + page: number; + /** + * Size + */ + size: number; + /** + * Pages + */ + pages: number; }; diff --git a/clients/admin-ui/src/types/api/models/PaginatedResponse_ConsentResponse_.ts b/clients/admin-ui/src/types/api/models/PaginatedResponse_ConsentResponse_.ts new file mode 100644 index 00000000000..a30a9191810 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PaginatedResponse_ConsentResponse_.ts @@ -0,0 +1,25 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { ConsentResponse } from "./ConsentResponse"; + +/** + * PaginatedResponse + */ +export type PaginatedResponse_ConsentResponse_ = { + /** + * Items + */ + items: Array; + /** + * Next Cursor + * + * Cursor for the next page + */ + next_cursor?: string | null; + /** + * Total Count + * + * Total number of items matching the query; only returned if the cursor is not provided + */ + total_count?: number | null; +}; diff --git a/clients/admin-ui/src/types/api/models/PaginationFilterParams.ts b/clients/admin-ui/src/types/api/models/PaginationFilterParams.ts new file mode 100644 index 00000000000..5350f32ebc1 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PaginationFilterParams.ts @@ -0,0 +1,37 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { TimeInclusivity } from "./TimeInclusivity"; + +/** + * PaginationFilterParams + */ +export type PaginationFilterParams = { + /** + * Include Latest + * + * Include preferences for the latest version of each notice + */ + include_latest?: boolean; + /** + * Include Historical + * + * Include preferences for historical notices + */ + include_historical?: boolean; + /** + * Start Time + * + * Start timestamp for the time window, expressed as an ISO-8601 formatted string. + */ + start_time?: string | null; + /** + * End Time + * + * End timestamp for the time window, expressed as an ISO-8601 formatted string. + */ + end_time?: string | null; + /** + * Whether to include the start and end times in the time window (default is both ends are inclusive) + */ + time_inclusivity?: TimeInclusivity | null; +}; diff --git a/clients/admin-ui/src/types/api/models/ParamValue.ts b/clients/admin-ui/src/types/api/models/ParamValue.ts index c6ce40fd19b..992414dd698 100644 --- a/clients/admin-ui/src/types/api/models/ParamValue.ts +++ b/clients/admin-ui/src/types/api/models/ParamValue.ts @@ -1,15 +1,32 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts + +import type { FidesDatasetReference } from "./FidesDatasetReference"; /** + * ParamValue + * * A named variable which can be sourced from identities, dataset references, or connector params. These values * are used to replace the placeholders in the path, header, query, and body param values. */ export type ParamValue = { + /** + * Name + */ name: string; + /** + * Identity + */ identity?: string | null; - references?: null; + /** + * References + */ + references?: Array | null; + /** + * Connector Param + */ connector_param?: string | null; + /** + * Unpack + */ unpack?: boolean | null; }; diff --git a/clients/admin-ui/src/types/api/models/Params.ts b/clients/admin-ui/src/types/api/models/Params.ts new file mode 100644 index 00000000000..dce40a18fd8 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/Params.ts @@ -0,0 +1,19 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * Params + */ +export type Params = { + /** + * Page + * + * Page number + */ + page?: number; + /** + * Size + * + * Page size + */ + size?: number; +}; diff --git a/clients/admin-ui/src/types/api/models/PartialPrivacyCenterConfig.ts b/clients/admin-ui/src/types/api/models/PartialPrivacyCenterConfig.ts index 2d539a428fe..46423aaf3bb 100644 --- a/clients/admin-ui/src/types/api/models/PartialPrivacyCenterConfig.ts +++ b/clients/admin-ui/src/types/api/models/PartialPrivacyCenterConfig.ts @@ -1,12 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { PartialPrivacyRequestOption } from "./PartialPrivacyRequestOption"; /** + * PartialPrivacyCenterConfig + * * Partial schema for the Admin UI privacy request submission. */ export type PartialPrivacyCenterConfig = { + /** + * Actions + */ actions: Array; }; diff --git a/clients/admin-ui/src/types/api/models/PartialPrivacyRequestOption.ts b/clients/admin-ui/src/types/api/models/PartialPrivacyRequestOption.ts index 605d5d31520..8131fc5ca40 100644 --- a/clients/admin-ui/src/types/api/models/PartialPrivacyRequestOption.ts +++ b/clients/admin-ui/src/types/api/models/PartialPrivacyRequestOption.ts @@ -1,16 +1,28 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { fides__api__schemas__privacy_center_config__CustomPrivacyRequestField } from "./fides__api__schemas__privacy_center_config__CustomPrivacyRequestField"; import type { IdentityInputs } from "./IdentityInputs"; +import type { LocationCustomPrivacyRequestField } from "./LocationCustomPrivacyRequestField"; +/** + * PartialPrivacyRequestOption + */ export type PartialPrivacyRequestOption = { + /** + * Policy Key + */ policy_key: string; + /** + * Title + */ title: string; identity_inputs?: IdentityInputs | null; - custom_privacy_request_fields?: Record< - string, - fides__api__schemas__privacy_center_config__CustomPrivacyRequestField - > | null; + /** + * Custom Privacy Request Fields + */ + custom_privacy_request_fields?: { + [key: string]: + | LocationCustomPrivacyRequestField + | fides__api__schemas__privacy_center_config__CustomPrivacyRequestField; + } | null; }; diff --git a/clients/admin-ui/src/types/api/models/PeriodicIntegrationFrequency.ts b/clients/admin-ui/src/types/api/models/PeriodicIntegrationFrequency.ts index 621502f4011..488116cad17 100644 --- a/clients/admin-ui/src/types/api/models/PeriodicIntegrationFrequency.ts +++ b/clients/admin-ui/src/types/api/models/PeriodicIntegrationFrequency.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PeriodicIntegrationFrequency + * * Enum for periodic integration frequency */ export enum PeriodicIntegrationFrequency { diff --git a/clients/admin-ui/src/types/api/models/PlusApplicationConfig.ts b/clients/admin-ui/src/types/api/models/PlusApplicationConfig.ts index c2ab3f44517..48742cfd026 100644 --- a/clients/admin-ui/src/types/api/models/PlusApplicationConfig.ts +++ b/clients/admin-ui/src/types/api/models/PlusApplicationConfig.ts @@ -1,6 +1,4 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { AdminUIConfig } from "./AdminUIConfig"; import type { DuplicateDetectionApplicationConfig } from "./DuplicateDetectionApplicationConfig"; @@ -13,6 +11,9 @@ import type { PlusConsentSettingsApplicationConfig } from "./PlusConsentSettings import type { SecurityApplicationConfig } from "./SecurityApplicationConfig"; import type { StorageApplicationConfig } from "./StorageApplicationConfig"; +/** + * PlusApplicationConfig + */ export type PlusApplicationConfig = { storage?: StorageApplicationConfig | null; notifications?: NotificationApplicationConfig | null; @@ -22,6 +23,12 @@ export type PlusApplicationConfig = { admin_ui?: AdminUIConfig | null; privacy_center?: fides__api__schemas__application_config__PrivacyCenterConfig | null; privacy_request_duplicate_detection?: DuplicateDetectionApplicationConfig | null; + /** + * Default Policies + */ + default_policies?: { + [key: string]: string | null; + } | null; gpp?: GPPApplicationConfig | null; plus_consent_settings?: PlusConsentSettingsApplicationConfig | null; }; diff --git a/clients/admin-ui/src/types/api/models/PlusConsentSettingsApplicationConfig.ts b/clients/admin-ui/src/types/api/models/PlusConsentSettingsApplicationConfig.ts index 29f2f95fac4..2f469ceb3af 100644 --- a/clients/admin-ui/src/types/api/models/PlusConsentSettingsApplicationConfig.ts +++ b/clients/admin-ui/src/types/api/models/PlusConsentSettingsApplicationConfig.ts @@ -1,7 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * PlusConsentSettingsApplicationConfig + */ export type PlusConsentSettingsApplicationConfig = { + /** + * Tcf Publisher Country Code + */ tcf_publisher_country_code?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/PolicyConditionRequest.ts b/clients/admin-ui/src/types/api/models/PolicyConditionRequest.ts index 183fede3e31..3c79fc1871a 100644 --- a/clients/admin-ui/src/types/api/models/PolicyConditionRequest.ts +++ b/clients/admin-ui/src/types/api/models/PolicyConditionRequest.ts @@ -1,15 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConditionGroup } from "./ConditionGroup"; import type { ConditionLeaf } from "./ConditionLeaf"; /** + * PolicyConditionRequest + * * Request schema for updating policy conditions. */ export type PolicyConditionRequest = { /** + * Condition + * * Root condition (leaf or group) to set. Null/omitted to delete all conditions. */ condition?: ConditionLeaf | ConditionGroup | null; diff --git a/clients/admin-ui/src/types/api/models/PolicyConditionResponse.ts b/clients/admin-ui/src/types/api/models/PolicyConditionResponse.ts index 6a8b84466e5..e96e6afc0a3 100644 --- a/clients/admin-ui/src/types/api/models/PolicyConditionResponse.ts +++ b/clients/admin-ui/src/types/api/models/PolicyConditionResponse.ts @@ -1,15 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConditionGroup } from "./ConditionGroup"; import type { ConditionLeaf } from "./ConditionLeaf"; /** + * PolicyConditionResponse + * * Response schema for policy conditions. */ export type PolicyConditionResponse = { /** + * Condition + * * Root condition (leaf or group) with nested structure. Null if no conditions exist. */ condition?: ConditionLeaf | ConditionGroup | null; diff --git a/clients/admin-ui/src/types/api/models/PolicyMaskingSpec.ts b/clients/admin-ui/src/types/api/models/PolicyMaskingSpec.ts index 9fce6f2921e..55abded134a 100644 --- a/clients/admin-ui/src/types/api/models/PolicyMaskingSpec.ts +++ b/clients/admin-ui/src/types/api/models/PolicyMaskingSpec.ts @@ -1,11 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PolicyMaskingSpec + * * Models the masking strategy definition */ export type PolicyMaskingSpec = { + /** + * Strategy + */ strategy: string; - configuration: any; + /** + * Configuration + */ + configuration: { + [key: string]: unknown; + }; }; diff --git a/clients/admin-ui/src/types/api/models/PolicyMaskingSpecResponse.ts b/clients/admin-ui/src/types/api/models/PolicyMaskingSpecResponse.ts index 4b3e586e36f..2cb4cda2f34 100644 --- a/clients/admin-ui/src/types/api/models/PolicyMaskingSpecResponse.ts +++ b/clients/admin-ui/src/types/api/models/PolicyMaskingSpecResponse.ts @@ -1,12 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PolicyMaskingSpecResponse + * * The schema to use when returning a masking strategy via the API. This schema omits other * potentially sensitive fields in the masking configuration, for example the encryption * algorithm. */ export type PolicyMaskingSpecResponse = { + /** + * Strategy + */ strategy: string; }; diff --git a/clients/admin-ui/src/types/api/models/PolicyResponse.ts b/clients/admin-ui/src/types/api/models/PolicyResponse.ts index b33ebfcc99c..edb3f555d0f 100644 --- a/clients/admin-ui/src/types/api/models/PolicyResponse.ts +++ b/clients/admin-ui/src/types/api/models/PolicyResponse.ts @@ -1,20 +1,37 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +import { ActionType } from "./ActionType"; import type { ConditionGroup } from "./ConditionGroup"; import type { ConditionLeaf } from "./ConditionLeaf"; -import type { DrpAction } from "./DrpAction"; +import { DrpAction } from "./DrpAction"; import type { RuleResponse } from "./RuleResponse"; /** + * PolicyResponse + * * A holistic view of a Policy record, including all foreign keys by default. */ export type PolicyResponse = { + /** + * Name + */ name: string; + /** + * Key + */ key?: string | null; + action_type?: ActionType | null; + /** + * Rules + */ + rules?: Array | null; drp_action?: DrpAction | null; + /** + * Execution Timeframe + */ execution_timeframe?: number | null; - rules?: Array | null; - conditions?: ConditionGroup | ConditionLeaf | null; + /** + * Conditions + */ + conditions?: ConditionLeaf | ConditionGroup | null; }; diff --git a/clients/admin-ui/src/types/api/models/PolicyRule.ts b/clients/admin-ui/src/types/api/models/PolicyRule.ts index 25d397df145..bb6fac6a5ac 100644 --- a/clients/admin-ui/src/types/api/models/PolicyRule.ts +++ b/clients/admin-ui/src/types/api/models/PolicyRule.ts @@ -1,15 +1,18 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { PrivacyRule } from "./PrivacyRule"; /** + * PolicyRule + * * The PolicyRule resource model. * * Describes the allowed combination of the various privacy data types. */ export type PolicyRule = { + /** + * Name + */ name: string; /** * diff --git a/clients/admin-ui/src/types/api/models/PolicyUnavailableMessages.ts b/clients/admin-ui/src/types/api/models/PolicyUnavailableMessages.ts index 77efc0d4431..0352caa98c4 100644 --- a/clients/admin-ui/src/types/api/models/PolicyUnavailableMessages.ts +++ b/clients/admin-ui/src/types/api/models/PolicyUnavailableMessages.ts @@ -1,14 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PolicyUnavailableMessages + * * Used to capture the information to present to a user if a policy is unavailable. */ export type PolicyUnavailableMessages = { + /** + * Title + */ title: string; + /** + * Description + */ description: string; + /** + * Close Button Text + */ close_button_text: string; + /** + * Action Button Text + */ action_button_text: string; + /** + * Action Link + */ action_link: string; }; diff --git a/clients/admin-ui/src/types/api/models/PolicyWebhookCreate.ts b/clients/admin-ui/src/types/api/models/PolicyWebhookCreate.ts index f5037e256d0..293d03cceaa 100644 --- a/clients/admin-ui/src/types/api/models/PolicyWebhookCreate.ts +++ b/clients/admin-ui/src/types/api/models/PolicyWebhookCreate.ts @@ -1,15 +1,24 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { WebhookDirection } from "./WebhookDirection"; +import { WebhookDirection } from "./WebhookDirection"; /** + * PolicyWebhookCreate + * * Request schema for creating/updating a Policy Webhook */ export type PolicyWebhookCreate = { direction: WebhookDirection; + /** + * Key + */ key?: string | null; + /** + * Name + */ name?: string | null; + /** + * Connection Config Key + */ connection_config_key: string; }; diff --git a/clients/admin-ui/src/types/api/models/PolicyWebhookDeleteResponse.ts b/clients/admin-ui/src/types/api/models/PolicyWebhookDeleteResponse.ts index b0d1b8322cc..fcc463ca047 100644 --- a/clients/admin-ui/src/types/api/models/PolicyWebhookDeleteResponse.ts +++ b/clients/admin-ui/src/types/api/models/PolicyWebhookDeleteResponse.ts @@ -1,12 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { WebhookOrder } from "./WebhookOrder"; /** + * PolicyWebhookDeleteResponse + * * Response schema after deleting a webhook; new_order includes remaining reordered webhooks if applicable */ export type PolicyWebhookDeleteResponse = { + /** + * New Order + */ new_order: Array; }; diff --git a/clients/admin-ui/src/types/api/models/PolicyWebhookResponse.ts b/clients/admin-ui/src/types/api/models/PolicyWebhookResponse.ts index 17c6d4a475b..dea72d53228 100644 --- a/clients/admin-ui/src/types/api/models/PolicyWebhookResponse.ts +++ b/clients/admin-ui/src/types/api/models/PolicyWebhookResponse.ts @@ -1,17 +1,26 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConnectionConfigurationResponse } from "./ConnectionConfigurationResponse"; -import type { WebhookDirection } from "./WebhookDirection"; +import { WebhookDirection } from "./WebhookDirection"; /** + * PolicyWebhookResponse + * * Response schema after creating a PolicyWebhook */ export type PolicyWebhookResponse = { direction: WebhookDirection; + /** + * Key + */ key?: string | null; + /** + * Name + */ name?: string | null; connection_config?: ConnectionConfigurationResponse | null; + /** + * Order + */ order: number; }; diff --git a/clients/admin-ui/src/types/api/models/PolicyWebhookUpdate.ts b/clients/admin-ui/src/types/api/models/PolicyWebhookUpdate.ts index 630ff9949c3..a68ea649d0f 100644 --- a/clients/admin-ui/src/types/api/models/PolicyWebhookUpdate.ts +++ b/clients/admin-ui/src/types/api/models/PolicyWebhookUpdate.ts @@ -1,15 +1,24 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { WebhookDirection } from "./WebhookDirection"; +import { WebhookDirection } from "./WebhookDirection"; /** + * PolicyWebhookUpdate + * * Request schema for updating a single webhook - fields are optional */ export type PolicyWebhookUpdate = { direction?: WebhookDirection | null; + /** + * Name + */ name?: string | null; + /** + * Connection Config Key + */ connection_config_key?: string | null; + /** + * Order + */ order?: number | null; }; diff --git a/clients/admin-ui/src/types/api/models/PolicyWebhookUpdateResponse.ts b/clients/admin-ui/src/types/api/models/PolicyWebhookUpdateResponse.ts index 20b6609aae5..d1472abc8cd 100644 --- a/clients/admin-ui/src/types/api/models/PolicyWebhookUpdateResponse.ts +++ b/clients/admin-ui/src/types/api/models/PolicyWebhookUpdateResponse.ts @@ -1,15 +1,18 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { PolicyWebhookResponse } from "./PolicyWebhookResponse"; import type { WebhookOrder } from "./WebhookOrder"; /** + * PolicyWebhookUpdateResponse + * * Response schema after a PATCH to a single webhook - because updating the order of this webhook can update the * order of other webhooks, new_order will include the new order if order was adjusted at all */ export type PolicyWebhookUpdateResponse = { resource: PolicyWebhookResponse; + /** + * New Order + */ new_order: Array; }; diff --git a/clients/admin-ui/src/types/api/models/PostgreSQLDocsSchema.ts b/clients/admin-ui/src/types/api/models/PostgreSQLDocsSchema.ts index 092fd896e91..4a71530cd8e 100644 --- a/clients/admin-ui/src/types/api/models/PostgreSQLDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/PostgreSQLDocsSchema.ts @@ -1,38 +1,55 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PostgreSQLDocsSchema + * * Postgres Secrets Schema for API Docs */ export type PostgreSQLDocsSchema = { /** + * Host + * * The hostname or IP address of the server where the database is running. */ host: string; /** + * Port + * * The network port number on which the server is listening for incoming connections (default: 5432). */ port?: number; /** + * Username + * * The user account used to authenticate and access the database. */ username?: string | null; /** + * Password + * * The password used to authenticate and access the database. */ password?: string | null; /** + * SSH required + * * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. */ ssh_required?: boolean; /** + * Database + * * The name of the specific database within the database server that you want to connect to. */ dbname?: string | null; /** + * Schema + * * The default schema to be used for the database connection (defaults to public). */ db_schema?: string | null; + /** + * SSL Mode + */ ssl_mode?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/PreApprovalWebhookCreate.ts b/clients/admin-ui/src/types/api/models/PreApprovalWebhookCreate.ts index bec8444f59e..fb7a0514bea 100644 --- a/clients/admin-ui/src/types/api/models/PreApprovalWebhookCreate.ts +++ b/clients/admin-ui/src/types/api/models/PreApprovalWebhookCreate.ts @@ -1,12 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PreApprovalWebhookCreate + * * Request schema for creating/updating a Pre Approval Webhook */ export type PreApprovalWebhookCreate = { + /** + * Key + */ key?: string | null; + /** + * Name + */ name: string; + /** + * Connection Config Key + */ connection_config_key: string; }; diff --git a/clients/admin-ui/src/types/api/models/PreApprovalWebhookResponse.ts b/clients/admin-ui/src/types/api/models/PreApprovalWebhookResponse.ts index 4991aa7420d..e182897b17a 100644 --- a/clients/admin-ui/src/types/api/models/PreApprovalWebhookResponse.ts +++ b/clients/admin-ui/src/types/api/models/PreApprovalWebhookResponse.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConnectionConfigurationResponse } from "./ConnectionConfigurationResponse"; /** + * PreApprovalWebhookResponse + * * Response schema after creating/updating/getting a PreApprovalWebhook */ export type PreApprovalWebhookResponse = { + /** + * Key + */ key?: string | null; + /** + * Name + */ name: string; connection_config?: ConnectionConfigurationResponse | null; }; diff --git a/clients/admin-ui/src/types/api/models/PreApprovalWebhookUpdate.ts b/clients/admin-ui/src/types/api/models/PreApprovalWebhookUpdate.ts index 43af9f3b36a..47016f32ea0 100644 --- a/clients/admin-ui/src/types/api/models/PreApprovalWebhookUpdate.ts +++ b/clients/admin-ui/src/types/api/models/PreApprovalWebhookUpdate.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PreApprovalWebhookUpdate + * * Request schema for updating a single webhook - fields are optional */ export type PreApprovalWebhookUpdate = { + /** + * Name + */ name?: string | null; + /** + * Connection Config Key + */ connection_config_key?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/PreVerifiedPrivacyPreferencesRequest.ts b/clients/admin-ui/src/types/api/models/PreVerifiedPrivacyPreferencesRequest.ts index 4b4efe5430a..76a248f5205 100644 --- a/clients/admin-ui/src/types/api/models/PreVerifiedPrivacyPreferencesRequest.ts +++ b/clients/admin-ui/src/types/api/models/PreVerifiedPrivacyPreferencesRequest.ts @@ -1,11 +1,9 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConsentMethod } from "./ConsentMethod"; +import { ConsentMethod } from "./ConsentMethod"; import type { ConsentOptionCreate } from "./ConsentOptionCreate"; -import type { Identity } from "./Identity"; -import type { PrivacyRequestSource } from "./PrivacyRequestSource"; +import type { fides__api__schemas__redis_cache__Identity } from "./fides__api__schemas__redis_cache__Identity"; +import { PrivacyRequestSource } from "./PrivacyRequestSource"; import type { TCFFeatureSave } from "./TCFFeatureSave"; import type { TCFPurposeSave } from "./TCFPurposeSave"; import type { TCFSpecialFeatureSave } from "./TCFSpecialFeatureSave"; @@ -13,6 +11,8 @@ import type { TCFSpecialPurposeSave } from "./TCFSpecialPurposeSave"; import type { TCFVendorSave } from "./TCFVendorSave"; /** + * PreVerifiedPrivacyPreferencesRequest + * * Request body for saving pre-verified PrivacyPreferences. * This means the identity values have been verified externally * without relying on our email identity verification flow. @@ -22,27 +22,81 @@ import type { TCFVendorSave } from "./TCFVendorSave"; * New *_preferences fields are used for saving preferences against various tcf components. */ export type PreVerifiedPrivacyPreferencesRequest = { + /** + * Purpose Consent Preferences + */ purpose_consent_preferences?: Array; + /** + * Purpose Legitimate Interests Preferences + */ purpose_legitimate_interests_preferences?: Array; + /** + * Vendor Consent Preferences + */ vendor_consent_preferences?: Array; + /** + * Vendor Legitimate Interests Preferences + */ vendor_legitimate_interests_preferences?: Array; + /** + * Special Feature Preferences + */ special_feature_preferences?: Array; + /** + * Special Purpose Preferences + */ special_purpose_preferences?: Array; + /** + * Feature Preferences + */ feature_preferences?: Array; + /** + * System Consent Preferences + */ system_consent_preferences?: Array; + /** + * System Legitimate Interests Preferences + */ system_legitimate_interests_preferences?: Array; + /** + * Preferences + */ preferences?: Array; /** + * Fides String + * * If supplied, TC strings and AC strings are decoded and preferences saved for purpose_consent, purpose_legitimate_interests, vendor_consent, vendor_legitimate_interests, and special_features */ fides_string?: string | null; + /** + * Policy Key + */ policy_key?: string | null; + /** + * Privacy Experience Id + */ privacy_experience_id?: string | null; + /** + * Privacy Experience Config History Id + */ privacy_experience_config_history_id?: string | null; + /** + * User Geography + */ user_geography?: string | null; method?: ConsentMethod | null; + /** + * Served Notice History Id + */ served_notice_history_id?: string | null; + /** + * Property Id + */ property_id?: string | null; source?: PrivacyRequestSource | null; - identity: Identity; + identity: fides__api__schemas__redis_cache__Identity; + /** + * Received At + */ + received_at?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/PreferenceFidesMeta.ts b/clients/admin-ui/src/types/api/models/PreferenceFidesMeta.ts index 43d0e771fcd..28f0f2d8376 100644 --- a/clients/admin-ui/src/types/api/models/PreferenceFidesMeta.ts +++ b/clients/admin-ui/src/types/api/models/PreferenceFidesMeta.ts @@ -1,11 +1,12 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { PreferenceType } from "./PreferenceType"; -import type { PropagationPolicyKey } from "./PropagationPolicyKey"; +import { PreferenceType } from "./PreferenceType"; +import { PropagationPolicyKey } from "./PropagationPolicyKey"; +import type { SourcePreference } from "./SourcePreference"; /** + * PreferenceFidesMeta + * * Fides-defined metadata properties for a single preference value (includes backend-only fields). */ export type PreferenceFidesMeta = { @@ -18,10 +19,18 @@ export type PreferenceFidesMeta = { */ policy_key?: PropagationPolicyKey | null; /** + * Source preference information for a preference created by a propagation policy. + */ + source_preference?: SourcePreference | null; + /** + * Property Id + * * The Fides property id where the preference was collected */ property_id?: string | null; /** + * Experience Config History Id + * * Identifier for the experience config history */ experience_config_history_id?: string | null; diff --git a/clients/admin-ui/src/types/api/models/PreferenceFidesMetaCreate.ts b/clients/admin-ui/src/types/api/models/PreferenceFidesMetaCreate.ts index e6908d6c1b4..0301b63cf33 100644 --- a/clients/admin-ui/src/types/api/models/PreferenceFidesMetaCreate.ts +++ b/clients/admin-ui/src/types/api/models/PreferenceFidesMetaCreate.ts @@ -1,16 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PreferenceFidesMetaCreate + * * Fides-defined metadata for API input (user-provided fields only). */ export type PreferenceFidesMetaCreate = { /** + * Property Id + * * The Fides property id where the preference was collected */ property_id?: string | null; /** + * Experience Config History Id + * * Identifier for the experience config history */ experience_config_history_id?: string | null; diff --git a/clients/admin-ui/src/types/api/models/PreferenceMeta.ts b/clients/admin-ui/src/types/api/models/PreferenceMeta.ts deleted file mode 100644 index f5753c80ddd..00000000000 --- a/clients/admin-ui/src/types/api/models/PreferenceMeta.ts +++ /dev/null @@ -1,15 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { PreferenceFidesMeta } from "./PreferenceFidesMeta"; - -/** - * Metadata structure for a single preference value (includes backend-only fields). - */ -export type PreferenceMeta = { - /** - * A set of Fides-defined metadata properties for a single privacy preference. - */ - fides?: PreferenceFidesMeta; -}; diff --git a/clients/admin-ui/src/types/api/models/PreferenceMetaCreate.ts b/clients/admin-ui/src/types/api/models/PreferenceMetaCreate.ts index 73ddac0be30..758d3c4be03 100644 --- a/clients/admin-ui/src/types/api/models/PreferenceMetaCreate.ts +++ b/clients/admin-ui/src/types/api/models/PreferenceMetaCreate.ts @@ -1,10 +1,10 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { PreferenceFidesMetaCreate } from "./PreferenceFidesMetaCreate"; /** + * PreferenceMetaCreate + * * Metadata structure for API input (user-provided fields only). */ export type PreferenceMetaCreate = { @@ -12,4 +12,5 @@ export type PreferenceMetaCreate = { * A set of Fides-defined metadata properties for a single privacy preference. */ fides?: PreferenceFidesMetaCreate | null; + [key: string]: unknown | PreferenceFidesMetaCreate | null | undefined; }; diff --git a/clients/admin-ui/src/types/api/models/PreferenceMetaResponse.ts b/clients/admin-ui/src/types/api/models/PreferenceMetaResponse.ts new file mode 100644 index 00000000000..177ea3ba9a0 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PreferenceMetaResponse.ts @@ -0,0 +1,18 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { PreferenceFidesMeta } from "./PreferenceFidesMeta"; + +/** + * PreferenceMetaResponse + * + * Metadata for a single preference value (includes backend-only fields). + * Inherits all fields from PreferenceMeta and uses the PreserveExtraFieldsMixin + * to ensure that arbitrary key-value pairs in our meta objects get returned on reads. + */ +export type PreferenceMetaResponse = { + /** + * A set of Fides-defined metadata properties for a single privacy preference. + */ + fides?: PreferenceFidesMeta; + [key: string]: unknown | PreferenceFidesMeta | undefined; +}; diff --git a/clients/admin-ui/src/types/api/models/PreferenceSource.ts b/clients/admin-ui/src/types/api/models/PreferenceSource.ts deleted file mode 100644 index f5997c3237a..00000000000 --- a/clients/admin-ui/src/types/api/models/PreferenceSource.ts +++ /dev/null @@ -1,12 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -/** - * Source of a preference value. - */ -export enum PreferenceSource { - DEFAULT_MECHANISM = "default_mechanism", - PARENT_PREFERENCE = "parent_preference", - USER_PROVIDED = "user_provided", -} diff --git a/clients/admin-ui/src/types/api/models/PreferenceType.ts b/clients/admin-ui/src/types/api/models/PreferenceType.ts index f0cfd855984..b22443e305c 100644 --- a/clients/admin-ui/src/types/api/models/PreferenceType.ts +++ b/clients/admin-ui/src/types/api/models/PreferenceType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PreferenceType + * * Type of a preference value. */ export enum PreferenceType { diff --git a/clients/admin-ui/src/types/api/models/PreferenceWithNoticeInformation.ts b/clients/admin-ui/src/types/api/models/PreferenceWithNoticeInformation.ts index 1252d0b039c..cd030521eb3 100644 --- a/clients/admin-ui/src/types/api/models/PreferenceWithNoticeInformation.ts +++ b/clients/admin-ui/src/types/api/models/PreferenceWithNoticeInformation.ts @@ -1,17 +1,32 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * PreferenceWithNoticeInformation + * * Preference with additional notice information. */ export type PreferenceWithNoticeInformation = { + /** + * Privacy Notice History Id + */ privacy_notice_history_id: string; preference: UserConsentPreference; + /** + * Notice Key + */ notice_key: string; + /** + * Notice Name + */ notice_name: string; + /** + * Notice Id + */ notice_id: string; + /** + * Version + */ version: number; }; diff --git a/clients/admin-ui/src/types/api/models/PreferencesSaved.ts b/clients/admin-ui/src/types/api/models/PreferencesSaved.ts index c207340c4df..d8bc28c2265 100644 --- a/clients/admin-ui/src/types/api/models/PreferencesSaved.ts +++ b/clients/admin-ui/src/types/api/models/PreferencesSaved.ts @@ -1,6 +1,4 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConsentOptionCreate } from "./ConsentOptionCreate"; import type { TCFFeatureSave } from "./TCFFeatureSave"; @@ -10,19 +8,51 @@ import type { TCFSpecialPurposeSave } from "./TCFSpecialPurposeSave"; import type { TCFVendorSave } from "./TCFVendorSave"; /** + * PreferencesSaved + * * All preference types against which consent can be saved - including both Privacy Notices and TCF attributes * * # NOTE: The "preferences" key is for saving preferences against Privacy Notices only, not TCF preferences. */ export type PreferencesSaved = { + /** + * Purpose Consent Preferences + */ purpose_consent_preferences?: Array; + /** + * Purpose Legitimate Interests Preferences + */ purpose_legitimate_interests_preferences?: Array; + /** + * Vendor Consent Preferences + */ vendor_consent_preferences?: Array; + /** + * Vendor Legitimate Interests Preferences + */ vendor_legitimate_interests_preferences?: Array; + /** + * Special Feature Preferences + */ special_feature_preferences?: Array; + /** + * Special Purpose Preferences + */ special_purpose_preferences?: Array; + /** + * Feature Preferences + */ feature_preferences?: Array; + /** + * System Consent Preferences + */ system_consent_preferences?: Array; + /** + * System Legitimate Interests Preferences + */ system_legitimate_interests_preferences?: Array; + /** + * Preferences + */ preferences?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/PreferencesSavedExtended.ts b/clients/admin-ui/src/types/api/models/PreferencesSavedExtended.ts index b8b0f8d7913..e8f2bc59075 100644 --- a/clients/admin-ui/src/types/api/models/PreferencesSavedExtended.ts +++ b/clients/admin-ui/src/types/api/models/PreferencesSavedExtended.ts @@ -1,6 +1,4 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { PreferenceWithNoticeInformation } from "./PreferenceWithNoticeInformation"; import type { TCFFeatureSave } from "./TCFFeatureSave"; @@ -10,18 +8,50 @@ import type { TCFSpecialPurposeSave } from "./TCFSpecialPurposeSave"; import type { TCFVendorSave } from "./TCFVendorSave"; /** + * PreferencesSavedExtended + * * An extended version of PreferencesSaved that includes * additional notice information for each preference. */ export type PreferencesSavedExtended = { + /** + * Purpose Consent Preferences + */ purpose_consent_preferences?: Array; + /** + * Purpose Legitimate Interests Preferences + */ purpose_legitimate_interests_preferences?: Array; + /** + * Vendor Consent Preferences + */ vendor_consent_preferences?: Array; + /** + * Vendor Legitimate Interests Preferences + */ vendor_legitimate_interests_preferences?: Array; + /** + * Special Feature Preferences + */ special_feature_preferences?: Array; + /** + * Special Purpose Preferences + */ special_purpose_preferences?: Array; + /** + * Feature Preferences + */ feature_preferences?: Array; + /** + * System Consent Preferences + */ system_consent_preferences?: Array; + /** + * System Legitimate Interests Preferences + */ system_legitimate_interests_preferences?: Array; + /** + * Preferences + */ preferences?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyAssessmentConfigDefaults.ts b/clients/admin-ui/src/types/api/models/PrivacyAssessmentConfigDefaults.ts new file mode 100644 index 00000000000..eee8b640fce --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PrivacyAssessmentConfigDefaults.ts @@ -0,0 +1,21 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * PrivacyAssessmentConfigDefaults + * + * Schema for returning default configuration values. + */ +export type PrivacyAssessmentConfigDefaults = { + /** + * Default Assessment Model + */ + default_assessment_model?: string; + /** + * Default Chat Model + */ + default_chat_model?: string; + /** + * Default Reassessment Cron + */ + default_reassessment_cron?: string; +}; diff --git a/clients/admin-ui/src/types/api/models/PrivacyAssessmentConfigResponse.ts b/clients/admin-ui/src/types/api/models/PrivacyAssessmentConfigResponse.ts new file mode 100644 index 00000000000..2266ebee351 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PrivacyAssessmentConfigResponse.ts @@ -0,0 +1,53 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * PrivacyAssessmentConfigResponse + * + * Response schema for privacy assessment configuration. + */ +export type PrivacyAssessmentConfigResponse = { + /** + * Id + */ + id: string; + /** + * Assessment Model Override + */ + assessment_model_override?: string | null; + /** + * Chat Model Override + */ + chat_model_override?: string | null; + /** + * Effective Assessment Model + */ + effective_assessment_model: string; + /** + * Effective Chat Model + */ + effective_chat_model: string; + /** + * Reassessment Enabled + */ + reassessment_enabled: boolean; + /** + * Reassessment Cron + */ + reassessment_cron: string; + /** + * Slack Channel Id + */ + slack_channel_id?: string | null; + /** + * Slack Channel Name + */ + slack_channel_name?: string | null; + /** + * Created At + */ + created_at: string; + /** + * Updated At + */ + updated_at: string; +}; diff --git a/clients/admin-ui/src/types/api/models/PrivacyAssessmentConfigUpdate.ts b/clients/admin-ui/src/types/api/models/PrivacyAssessmentConfigUpdate.ts new file mode 100644 index 00000000000..dc4ef6f20a2 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PrivacyAssessmentConfigUpdate.ts @@ -0,0 +1,33 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * PrivacyAssessmentConfigUpdate + * + * Schema for creating/updating privacy assessment configuration. + */ +export type PrivacyAssessmentConfigUpdate = { + /** + * Assessment Model Override + */ + assessment_model_override?: string | null; + /** + * Chat Model Override + */ + chat_model_override?: string | null; + /** + * Reassessment Enabled + */ + reassessment_enabled?: boolean | null; + /** + * Reassessment Cron + */ + reassessment_cron?: string | null; + /** + * Slack Channel Id + */ + slack_channel_id?: string | null; + /** + * Slack Channel Name + */ + slack_channel_name?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/PrivacyDeclaration.ts b/clients/admin-ui/src/types/api/models/PrivacyDeclaration.ts index ddbaec6c335..b6f35c4d913 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyDeclaration.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyDeclaration.ts @@ -1,11 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { LegalBasisForProcessingEnum } from "./LegalBasisForProcessingEnum"; -import type { SpecialCategoryLegalBasisEnum } from "./SpecialCategoryLegalBasisEnum"; +import { LegalBasisForProcessingEnum } from "./LegalBasisForProcessingEnum"; +import { SpecialCategoryLegalBasisEnum } from "./SpecialCategoryLegalBasisEnum"; /** + * PrivacyDeclaration + * * The PrivacyDeclaration resource model. * * States a function of a system, and describes how it relates @@ -13,38 +13,56 @@ import type { SpecialCategoryLegalBasisEnum } from "./SpecialCategoryLegalBasisE */ export type PrivacyDeclaration = { /** + * Name + * * The name of the privacy declaration on the system. */ name?: string | null; /** + * Data Categories + * * An array of data categories describing a system in a privacy declaration. */ data_categories: Array; /** + * Data Use + * * The Data Use describing a system in a privacy declaration. */ data_use: string; /** + * Data Subjects + * * An array of data subjects describing a system in a privacy declaration. */ data_subjects?: Array; /** + * Dataset References + * * Referenced Dataset fides keys used by the system. */ dataset_references?: Array | null; /** + * Egress + * * The resources to which data is sent. Any `fides_key`s included in this list reference `DataFlow` entries in the `egress` array of any `System` resources to which this `PrivacyDeclaration` is applied. */ egress?: Array | null; /** + * Ingress + * * The resources from which data is received. Any `fides_key`s included in this list reference `DataFlow` entries in the `ingress` array of any `System` resources to which this `PrivacyDeclaration` is applied. */ ingress?: Array | null; /** + * Features + * * The features of processing personal data. */ features?: Array; /** + * Flexible Legal Basis For Processing + * * Whether the legal basis for processing is 'flexible' (i.e. can be overridden in a privacy notice) for this declaration. */ flexible_legal_basis_for_processing?: boolean; @@ -53,14 +71,20 @@ export type PrivacyDeclaration = { */ legal_basis_for_processing?: LegalBasisForProcessingEnum | null; /** + * Impact Assessment Location + * * Where the legitimate interest impact assessment is stored */ impact_assessment_location?: string | null; /** + * Retention Period + * * An optional string to describe the time period for which data is retained for this purpose. */ retention_period?: string | null; /** + * Processes Special Category Data + * * This system processes special category data */ processes_special_category_data?: boolean; @@ -69,14 +93,20 @@ export type PrivacyDeclaration = { */ special_category_legal_basis?: SpecialCategoryLegalBasisEnum | null; /** + * Data Shared With Third Parties + * * This system shares data with third parties for this purpose. */ data_shared_with_third_parties?: boolean; /** + * Third Parties + * * The types of third parties the data is shared with. */ third_parties?: string | null; /** + * Shared Categories + * * The categories of personal data that this system shares with third parties. */ shared_categories?: Array; diff --git a/clients/admin-ui/src/types/api/models/PrivacyDeclarationResponse.ts b/clients/admin-ui/src/types/api/models/PrivacyDeclarationResponse.ts index 1506537e904..3cb2f7a223f 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyDeclarationResponse.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyDeclarationResponse.ts @@ -1,47 +1,65 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { LegalBasisForProcessingEnum } from "./LegalBasisForProcessingEnum"; -import type { SpecialCategoryLegalBasisEnum } from "./SpecialCategoryLegalBasisEnum"; +import { LegalBasisForProcessingEnum } from "./LegalBasisForProcessingEnum"; +import { SpecialCategoryLegalBasisEnum } from "./SpecialCategoryLegalBasisEnum"; /** + * PrivacyDeclarationResponse + * * Extension of base pydantic model to include DB `id` field in the response */ export type PrivacyDeclarationResponse = { /** + * Name + * * The name of the privacy declaration on the system. */ name?: string | null; /** + * Data Categories + * * An array of data categories describing a system in a privacy declaration. */ data_categories: Array; /** + * Data Use + * * The Data Use describing a system in a privacy declaration. */ data_use: string; /** + * Data Subjects + * * An array of data subjects describing a system in a privacy declaration. */ data_subjects?: Array; /** + * Dataset References + * * Referenced Dataset fides keys used by the system. */ dataset_references?: Array | null; /** + * Egress + * * The resources to which data is sent. Any `fides_key`s included in this list reference `DataFlow` entries in the `egress` array of any `System` resources to which this `PrivacyDeclaration` is applied. */ egress?: Array | null; /** + * Ingress + * * The resources from which data is received. Any `fides_key`s included in this list reference `DataFlow` entries in the `ingress` array of any `System` resources to which this `PrivacyDeclaration` is applied. */ ingress?: Array | null; /** + * Features + * * The features of processing personal data. */ features?: Array; /** + * Flexible Legal Basis For Processing + * * Whether the legal basis for processing is 'flexible' (i.e. can be overridden in a privacy notice) for this declaration. */ flexible_legal_basis_for_processing?: boolean; @@ -50,14 +68,20 @@ export type PrivacyDeclarationResponse = { */ legal_basis_for_processing?: LegalBasisForProcessingEnum | null; /** + * Impact Assessment Location + * * Where the legitimate interest impact assessment is stored */ impact_assessment_location?: string | null; /** + * Retention Period + * * An optional string to describe the time period for which data is retained for this purpose. */ retention_period?: string | null; /** + * Processes Special Category Data + * * This system processes special category data */ processes_special_category_data?: boolean; @@ -66,18 +90,26 @@ export type PrivacyDeclarationResponse = { */ special_category_legal_basis?: SpecialCategoryLegalBasisEnum | null; /** + * Data Shared With Third Parties + * * This system shares data with third parties for this purpose. */ data_shared_with_third_parties?: boolean; /** + * Third Parties + * * The types of third parties the data is shared with. */ third_parties?: string | null; /** + * Shared Categories + * * The categories of personal data that this system shares with third parties. */ shared_categories?: Array; /** + * Id + * * The database-assigned ID of the privacy declaration on the system. This is meant to be a read-only field, returned only in API responses */ id: string; diff --git a/clients/admin-ui/src/types/api/models/PrivacyExperienceGPPSettings.ts b/clients/admin-ui/src/types/api/models/PrivacyExperienceGPPSettings.ts index d00a6b082b7..82d070dcc9a 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyExperienceGPPSettings.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyExperienceGPPSettings.ts @@ -1,17 +1,35 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { GPPUSApproach } from "./GPPUSApproach"; +import { GPPUSApproach } from "./GPPUSApproach"; +/** + * PrivacyExperienceGPPSettings + */ export type PrivacyExperienceGPPSettings = { us_approach?: GPPUSApproach | null; + /** + * Mspa Service Provider Mode + */ mspa_service_provider_mode?: boolean | null; + /** + * Mspa Opt Out Option Mode + */ mspa_opt_out_option_mode?: boolean | null; + /** + * Mspa Covered Transactions + */ mspa_covered_transactions?: boolean | null; + /** + * Enable Tcfeu String + */ enable_tcfeu_string?: boolean | null; + /** + * Enabled + */ enabled: boolean; /** + * Cmp Api Required + * * Used by the CMP to determine if the GPP API is required as part of the CMP bundle */ cmp_api_required: boolean; diff --git a/clients/admin-ui/src/types/api/models/PrivacyExperienceMetaResponse.ts b/clients/admin-ui/src/types/api/models/PrivacyExperienceMetaResponse.ts index e79a279f6de..644b7ab7417 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyExperienceMetaResponse.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyExperienceMetaResponse.ts @@ -1,20 +1,25 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ComponentType } from "./ComponentType"; +import { ComponentType } from "./ComponentType"; import type { ExperienceMeta } from "./ExperienceMeta"; -import type { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; +import { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; /** + * PrivacyExperienceMetaResponse + * * Privacy Experience Response only containing region, component, id, and meta information */ export type PrivacyExperienceMetaResponse = { + /** + * Id + */ id: string; region: PrivacyNoticeRegion; component?: ComponentType | null; meta?: ExperienceMeta | null; /** + * Vendor Count + * * The number of vendors in the TCF experience. Only populated for TCF experiences. */ vendor_count?: number | null; diff --git a/clients/admin-ui/src/types/api/models/PrivacyExperienceResponse.ts b/clients/admin-ui/src/types/api/models/PrivacyExperienceResponse.ts index e938b03c18a..7ba816a8ae8 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyExperienceResponse.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyExperienceResponse.ts @@ -1,12 +1,10 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ExperienceConfigResponseNoNotices } from "./ExperienceConfigResponseNoNotices"; import type { ExperienceMeta } from "./ExperienceMeta"; import type { fidesplus__schemas__tcf_experience__TCFPublisherRestrictionResponse } from "./fidesplus__schemas__tcf_experience__TCFPublisherRestrictionResponse"; import type { PrivacyExperienceGPPSettings } from "./PrivacyExperienceGPPSettings"; -import type { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; +import { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; import type { PrivacyNoticeResponse } from "./PrivacyNoticeResponse"; import type { TCFFeatureRecord } from "./TCFFeatureRecord"; import type { TCFPurposeConsentRecord } from "./TCFPurposeConsentRecord"; @@ -18,6 +16,8 @@ import type { TCFVendorLegitimateInterestsRecord } from "./TCFVendorLegitimateIn import type { TCFVendorRelationships } from "./TCFVendorRelationships"; /** + * PrivacyExperienceResponse + * * An API representation of a PrivacyExperience used for response payloads * * Notices are extracted from the shared Experience Config and placed at the top-level here @@ -27,29 +27,81 @@ import type { TCFVendorRelationships } from "./TCFVendorRelationships"; * due to filtering */ export type PrivacyExperienceResponse = { + /** + * Id + */ id: string; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at: string; region: PrivacyNoticeRegion; gpp_settings?: PrivacyExperienceGPPSettings | null; + /** + * Tcf Purpose Consents + */ tcf_purpose_consents?: Array; + /** + * Tcf Purpose Legitimate Interests + */ tcf_purpose_legitimate_interests?: Array; + /** + * Tcf Special Purposes + */ tcf_special_purposes?: Array; + /** + * Tcf Features + */ tcf_features?: Array; + /** + * Tcf Special Features + */ tcf_special_features?: Array; + /** + * Tcf Vendor Consents + */ tcf_vendor_consents?: Array; + /** + * Tcf Vendor Legitimate Interests + */ tcf_vendor_legitimate_interests?: Array; + /** + * Tcf Vendor Relationships + */ tcf_vendor_relationships?: Array; + /** + * Tcf System Consents + */ tcf_system_consents?: Array; + /** + * Tcf System Legitimate Interests + */ tcf_system_legitimate_interests?: Array; + /** + * Tcf System Relationships + */ tcf_system_relationships?: Array; + /** + * Tcf Publisher Restrictions + */ tcf_publisher_restrictions?: Array; + /** + * Tcf Publisher Country Code + */ tcf_publisher_country_code?: string | null; /** + * Privacy Notices + * * The Privacy Notices associated with this experience, if applicable */ privacy_notices?: Array | null; /** + * Non Applicable Privacy Notices + * * The notice keys of the Privacy Notices that are enabled, but not applicable to the experience */ non_applicable_privacy_notices?: Array | null; @@ -57,11 +109,26 @@ export type PrivacyExperienceResponse = { * The Experience Config and its translations */ experience_config?: ExperienceConfigResponseNoNotices | null; - gvl?: null; - gvl_translations?: null; + /** + * Gvl + */ + gvl?: { + [key: string]: unknown; + } | null; + /** + * Gvl Translations + */ + gvl_translations?: { + [key: string]: unknown; + } | null; + /** + * Available Locales + */ available_locales?: Array | null; meta?: ExperienceMeta | null; /** + * Vendor Count + * * The number of vendors in the TCF experience. Only populated for TCF experiences. */ vendor_count?: number | null; diff --git a/clients/admin-ui/src/types/api/models/PrivacyNoticeCreation.ts b/clients/admin-ui/src/types/api/models/PrivacyNoticeCreation.ts index d8bec3cceaa..7096197ac2f 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyNoticeCreation.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyNoticeCreation.ts @@ -1,28 +1,55 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConsentMechanism } from "./ConsentMechanism"; -import type { EnforcementLevel } from "./EnforcementLevel"; +import { ConsentMechanism } from "./ConsentMechanism"; +import { EnforcementLevel } from "./EnforcementLevel"; import type { GPPFieldMappingCreate } from "./GPPFieldMappingCreate"; import type { MinimalPrivacyNotice } from "./MinimalPrivacyNotice"; import type { NoticeTranslationCreate } from "./NoticeTranslationCreate"; -import type { PrivacyNoticeFramework } from "./PrivacyNoticeFramework"; +import { PrivacyNoticeFramework } from "./PrivacyNoticeFramework"; /** + * PrivacyNoticeCreation + * * Establishes some fields required for creating and validation that can be performed up-front */ export type PrivacyNoticeCreation = { + /** + * Name + */ name: string; + /** + * Notice Key + */ notice_key?: string | null; + /** + * Internal Description + */ internal_description?: string | null; consent_mechanism: ConsentMechanism; + /** + * Data Uses + */ data_uses?: Array | null; enforcement_level: EnforcementLevel; + /** + * Disabled + */ disabled?: boolean | null; + /** + * Has Gpc Flag + */ has_gpc_flag?: boolean | null; framework?: PrivacyNoticeFramework | null; + /** + * Gpp Field Mapping + */ gpp_field_mapping?: Array | null; + /** + * Translations + */ translations?: Array | null; + /** + * Children + */ children?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyNoticeDisabledResponse.ts b/clients/admin-ui/src/types/api/models/PrivacyNoticeDisabledResponse.ts index a21eeb1590e..3525f02c30b 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyNoticeDisabledResponse.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyNoticeDisabledResponse.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PrivacyNoticeDisabledResponse + * * A minimal response for updating just whether a Privacy Notice is disabled */ export type PrivacyNoticeDisabledResponse = { + /** + * Disabled + */ disabled: boolean; + /** + * Id + */ id: string; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyNoticeDisabledUpdate.ts b/clients/admin-ui/src/types/api/models/PrivacyNoticeDisabledUpdate.ts index 9bc18bc3f02..69d5711e132 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyNoticeDisabledUpdate.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyNoticeDisabledUpdate.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PrivacyNoticeDisabledUpdate + * * A minimal request body that just allows you to update whether a Privacy Notice is disabled */ export type PrivacyNoticeDisabledUpdate = { + /** + * Disabled + */ disabled: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyNoticeFramework.ts b/clients/admin-ui/src/types/api/models/PrivacyNoticeFramework.ts index 9bbc33a671c..81772d5064b 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyNoticeFramework.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyNoticeFramework.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * PrivacyNoticeFramework + */ export enum PrivacyNoticeFramework { GPP_US_NATIONAL = "gpp_us_national", GPP_US_STATE = "gpp_us_state", diff --git a/clients/admin-ui/src/types/api/models/PrivacyNoticeRegion.ts b/clients/admin-ui/src/types/api/models/PrivacyNoticeRegion.ts index cae7e02eaaa..026264ebe95 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyNoticeRegion.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyNoticeRegion.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * PrivacyNoticeRegion + */ export enum PrivacyNoticeRegion { ER = "er", DJ = "dj", diff --git a/clients/admin-ui/src/types/api/models/PrivacyNoticeResponse.ts b/clients/admin-ui/src/types/api/models/PrivacyNoticeResponse.ts index 127f5f096b8..58a021fd8a9 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyNoticeResponse.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyNoticeResponse.ts @@ -1,39 +1,84 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { Asset } from "./Asset"; -import type { ConsentMechanism } from "./ConsentMechanism"; -import type { EnforcementLevel } from "./EnforcementLevel"; +import { ConsentMechanism } from "./ConsentMechanism"; +import { EnforcementLevel } from "./EnforcementLevel"; import type { GPPFieldMapping } from "./GPPFieldMapping"; +import type { MinimalAsset } from "./MinimalAsset"; import type { NoticeTranslationResponse } from "./NoticeTranslationResponse"; -import type { PrivacyNoticeFramework } from "./PrivacyNoticeFramework"; -import type { UserConsentPreference } from "./UserConsentPreference"; +import { PrivacyNoticeFramework } from "./PrivacyNoticeFramework"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * PrivacyNoticeResponse + * * An API representation of a PrivacyNotice used for response payloads * * Overrides fields from PrivacyNotice schema to indicate which ones * are guaranteed to be supplied */ export type PrivacyNoticeResponse = { + /** + * Name + */ name: string; + /** + * Notice Key + */ notice_key: string; + /** + * Internal Description + */ internal_description?: string | null; consent_mechanism: ConsentMechanism; + /** + * Data Uses + */ data_uses: Array; enforcement_level: EnforcementLevel; + /** + * Disabled + */ disabled: boolean; + /** + * Has Gpc Flag + */ has_gpc_flag: boolean; framework?: PrivacyNoticeFramework | null; default_preference?: UserConsentPreference | null; + /** + * Id + */ id: string; + /** + * Origin + */ origin?: string | null; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at: string; - cookies?: Array; + /** + * Cookies + */ + cookies?: Array; + /** + * Systems Applicable + */ systems_applicable?: boolean; + /** + * Translations + */ translations?: Array; + /** + * Children + */ children?: Array; + /** + * Gpp Field Mapping + */ gpp_field_mapping?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyNoticeResponseWithRegions.ts b/clients/admin-ui/src/types/api/models/PrivacyNoticeResponseWithRegions.ts index 254a18c654f..9d81d5dda0b 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyNoticeResponseWithRegions.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyNoticeResponseWithRegions.ts @@ -1,14 +1,14 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConsentMechanism } from "./ConsentMechanism"; -import type { EnforcementLevel } from "./EnforcementLevel"; +import { ConsentMechanism } from "./ConsentMechanism"; +import { EnforcementLevel } from "./EnforcementLevel"; import type { NoticeTranslationResponse } from "./NoticeTranslationResponse"; -import type { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; -import type { UserConsentPreference } from "./UserConsentPreference"; +import { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * PrivacyNoticeResponseWithRegions + * * Another limited Privacy Notice Schema for the Detail view in the Admin UI * - limits number of fields returned for performance. * @@ -16,20 +16,52 @@ import type { UserConsentPreference } from "./UserConsentPreference"; */ export type PrivacyNoticeResponseWithRegions = { default_preference?: UserConsentPreference | null; + /** + * Id + */ id: string; + /** + * Name + */ name: string; + /** + * Disabled + */ disabled: boolean; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at: string; consent_mechanism: ConsentMechanism; + /** + * Notice Key + */ notice_key: string; /** + * Configured Regions + * * A property calculated by observing which Experiences have linked this Notice */ configured_regions?: Array; + /** + * Data Uses + */ data_uses: Array; enforcement_level: EnforcementLevel; + /** + * Has Gpc Flag + */ has_gpc_flag: boolean; + /** + * Translations + */ translations?: Array; + /** + * Children + */ children?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyNoticeUpdate.ts b/clients/admin-ui/src/types/api/models/PrivacyNoticeUpdate.ts index 70afd2704ea..3f7cce87d66 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyNoticeUpdate.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyNoticeUpdate.ts @@ -1,31 +1,58 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConsentMechanism } from "./ConsentMechanism"; -import type { EnforcementLevel } from "./EnforcementLevel"; +import { ConsentMechanism } from "./ConsentMechanism"; +import { EnforcementLevel } from "./EnforcementLevel"; import type { GPPFieldMappingCreate } from "./GPPFieldMappingCreate"; import type { MinimalPrivacyNotice } from "./MinimalPrivacyNotice"; import type { NoticeTranslation } from "./NoticeTranslation"; -import type { PrivacyNoticeFramework } from "./PrivacyNoticeFramework"; +import { PrivacyNoticeFramework } from "./PrivacyNoticeFramework"; /** + * PrivacyNoticeUpdate + * * Overriding Privacy Notice schema for updates - translations and children must be supplied or they will * be removed. * * Other aspects will be validated on a dry update after patch updates are applied against PrivacyNoticeCreation */ export type PrivacyNoticeUpdate = { + /** + * Name + */ name?: string | null; + /** + * Notice Key + */ notice_key?: string | null; + /** + * Internal Description + */ internal_description?: string | null; consent_mechanism?: ConsentMechanism | null; + /** + * Data Uses + */ data_uses?: Array | null; enforcement_level?: EnforcementLevel | null; + /** + * Disabled + */ disabled?: boolean | null; + /** + * Has Gpc Flag + */ has_gpc_flag?: boolean | null; framework?: PrivacyNoticeFramework | null; + /** + * Gpp Field Mapping + */ gpp_field_mapping?: Array | null; + /** + * Translations + */ translations: Array; + /** + * Children + */ children: Array; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyPreferenceStats.ts b/clients/admin-ui/src/types/api/models/PrivacyPreferenceStats.ts index ab309d35d10..7b5d16444c7 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyPreferenceStats.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyPreferenceStats.ts @@ -1,9 +1,12 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * PrivacyPreferenceStats + */ export type PrivacyPreferenceStats = { /** + * Estimated Count + * * Estimated count of privacy preferencehistory table using stats collector for fast reads */ estimated_count?: number; diff --git a/clients/admin-ui/src/types/api/models/PrivacyPreferencesRequest.ts b/clients/admin-ui/src/types/api/models/PrivacyPreferencesRequest.ts index 4145b24cc39..7644e6319e7 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyPreferencesRequest.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyPreferencesRequest.ts @@ -1,11 +1,9 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConsentMethod } from "./ConsentMethod"; +import { ConsentMethod } from "./ConsentMethod"; import type { ConsentOptionCreate } from "./ConsentOptionCreate"; -import type { Identity } from "./Identity"; -import type { PrivacyRequestSource } from "./PrivacyRequestSource"; +import type { fides__api__schemas__redis_cache__Identity } from "./fides__api__schemas__redis_cache__Identity"; +import { PrivacyRequestSource } from "./PrivacyRequestSource"; import type { TCFFeatureSave } from "./TCFFeatureSave"; import type { TCFPurposeSave } from "./TCFPurposeSave"; import type { TCFSpecialFeatureSave } from "./TCFSpecialFeatureSave"; @@ -13,6 +11,8 @@ import type { TCFSpecialPurposeSave } from "./TCFSpecialPurposeSave"; import type { TCFVendorSave } from "./TCFVendorSave"; /** + * PrivacyPreferencesRequest + * * Request body for saving PrivacyPreferences. * * "preferences" key reserved for saving preferences against a privacy notice. @@ -20,28 +20,85 @@ import type { TCFVendorSave } from "./TCFVendorSave"; * New *_preferences fields are used for saving preferences against various tcf components. */ export type PrivacyPreferencesRequest = { + /** + * Purpose Consent Preferences + */ purpose_consent_preferences?: Array; + /** + * Purpose Legitimate Interests Preferences + */ purpose_legitimate_interests_preferences?: Array; + /** + * Vendor Consent Preferences + */ vendor_consent_preferences?: Array; + /** + * Vendor Legitimate Interests Preferences + */ vendor_legitimate_interests_preferences?: Array; + /** + * Special Feature Preferences + */ special_feature_preferences?: Array; + /** + * Special Purpose Preferences + */ special_purpose_preferences?: Array; + /** + * Feature Preferences + */ feature_preferences?: Array; + /** + * System Consent Preferences + */ system_consent_preferences?: Array; + /** + * System Legitimate Interests Preferences + */ system_legitimate_interests_preferences?: Array; + /** + * Preferences + */ preferences?: Array; /** + * Fides String + * * If supplied, TC strings and AC strings are decoded and preferences saved for purpose_consent, purpose_legitimate_interests, vendor_consent, vendor_legitimate_interests, and special_features */ fides_string?: string | null; + /** + * Policy Key + */ policy_key?: string | null; + /** + * Privacy Experience Id + */ privacy_experience_id?: string | null; + /** + * Privacy Experience Config History Id + */ privacy_experience_config_history_id?: string | null; + /** + * User Geography + */ user_geography?: string | null; method?: ConsentMethod | null; + /** + * Served Notice History Id + */ served_notice_history_id?: string | null; + /** + * Property Id + */ property_id?: string | null; source?: PrivacyRequestSource | null; - browser_identity: Identity; + browser_identity: fides__api__schemas__redis_cache__Identity; + /** + * Code + */ code?: string | null; + /** + * Received At + */ + received_at?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestAccessResults.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestAccessResults.ts index 2a5921b88a8..04caa16cea4 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyRequestAccessResults.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestAccessResults.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PrivacyRequestAccessResults + * * Schema for the access results of a PrivacyRequest */ export type PrivacyRequestAccessResults = { + /** + * Access Result Urls + */ access_result_urls: Array; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestBulkSelection.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestBulkSelection.ts new file mode 100644 index 00000000000..81bdb06e175 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestBulkSelection.ts @@ -0,0 +1,34 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { PrivacyRequestFilter } from "./PrivacyRequestFilter"; + +/** + * PrivacyRequestBulkSelection + * + * Select privacy requests for bulk actions using either explicit IDs or filters. + * + * If request_ids is provided, it will be used directly. + * If filters is provided (without request_ids), filters will be used to select privacy requests, + * with optional exclusions via exclude_ids. + * + * For backwards compatibility, a plain list of request IDs is also accepted and will be + * automatically converted to {"request_ids": [...]}. + */ +export type PrivacyRequestBulkSelection = { + /** + * Request Ids + * + * List of privacy request IDs to act on. The backend will automatically batch requests if the list is large. + */ + request_ids?: Array | null; + /** + * Filters to select privacy requests (only used when request_ids is not provided) + */ + filters?: PrivacyRequestFilter | null; + /** + * Exclude Ids + * + * List of privacy request IDs to exclude from the action (only used with filters) + */ + exclude_ids?: Array | null; +}; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestCreate.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestCreate.ts deleted file mode 100644 index 1c3dfde8b90..00000000000 --- a/clients/admin-ui/src/types/api/models/PrivacyRequestCreate.ts +++ /dev/null @@ -1,30 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -import type { Consent } from "./Consent"; -import type { fides__api__schemas__redis_cache__CustomPrivacyRequestField } from "./fides__api__schemas__redis_cache__CustomPrivacyRequestField"; -import type { Identity } from "./Identity"; -import type { PrivacyRequestSource } from "./PrivacyRequestSource"; - -/** - * Data required to create a PrivacyRequest - */ -export type PrivacyRequestCreate = { - external_id?: string | null; - started_processing_at?: string | null; - finished_processing_at?: string | null; - requested_at?: string | null; - identity: Identity; - consent_request_id?: string | null; - custom_privacy_request_fields?: Record< - string, - fides__api__schemas__redis_cache__CustomPrivacyRequestField - > | null; - policy_key: string; - encryption_key?: string | null; - property_id?: string | null; - consent_preferences?: Array | null; - source?: PrivacyRequestSource | null; - location?: string | null; -}; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestCreateExtended.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestCreateExtended.ts new file mode 100644 index 00000000000..6db338cd1ed --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestCreateExtended.ts @@ -0,0 +1,75 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { ActionType } from "./ActionType"; +import type { Consent } from "./Consent"; +import type { fides__api__schemas__redis_cache__CustomPrivacyRequestField } from "./fides__api__schemas__redis_cache__CustomPrivacyRequestField"; +import type { fides__api__schemas__redis_cache__Identity } from "./fides__api__schemas__redis_cache__Identity"; +import { PrivacyRequestSource } from "./PrivacyRequestSource"; + +/** + * PrivacyRequestCreateExtended + * + * Extended PrivacyRequestCreate schema with optional policy_key and optional action_type. + * + * Either policy_key OR action_type must be provided. + * + * If policy_key is provided, it will be used directly. + * If only action_type is provided, the system will evaluate policy conditions + * to determine the appropriate policy with that action type. + */ +export type PrivacyRequestCreateExtended = { + /** + * External Id + */ + external_id?: string | null; + /** + * Started Processing At + */ + started_processing_at?: string | null; + /** + * Finished Processing At + */ + finished_processing_at?: string | null; + /** + * Requested At + */ + requested_at?: string | null; + identity: fides__api__schemas__redis_cache__Identity; + /** + * Consent Request Id + */ + consent_request_id?: string | null; + /** + * Custom Privacy Request Fields + */ + custom_privacy_request_fields?: { + [key: string]: fides__api__schemas__redis_cache__CustomPrivacyRequestField; + } | null; + /** + * Policy Key + * + * Optional policy key. If not provided, policy will be determined by evaluating policy conditions using action_type. + */ + policy_key?: string | null; + /** + * Encryption Key + */ + encryption_key?: string | null; + /** + * Property Id + */ + property_id?: string | null; + /** + * Consent Preferences + */ + consent_preferences?: Array | null; + source?: PrivacyRequestSource | null; + /** + * Location + */ + location?: string | null; + /** + * Optional action type (access, erasure, etc.) to filter policies during conditional evaluation. Required if policy_key is not provided. + */ + action_type?: ActionType | null; +}; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestDRPStatus.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestDRPStatus.ts index cf5c97516c8..0ca688e1941 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyRequestDRPStatus.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestDRPStatus.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PrivacyRequestDRPStatus + * * A list of privacy request statuses specified by the Data Rights Protocol. */ export enum PrivacyRequestDRPStatus { diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestDRPStatusResponse.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestDRPStatusResponse.ts index b6a74a4ad6b..e8536362be4 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyRequestDRPStatusResponse.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestDRPStatusResponse.ts @@ -1,18 +1,36 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { PrivacyRequestDRPStatus } from "./PrivacyRequestDRPStatus"; +import { PrivacyRequestDRPStatus } from "./PrivacyRequestDRPStatus"; /** + * PrivacyRequestDRPStatusResponse + * * A Fidesops PrivacyRequest updated to fit the Data Rights Protocol specification. */ export type PrivacyRequestDRPStatusResponse = { + /** + * Request Id + */ request_id: string; + /** + * Received At + */ received_at: string; + /** + * Expected By + */ expected_by?: string | null; + /** + * Processing Details + */ processing_details?: string | null; status: PrivacyRequestDRPStatus; + /** + * Reason + */ reason?: string | null; + /** + * User Verification Url + */ user_verification_url?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestDiagnosticsExportResponse.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestDiagnosticsExportResponse.ts index 5f67986a1d2..007d60011c0 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyRequestDiagnosticsExportResponse.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestDiagnosticsExportResponse.ts @@ -1,13 +1,25 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PrivacyRequestDiagnosticsExportResponse + * * Response payload for a diagnostics export request. */ export type PrivacyRequestDiagnosticsExportResponse = { + /** + * Download Url + */ download_url: string; + /** + * Storage Type + */ storage_type: string; + /** + * Object Key + */ object_key: string; + /** + * Created At + */ created_at: string; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestFieldDefinition.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestFieldDefinition.ts new file mode 100644 index 00000000000..ab9e69c46af --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestFieldDefinition.ts @@ -0,0 +1,35 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * PrivacyRequestFieldDefinition + * + * Schema for privacy request field definition. + * + * This defines the structure of leaf nodes in the nested privacy request fields response. + */ +export type PrivacyRequestFieldDefinition = { + /** + * Field Path + * + * Path to the field + */ + field_path: string; + /** + * Field Type + * + * Type of the field + */ + field_type: "string" | "integer" | "boolean" | "array"; + /** + * Description + * + * Description of the field + */ + description: string; + /** + * Is Convenience Field + * + * Whether this is a convenience field for easier access + */ + is_convenience_field: boolean; +}; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestFieldsResponse.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestFieldsResponse.ts new file mode 100644 index 00000000000..352060d5f1e --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestFieldsResponse.ts @@ -0,0 +1,18 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { NestedFieldDict } from "./NestedFieldDict"; + +/** + * PrivacyRequestFieldsResponse + * + * Schema for privacy request fields response. + * + * The structure is a nested dictionary where leaf nodes are PrivacyRequestFieldDefinition objects. + * Supports arbitrary nesting depth (e.g., privacy_request.custom_privacy_request_fields.tenant_id). + */ +export type PrivacyRequestFieldsResponse = { + /** + * Nested dictionary of available privacy request fields. Leaf nodes are PrivacyRequestFieldDefinition objects. + */ + privacy_request: NestedFieldDict; +}; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestFilter.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestFilter.ts index 8ee18d39db8..2fc896b55f9 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyRequestFilter.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestFilter.ts @@ -1,33 +1,104 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ActionType } from "./ActionType"; -import type { ColumnSort } from "./ColumnSort"; -import type { PrivacyRequestStatus } from "./PrivacyRequestStatus"; +import { ActionType } from "./ActionType"; +import { ColumnSort } from "./ColumnSort"; +import { PrivacyRequestStatus } from "./PrivacyRequestStatus"; +/** + * PrivacyRequestFilter + */ export type PrivacyRequestFilter = { + /** + * Request Id + */ request_id?: string | null; - identities?: null; + /** + * Identities + */ + identities?: { + [key: string]: unknown; + } | null; + /** + * Fuzzy Search Str + */ fuzzy_search_str?: string | null; - custom_privacy_request_fields?: Record | null; + /** + * Custom Privacy Request Fields + */ + custom_privacy_request_fields?: { + [key: string]: unknown; + } | null; + /** + * Status + */ status?: PrivacyRequestStatus | Array | null; + /** + * Created Lt + */ created_lt?: string | null; + /** + * Created Gt + */ created_gt?: string | null; + /** + * Started Lt + */ started_lt?: string | null; + /** + * Started Gt + */ started_gt?: string | null; + /** + * Completed Lt + */ completed_lt?: string | null; + /** + * Completed Gt + */ completed_gt?: string | null; + /** + * Errored Lt + */ errored_lt?: string | null; + /** + * Errored Gt + */ errored_gt?: string | null; + /** + * External Id + */ external_id?: string | null; + /** + * Location + */ location?: string | null; - action_type?: ActionType[] | null; + /** + * Action Type + */ + action_type?: ActionType | Array | null; + /** + * Verbose + */ verbose?: boolean | null; + /** + * Include Identities + */ include_identities?: boolean | null; + /** + * Include Custom Privacy Request Fields + */ include_custom_privacy_request_fields?: boolean | null; + /** + * Include Deleted Requests + */ include_deleted_requests?: boolean | null; + /** + * Download Csv + */ download_csv?: boolean | null; - sort_field?: string | null; - sort_direction?: ColumnSort | null; + /** + * Sort Field + */ + sort_field?: string; + sort_direction?: ColumnSort; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestNotificationInfo.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestNotificationInfo.ts index d18dc1eeef7..7e883468c8c 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyRequestNotificationInfo.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestNotificationInfo.ts @@ -1,8 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * PrivacyRequestNotificationInfo + */ export type PrivacyRequestNotificationInfo = { + /** + * Email Addresses + */ email_addresses: Array; + /** + * Notify After Failures + */ notify_after_failures: number; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestOption.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestOption.ts index 00b805305b1..44248ca7fbe 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyRequestOption.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestOption.ts @@ -1,25 +1,53 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { fides__api__schemas__privacy_center_config__CustomPrivacyRequestField } from "./fides__api__schemas__privacy_center_config__CustomPrivacyRequestField"; import type { IdentityInputs } from "./IdentityInputs"; import type { LocationCustomPrivacyRequestField } from "./LocationCustomPrivacyRequestField"; -import type { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; +import { PrivacyNoticeRegion } from "./PrivacyNoticeRegion"; +/** + * PrivacyRequestOption + */ export type PrivacyRequestOption = { + /** + * Locations + */ locations?: Array | "fallback" | null; + /** + * Policy Key + */ policy_key?: string | null; + /** + * Icon Path + */ icon_path: string; + /** + * Title + */ title: string; + /** + * Description + */ description: string; + /** + * Description Subtext + */ description_subtext?: Array | null; + /** + * Confirmbuttontext + */ confirmButtonText?: string | null; + /** + * Cancelbuttontext + */ cancelButtonText?: string | null; identity_inputs?: IdentityInputs | null; - custom_privacy_request_fields?: Record< - string, - | LocationCustomPrivacyRequestField - | fides__api__schemas__privacy_center_config__CustomPrivacyRequestField - > | null; + /** + * Custom Privacy Request Fields + */ + custom_privacy_request_fields?: { + [key: string]: + | LocationCustomPrivacyRequestField + | fides__api__schemas__privacy_center_config__CustomPrivacyRequestField; + } | null; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestRedactionPatternsRequest.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestRedactionPatternsRequest.ts new file mode 100644 index 00000000000..e4ce1d31a4d --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestRedactionPatternsRequest.ts @@ -0,0 +1,15 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * PrivacyRequestRedactionPatternsRequest + * + * Request schema for updating privacy request redaction patterns. + */ +export type PrivacyRequestRedactionPatternsRequest = { + /** + * Patterns + * + * List of regex patterns used to redact dataset, collection, and field names in privacy request package reports + */ + patterns: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestRedactionPatternsResponse.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestRedactionPatternsResponse.ts new file mode 100644 index 00000000000..ec6f284cf49 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestRedactionPatternsResponse.ts @@ -0,0 +1,15 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * PrivacyRequestRedactionPatternsResponse + * + * Response schema for privacy request redaction patterns. + */ +export type PrivacyRequestRedactionPatternsResponse = { + /** + * Patterns + * + * List of regex patterns used to redact dataset, collection, and field names in privacy request package reports + */ + patterns: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestResponse.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestResponse.ts index b7354660c92..22f29315c05 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyRequestResponse.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestResponse.ts @@ -1,49 +1,117 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { CheckpointActionRequiredDetails } from "./CheckpointActionRequiredDetails"; -import type { IdentityValue } from "./IdentityValue"; +import type { fides__api__schemas__privacy_request__IdentityValue } from "./fides__api__schemas__privacy_request__IdentityValue"; import type { PolicyResponse } from "./PolicyResponse"; -import type { PrivacyRequestSource } from "./PrivacyRequestSource"; -import type { PrivacyRequestStatus } from "./PrivacyRequestStatus"; +import { PrivacyRequestSource } from "./PrivacyRequestSource"; +import { PrivacyRequestStatus } from "./PrivacyRequestStatus"; import type { PrivacyRequestUser } from "./PrivacyRequestUser"; /** + * PrivacyRequestResponse + * * Schema to check the status of a PrivacyRequest */ export type PrivacyRequestResponse = { + /** + * Id + */ id: string; + /** + * Created At + */ created_at?: string | null; + /** + * Started Processing At + */ started_processing_at?: string | null; + /** + * Reviewed At + */ reviewed_at?: string | null; + /** + * Reviewed By + */ reviewed_by?: string | null; + /** + * Submitted By + */ submitted_by?: string | null; reviewer?: PrivacyRequestUser | null; submitter?: PrivacyRequestUser | null; + /** + * Finished Processing At + */ finished_processing_at?: string | null; + /** + * Identity Verified At + */ identity_verified_at?: string | null; + /** + * Paused At + */ paused_at?: string | null; status: PrivacyRequestStatus; + /** + * External Id + */ external_id?: string | null; - identity?: Record | null; - // custom_privacy_request_fields was manually overriden to have the correct type - // until the generated types work correctly - custom_privacy_request_fields?: Record< - string, - { label: string; value: string | number | Array } - > | null; + /** + * Identity + */ + identity?: { + [key: string]: + | string + | fides__api__schemas__privacy_request__IdentityValue + | null; + } | null; + /** + * Custom Privacy Request Fields + */ + custom_privacy_request_fields?: { + [key: string]: unknown; + } | null; policy: PolicyResponse; action_required_details?: CheckpointActionRequiredDetails | null; + /** + * Resume Endpoint + */ resume_endpoint?: string | null; + /** + * Days Left + */ days_left?: number | null; + /** + * Custom Privacy Request Fields Approved By + */ custom_privacy_request_fields_approved_by?: string | null; + /** + * Custom Privacy Request Fields Approved At + */ custom_privacy_request_fields_approved_at?: string | null; source?: PrivacyRequestSource | null; + /** + * Location + */ location?: string | null; + /** + * Deleted At + */ deleted_at?: string | null; + /** + * Deleted By + */ deleted_by?: string | null; + /** + * Finalized At + */ finalized_at?: string | null; + /** + * Finalized By + */ finalized_by?: string | null; + /** + * Duplicate Request Group Id + */ duplicate_request_group_id?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestResumeFormat.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestResumeFormat.ts index a7d6dc806f0..7d1a7744d2d 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyRequestResumeFormat.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestResumeFormat.ts @@ -1,12 +1,12 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { Identity } from "./Identity"; +import type { fides__api__schemas__redis_cache__Identity } from "./fides__api__schemas__redis_cache__Identity"; /** + * PrivacyRequestResumeFormat + * * Expected request body to resume a privacy request after it was paused by a webhook */ export type PrivacyRequestResumeFormat = { - derived_identity?: Identity | null; + derived_identity?: fides__api__schemas__redis_cache__Identity | null; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestSource.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestSource.ts index 89d3e7458d2..6da586d45ff 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyRequestSource.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestSource.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PrivacyRequestSource + * * The source where the privacy request originated from * * - Privacy Center: Request created from the Privacy Center diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestStatus.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestStatus.ts index da8dd52ee39..d75e9f39d66 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyRequestStatus.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestStatus.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PrivacyRequestStatus + * * Enum for privacy request statuses, reflecting where they are in the Privacy Request Lifecycle */ export enum PrivacyRequestStatus { @@ -16,6 +16,7 @@ export enum PrivacyRequestStatus { PAUSED = "paused", AWAITING_EMAIL_SEND = "awaiting_email_send", REQUIRES_MANUAL_FINALIZATION = "requires_manual_finalization", + PENDING_EXTERNAL = "pending_external", CANCELED = "canceled", ERROR = "error", DUPLICATE = "duplicate", diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestTaskSchema.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestTaskSchema.ts index b1190535a3b..71803bea98f 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyRequestTaskSchema.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestTaskSchema.ts @@ -1,20 +1,38 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ActionType } from "./ActionType"; -import type { ExecutionLogStatus } from "./ExecutionLogStatus"; +import { ActionType } from "./ActionType"; +import { ExecutionLogStatus } from "./ExecutionLogStatus"; /** + * PrivacyRequestTaskSchema + * * Schema for Privacy Request Tasks, which are individual nodes that are queued */ export type PrivacyRequestTaskSchema = { status: ExecutionLogStatus; + /** + * Id + */ id: string; + /** + * Collection Address + */ collection_address: string; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at: string; + /** + * Upstream Tasks + */ upstream_tasks: Array; + /** + * Downstream Tasks + */ downstream_tasks: Array; action_type: ActionType; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestUser.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestUser.ts index 9498c3571b2..fcd2206682b 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyRequestUser.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestUser.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PrivacyRequestUser + * * Data we can expose via PrivacyRequest user relations (reviewer, submitter, etc.) */ export type PrivacyRequestUser = { + /** + * Id + */ id: string; + /** + * Username + */ username: string; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRequestVerboseResponse.ts b/clients/admin-ui/src/types/api/models/PrivacyRequestVerboseResponse.ts index 719c3ee2e98..c0253cc32dc 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyRequestVerboseResponse.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyRequestVerboseResponse.ts @@ -1,45 +1,125 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { CheckpointActionRequiredDetails } from "./CheckpointActionRequiredDetails"; import type { ExecutionAndAuditLogResponse } from "./ExecutionAndAuditLogResponse"; +import type { fides__api__schemas__privacy_request__IdentityValue } from "./fides__api__schemas__privacy_request__IdentityValue"; import type { PolicyResponse } from "./PolicyResponse"; -import type { PrivacyRequestSource } from "./PrivacyRequestSource"; -import type { PrivacyRequestStatus } from "./PrivacyRequestStatus"; +import { PrivacyRequestSource } from "./PrivacyRequestSource"; +import { PrivacyRequestStatus } from "./PrivacyRequestStatus"; import type { PrivacyRequestUser } from "./PrivacyRequestUser"; /** + * PrivacyRequestVerboseResponse + * * The schema for the more detailed PrivacyRequest response containing both * detailed execution logs and audit logs. */ export type PrivacyRequestVerboseResponse = { + /** + * Id + */ id: string; + /** + * Created At + */ created_at?: string | null; + /** + * Started Processing At + */ started_processing_at?: string | null; + /** + * Reviewed At + */ reviewed_at?: string | null; + /** + * Reviewed By + */ reviewed_by?: string | null; + /** + * Submitted By + */ submitted_by?: string | null; reviewer?: PrivacyRequestUser | null; submitter?: PrivacyRequestUser | null; + /** + * Finished Processing At + */ finished_processing_at?: string | null; + /** + * Identity Verified At + */ identity_verified_at?: string | null; + /** + * Paused At + */ paused_at?: string | null; status: PrivacyRequestStatus; + /** + * External Id + */ external_id?: string | null; - identity?: Record | null; - custom_privacy_request_fields?: null; + /** + * Identity + */ + identity?: { + [key: string]: + | string + | fides__api__schemas__privacy_request__IdentityValue + | null; + } | null; + /** + * Custom Privacy Request Fields + */ + custom_privacy_request_fields?: { + [key: string]: unknown; + } | null; policy: PolicyResponse; action_required_details?: CheckpointActionRequiredDetails | null; + /** + * Resume Endpoint + */ resume_endpoint?: string | null; + /** + * Days Left + */ days_left?: number | null; + /** + * Custom Privacy Request Fields Approved By + */ custom_privacy_request_fields_approved_by?: string | null; + /** + * Custom Privacy Request Fields Approved At + */ custom_privacy_request_fields_approved_at?: string | null; source?: PrivacyRequestSource | null; + /** + * Location + */ location?: string | null; + /** + * Deleted At + */ deleted_at?: string | null; + /** + * Deleted By + */ deleted_by?: string | null; + /** + * Finalized At + */ finalized_at?: string | null; + /** + * Finalized By + */ finalized_by?: string | null; - results: Record>; + /** + * Duplicate Request Group Id + */ + duplicate_request_group_id?: string | null; + /** + * Results + */ + results: { + [key: string]: Array; + }; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyRule.ts b/clients/admin-ui/src/types/api/models/PrivacyRule.ts index 22dd8a804c5..de6045d35fa 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyRule.ts +++ b/clients/admin-ui/src/types/api/models/PrivacyRule.ts @@ -1,10 +1,10 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { MatchesEnum } from "./MatchesEnum"; +import { MatchesEnum } from "./MatchesEnum"; /** + * PrivacyRule + * * The PrivacyRule resource model. * * A list of privacy data types and what match method to use. @@ -19,6 +19,8 @@ export type PrivacyRule = { */ matches: MatchesEnum; /** + * Values + * * A list of fides keys to be used with the matching type in a privacy rule. */ values: Array; diff --git a/clients/admin-ui/src/types/api/models/PromoteErrorInfo.ts b/clients/admin-ui/src/types/api/models/PromoteErrorInfo.ts new file mode 100644 index 00000000000..bd863a72cb6 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PromoteErrorInfo.ts @@ -0,0 +1,21 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * PromoteErrorInfo + * + * Information about a failed promotion in bulk operations. + */ +export type PromoteErrorInfo = { + /** + * Urn + * + * URN of the staged resource that failed + */ + urn: string; + /** + * Error + * + * Error message describing the failure + */ + error: string; +}; diff --git a/clients/admin-ui/src/types/api/models/PromoteResourcesResponse.ts b/clients/admin-ui/src/types/api/models/PromoteResourcesResponse.ts index 42e77bc75b2..a6c4c69f05b 100644 --- a/clients/admin-ui/src/types/api/models/PromoteResourcesResponse.ts +++ b/clients/admin-ui/src/types/api/models/PromoteResourcesResponse.ts @@ -1,12 +1,14 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PromoteResourcesResponse + * * Response model for promote operations on staged resources */ export type PromoteResourcesResponse = { /** + * Task Id + * * The task ID of the promote operation */ task_id?: string | null; diff --git a/clients/admin-ui/src/types/api/models/PromoteResponse.ts b/clients/admin-ui/src/types/api/models/PromoteResponse.ts new file mode 100644 index 00000000000..b0f1824547e --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PromoteResponse.ts @@ -0,0 +1,27 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * PromoteResponse + * + * Response for single staged resource promotion to System. + */ +export type PromoteResponse = { + /** + * System Id + * + * ID of the created System + */ + system_id: string; + /** + * System Key + * + * Fides key of the created System + */ + system_key: string; + /** + * System Name + * + * Name of the created System + */ + system_name: string; +}; diff --git a/clients/admin-ui/src/types/api/models/PromoteSummary.ts b/clients/admin-ui/src/types/api/models/PromoteSummary.ts new file mode 100644 index 00000000000..e7659baa891 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PromoteSummary.ts @@ -0,0 +1,27 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * PromoteSummary + * + * Summary statistics for bulk promotion operations. + */ +export type PromoteSummary = { + /** + * Total Requested + * + * Total number of URNs requested + */ + total_requested: number; + /** + * Successful + * + * Number of successful promotions + */ + successful: number; + /** + * Failed + * + * Number of failed promotions + */ + failed: number; +}; diff --git a/clients/admin-ui/src/types/api/models/PromotedSystemInfo.ts b/clients/admin-ui/src/types/api/models/PromotedSystemInfo.ts new file mode 100644 index 00000000000..a5cac0e4e0e --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PromotedSystemInfo.ts @@ -0,0 +1,33 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * PromotedSystemInfo + * + * Information about a successfully promoted system in bulk operations. + */ +export type PromotedSystemInfo = { + /** + * Urn + * + * URN of the promoted staged resource + */ + urn: string; + /** + * System Id + * + * ID of the created System + */ + system_id: string; + /** + * System Key + * + * Fides key of the created System + */ + system_key: string; + /** + * System Name + * + * Name of the created System + */ + system_name: string; +}; diff --git a/clients/admin-ui/src/types/api/models/PromptCategory.ts b/clients/admin-ui/src/types/api/models/PromptCategory.ts new file mode 100644 index 00000000000..5afe103d8da --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PromptCategory.ts @@ -0,0 +1,11 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * PromptCategory + * + * Categories of prompts available in the system. + */ +export enum PromptCategory { + ASSESSMENT = "assessment", + QUESTIONNAIRE = "questionnaire", +} diff --git a/clients/admin-ui/src/types/api/models/PromptInfo.ts b/clients/admin-ui/src/types/api/models/PromptInfo.ts new file mode 100644 index 00000000000..f5063a6ad3b --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PromptInfo.ts @@ -0,0 +1,38 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { PromptCategory } from "./PromptCategory"; +import { PromptType } from "./PromptType"; + +/** + * PromptInfo + * + * Information about an available prompt. + */ +export type PromptInfo = { + /** + * Id + */ + id: string; + /** + * Name + */ + name: string; + /** + * Description + */ + description: string; + category: PromptCategory; + prompt_type: PromptType; + /** + * Template Variables + * + * Variables that can be substituted in the prompt + */ + template_variables?: Array; + /** + * Data Sections + * + * Data sections that can be included from Fides + */ + data_sections?: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/PromptType.ts b/clients/admin-ui/src/types/api/models/PromptType.ts new file mode 100644 index 00000000000..388143ade89 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PromptType.ts @@ -0,0 +1,14 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * PromptType + * + * Specific prompt types. + */ +export enum PromptType { + ASSESSMENT_ANALYSIS = "assessment_analysis", + INTENT_CLASSIFICATION = "intent_classification", + MESSAGE_GENERATION = "message_generation", + QUESTION_REPHRASE = "question_rephrase", + QUESTION_REPHRASE_BATCH = "question_rephrase_batch", +} diff --git a/clients/admin-ui/src/types/api/models/PropagationPolicyKey.ts b/clients/admin-ui/src/types/api/models/PropagationPolicyKey.ts index ef6128b8a41..b583d063c38 100644 --- a/clients/admin-ui/src/types/api/models/PropagationPolicyKey.ts +++ b/clients/admin-ui/src/types/api/models/PropagationPolicyKey.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * PropagationPolicyKey + * * Propagation policy keys for propagating a consent choice up or down the hierarchy of notices. * Each policy key has its own PropagationPolicy implementation. */ @@ -11,5 +11,6 @@ export enum PropagationPolicyKey { CASCADE_DOWN_ALL = "cascade_down_all", CASCADE_UP_ALL = "cascade_up_all", CASCADE_UP_ALL_CASCADE_DOWN_ALL = "cascade_up_all_cascade_down_all", + CASCADE_UP_OPT_IN_ALL_OPT_OUT_CONSERVATIVE = "cascade_up_opt_in_all_opt_out_conservative", CASCADE_DOWN_ALL_CASCADE_UP_OPT_IN_ALL_OPT_OUT_CONSERVATIVE = "cascade_down_all_cascade_up_opt_in_all_opt_out_conservative", } diff --git a/clients/admin-ui/src/types/api/models/Property.ts b/clients/admin-ui/src/types/api/models/Property.ts index 314055c827a..c17310711f6 100644 --- a/clients/admin-ui/src/types/api/models/Property.ts +++ b/clients/admin-ui/src/types/api/models/Property.ts @@ -1,13 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +import type { fides__api__schemas__privacy_center_config__PrivacyCenterConfig } from "./fides__api__schemas__privacy_center_config__PrivacyCenterConfig"; import type { MinimalMessagingTemplate } from "./MinimalMessagingTemplate"; import type { MinimalPrivacyExperienceConfig } from "./MinimalPrivacyExperienceConfig"; -import type { PrivacyCenterConfig } from "./PrivacyCenterConfig"; -import type { PropertyType } from "./PropertyType"; +import { PropertyType } from "./PropertyType"; /** + * Property + * * A schema representing the complete `Property` model. * * This schema extends the base `PublicPropertyResponse` schema, @@ -18,12 +18,30 @@ import type { PropertyType } from "./PropertyType"; * API responses should be added to this schema. */ export type Property = { + /** + * Name + */ name: string; type: PropertyType; + /** + * Id + */ id?: string | null; + /** + * Experiences + */ experiences: Array; + /** + * Messaging Templates + */ messaging_templates?: Array | null; - privacy_center_config?: PrivacyCenterConfig | null; + privacy_center_config?: fides__api__schemas__privacy_center_config__PrivacyCenterConfig | null; + /** + * Stylesheet + */ stylesheet?: string | null; + /** + * Paths + */ paths: Array; }; diff --git a/clients/admin-ui/src/types/api/models/PropertyCreate.ts b/clients/admin-ui/src/types/api/models/PropertyCreate.ts index 2746c43f708..0fb4e8213a0 100644 --- a/clients/admin-ui/src/types/api/models/PropertyCreate.ts +++ b/clients/admin-ui/src/types/api/models/PropertyCreate.ts @@ -1,17 +1,33 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +import type { fides__api__schemas__privacy_center_config__PrivacyCenterConfig } from "./fides__api__schemas__privacy_center_config__PrivacyCenterConfig"; import type { MinimalPrivacyExperienceConfig } from "./MinimalPrivacyExperienceConfig"; -import type { PrivacyCenterConfig } from "./PrivacyCenterConfig"; -import type { PropertyType } from "./PropertyType"; +import { PropertyType } from "./PropertyType"; +/** + * PropertyCreate + */ export type PropertyCreate = { + /** + * Name + */ name: string; type: PropertyType; + /** + * Id + */ id?: string | null; + /** + * Experiences + */ experiences: Array; - privacy_center_config?: PrivacyCenterConfig | null; + privacy_center_config?: fides__api__schemas__privacy_center_config__PrivacyCenterConfig | null; + /** + * Stylesheet + */ stylesheet?: string | null; + /** + * Paths + */ paths: Array; }; diff --git a/clients/admin-ui/src/types/api/models/PropertyNameResolutionRequest.ts b/clients/admin-ui/src/types/api/models/PropertyNameResolutionRequest.ts new file mode 100644 index 00000000000..d23d3aa572c --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PropertyNameResolutionRequest.ts @@ -0,0 +1,13 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * PropertyNameResolutionRequest + * + * Request schema for resolving property names to IDs. + */ +export type PropertyNameResolutionRequest = { + /** + * Property Names + */ + property_names: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/PropertyNameResolutionResponse.ts b/clients/admin-ui/src/types/api/models/PropertyNameResolutionResponse.ts new file mode 100644 index 00000000000..4afce467570 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/PropertyNameResolutionResponse.ts @@ -0,0 +1,13 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * PropertyNameResolutionResponse + * + * Response schema for resolved property name-to-ID mappings. + */ +export type PropertyNameResolutionResponse = { + /** + * Property Ids + */ + property_ids: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/PropertyType.ts b/clients/admin-ui/src/types/api/models/PropertyType.ts index 2bc3f3de004..8d878837d18 100644 --- a/clients/admin-ui/src/types/api/models/PropertyType.ts +++ b/clients/admin-ui/src/types/api/models/PropertyType.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * PropertyType + */ export enum PropertyType { WEBSITE = "Website", OTHER = "Other", diff --git a/clients/admin-ui/src/types/api/models/ProviderEnum.ts b/clients/admin-ui/src/types/api/models/ProviderEnum.ts index 8ec9502efc8..ce43b4c3661 100644 --- a/clients/admin-ui/src/types/api/models/ProviderEnum.ts +++ b/clients/admin-ui/src/types/api/models/ProviderEnum.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ProviderEnum + */ export enum ProviderEnum { GOOGLE = "google", OKTA = "okta", diff --git a/clients/admin-ui/src/types/api/models/PublicPropertyResponse.ts b/clients/admin-ui/src/types/api/models/PublicPropertyResponse.ts index ea250ac07ef..2ff07cfa372 100644 --- a/clients/admin-ui/src/types/api/models/PublicPropertyResponse.ts +++ b/clients/admin-ui/src/types/api/models/PublicPropertyResponse.ts @@ -1,13 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +import type { fides__api__schemas__privacy_center_config__PrivacyCenterConfig } from "./fides__api__schemas__privacy_center_config__PrivacyCenterConfig"; import type { MinimalMessagingTemplate } from "./MinimalMessagingTemplate"; import type { MinimalPrivacyExperienceConfig } from "./MinimalPrivacyExperienceConfig"; -import type { PrivacyCenterConfig } from "./PrivacyCenterConfig"; -import type { PropertyType } from "./PropertyType"; +import { PropertyType } from "./PropertyType"; /** + * PublicPropertyResponse + * * Schema that represents a `Property` as returned in the * public-facing Property APIs. * @@ -20,12 +20,30 @@ import type { PropertyType } from "./PropertyType"; * appropriate non-public schemas that extend this schema. */ export type PublicPropertyResponse = { + /** + * Name + */ name: string; type: PropertyType; + /** + * Id + */ id?: string | null; + /** + * Experiences + */ experiences: Array; + /** + * Messaging Templates + */ messaging_templates?: Array | null; - privacy_center_config?: PrivacyCenterConfig | null; + privacy_center_config?: fides__api__schemas__privacy_center_config__PrivacyCenterConfig | null; + /** + * Stylesheet + */ stylesheet?: string | null; + /** + * Paths + */ paths: Array; }; diff --git a/clients/admin-ui/src/types/api/models/PurposesResponse.ts b/clients/admin-ui/src/types/api/models/PurposesResponse.ts index f5aeb7c33e6..ceb01b7fd03 100644 --- a/clients/admin-ui/src/types/api/models/PurposesResponse.ts +++ b/clients/admin-ui/src/types/api/models/PurposesResponse.ts @@ -1,10 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { MappedPurpose } from "./MappedPurpose"; +/** + * PurposesResponse + */ export type PurposesResponse = { - purposes: Record; - special_purposes: Record; + /** + * Purposes + */ + purposes: { + [key: string]: MappedPurpose; + }; + /** + * Special Purposes + */ + special_purposes: { + [key: string]: MappedPurpose; + }; }; diff --git a/clients/admin-ui/src/types/api/models/QueryParam.ts b/clients/admin-ui/src/types/api/models/QueryParam.ts index 1515be24492..42029cf5db5 100644 --- a/clients/admin-ui/src/types/api/models/QueryParam.ts +++ b/clients/admin-ui/src/types/api/models/QueryParam.ts @@ -1,8 +1,15 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * QueryParam + */ export type QueryParam = { + /** + * Name + */ name: string; + /** + * Value + */ value: number | string; }; diff --git a/clients/admin-ui/src/types/api/models/QuestionProgressItem.ts b/clients/admin-ui/src/types/api/models/QuestionProgressItem.ts new file mode 100644 index 00000000000..fb2345d7192 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/QuestionProgressItem.ts @@ -0,0 +1,29 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * QuestionProgressItem + * + * Per-question progress detail in questionnaire status. + */ +export type QuestionProgressItem = { + /** + * Question Id + */ + question_id: string; + /** + * Question Text + */ + question_text: string; + /** + * Question Index + */ + question_index: number; + /** + * Status + */ + status: string; + /** + * Answer Text + */ + answer_text?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/QuestionnaireStatusResponse.ts b/clients/admin-ui/src/types/api/models/QuestionnaireStatusResponse.ts new file mode 100644 index 00000000000..77bdd386786 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/QuestionnaireStatusResponse.ts @@ -0,0 +1,59 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { QuestionProgressItem } from "./QuestionProgressItem"; + +/** + * QuestionnaireStatusResponse + * + * Full questionnaire status with per-question progress (API spec shape). + */ +export type QuestionnaireStatusResponse = { + /** + * Assessment Id + */ + assessment_id: string; + /** + * Questionnaire Id + */ + questionnaire_id: string; + /** + * Status + */ + status: string; + /** + * Sent At + */ + sent_at?: string | null; + /** + * Channel + */ + channel?: string | null; + /** + * Total Questions + */ + total_questions: number; + /** + * Answered Questions + */ + answered_questions: number; + /** + * Pending Questions + */ + pending_questions: number; + /** + * Progress Percentage + */ + progress_percentage: number; + /** + * Questions + */ + questions: Array; + /** + * Last Reminder At + */ + last_reminder_at?: string | null; + /** + * Reminder Count + */ + reminder_count?: number; +}; diff --git a/clients/admin-ui/src/types/api/models/QueueInfo.ts b/clients/admin-ui/src/types/api/models/QueueInfo.ts index 0eb30553be3..80a92413151 100644 --- a/clients/admin-ui/src/types/api/models/QueueInfo.ts +++ b/clients/admin-ui/src/types/api/models/QueueInfo.ts @@ -1,7 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * QueueInfo + */ export type QueueInfo = { + /** + * Messages + */ messages: number; }; diff --git a/clients/admin-ui/src/types/api/models/RDSMySQLDocsSchema.ts b/clients/admin-ui/src/types/api/models/RDSMySQLDocsSchema.ts index 61b80412a9b..2cbb1352840 100644 --- a/clients/admin-ui/src/types/api/models/RDSMySQLDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/RDSMySQLDocsSchema.ts @@ -1,34 +1,46 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AWSAuthMethod } from "./AWSAuthMethod"; +import { AWSAuthMethod } from "./AWSAuthMethod"; /** + * RDSMySQLDocsSchema + * * RDS MySQL Secrets Schema for API Docs */ export type RDSMySQLDocsSchema = { /** + * Authentication Method + * * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. */ auth_method: AWSAuthMethod; /** + * Access Key ID + * * Part of the credentials that provide access to your AWS account. */ aws_access_key_id?: string | null; /** + * Secret Access Key + * * Part of the credentials that provide access to your AWS account. */ aws_secret_access_key?: string | null; /** + * Assume Role ARN + * * If provided, the ARN of the role that should be assumed to connect to AWS. */ aws_assume_role_arn?: string | null; /** + * DB Username + * * The user account used to authenticate and access the databases. */ db_username?: string; /** + * Region + * * The AWS region where the RDS instances are located. */ region: string; diff --git a/clients/admin-ui/src/types/api/models/RDSPostgresDocsSchema.ts b/clients/admin-ui/src/types/api/models/RDSPostgresDocsSchema.ts index fc204589ccb..f6e1bf71227 100644 --- a/clients/admin-ui/src/types/api/models/RDSPostgresDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/RDSPostgresDocsSchema.ts @@ -1,34 +1,46 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AWSAuthMethod } from "./AWSAuthMethod"; +import { AWSAuthMethod } from "./AWSAuthMethod"; /** + * RDSPostgresDocsSchema + * * RDS Postgres Secrets Schema for API Docs */ export type RDSPostgresDocsSchema = { /** + * Authentication Method + * * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. */ auth_method: AWSAuthMethod; /** + * Access Key ID + * * Part of the credentials that provide access to your AWS account. */ aws_access_key_id?: string | null; /** + * Secret Access Key + * * Part of the credentials that provide access to your AWS account. */ aws_secret_access_key?: string | null; /** + * Assume Role ARN + * * If provided, the ARN of the role that should be assumed to connect to AWS. */ aws_assume_role_arn?: string | null; /** + * DB Username + * * The user account used to authenticate and access the databases. */ db_username?: string; /** + * Region + * * The AWS region where the RDS instances are located. */ region: string; diff --git a/clients/admin-ui/src/types/api/models/RangeEntry.ts b/clients/admin-ui/src/types/api/models/RangeEntry.ts index a0c6bc42526..878b73278fc 100644 --- a/clients/admin-ui/src/types/api/models/RangeEntry.ts +++ b/clients/admin-ui/src/types/api/models/RangeEntry.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * RangeEntry + * * Pydantic model that represents a vendor range entry as per the TCF spec, * used for Publisher Restrictions. * A range entry must have a start_vendor_id and optionally an end_vendor_id. @@ -10,10 +10,14 @@ */ export type RangeEntry = { /** + * Start Vendor Id + * * The starting vendor ID in the range */ start_vendor_id: number; /** + * End Vendor Id + * * The ending vendor ID in the range (inclusive) */ end_vendor_id?: number | null; diff --git a/clients/admin-ui/src/types/api/models/RateLimit.ts b/clients/admin-ui/src/types/api/models/RateLimit.ts index a41fdbbe1b1..4c007e19cd1 100644 --- a/clients/admin-ui/src/types/api/models/RateLimit.ts +++ b/clients/admin-ui/src/types/api/models/RateLimit.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { RateLimitPeriod } from "./RateLimitPeriod"; +import { RateLimitPeriod } from "./RateLimitPeriod"; /** + * RateLimit + * * A config object which allows configuring rate limits for connectors */ export type RateLimit = { + /** + * Rate + */ rate: number; period: RateLimitPeriod; + /** + * Custom Key + */ custom_key?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/RateLimitConfig.ts b/clients/admin-ui/src/types/api/models/RateLimitConfig.ts index e7a9b3fe36b..489b3ebdf76 100644 --- a/clients/admin-ui/src/types/api/models/RateLimitConfig.ts +++ b/clients/admin-ui/src/types/api/models/RateLimitConfig.ts @@ -1,13 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { RateLimit } from "./RateLimit"; /** + * RateLimitConfig + * * A config object which allows configuring rate limits for connectors */ export type RateLimitConfig = { + /** + * Limits + */ limits?: Array | null; + /** + * Enabled + */ enabled?: boolean | null; }; diff --git a/clients/admin-ui/src/types/api/models/RateLimitPeriod.ts b/clients/admin-ui/src/types/api/models/RateLimitPeriod.ts index 6aa9328ddcc..d48c6565b38 100644 --- a/clients/admin-ui/src/types/api/models/RateLimitPeriod.ts +++ b/clients/admin-ui/src/types/api/models/RateLimitPeriod.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * RateLimitPeriod + * * Defines the periods supported by rate limit config */ export enum RateLimitPeriod { diff --git a/clients/admin-ui/src/types/api/models/ReadSaaSRequest.ts b/clients/admin-ui/src/types/api/models/ReadSaaSRequest.ts index fa691de28a2..7b44e4da331 100644 --- a/clients/admin-ui/src/types/api/models/ReadSaaSRequest.ts +++ b/clients/admin-ui/src/types/api/models/ReadSaaSRequest.ts @@ -1,36 +1,77 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AsyncConfig } from "./AsyncConfig"; import type { ClientConfig } from "./ClientConfig"; import type { Header } from "./Header"; -import type { HTTPMethod } from "./HTTPMethod"; +import { HTTPMethod } from "./HTTPMethod"; import type { ParamValue } from "./ParamValue"; import type { QueryParam } from "./QueryParam"; import type { RateLimitConfig } from "./RateLimitConfig"; import type { Strategy } from "./Strategy"; /** + * ReadSaaSRequest + * * An extension of the base SaaSRequest that allows the inclusion of an output template - * that is used to format each collection result. + * that is used to format each collection result, and correlation_id_path for async polling. */ export type ReadSaaSRequest = { + /** + * Request Override + */ request_override?: string | null; + /** + * Path + */ path?: string | null; method?: HTTPMethod | null; + /** + * Headers + */ headers?: Array
| null; + /** + * Query Params + */ query_params?: Array | null; + /** + * Body + */ body?: string | null; + /** + * Param Values + */ param_values?: Array | null; client_config?: ClientConfig | null; + /** + * Data Path + */ data_path?: string | null; + /** + * Postprocessors + */ postprocessors?: Array | null; pagination?: Strategy | null; + /** + * Grouped Inputs + */ grouped_inputs?: Array | null; + /** + * Ignore Errors + */ ignore_errors?: boolean | Array | null; rate_limit_config?: RateLimitConfig | null; - async_config?: AsyncConfig | null; + async_config?: Strategy | null; + /** + * Skip Missing Param Values + */ skip_missing_param_values?: boolean | null; + /** + * Correlation Id Path + * + * The path to the correlation ID in the response. For use with async polling. + */ + correlation_id_path?: string | null; + /** + * Output + */ output?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/RecalculateConsentResponse.ts b/clients/admin-ui/src/types/api/models/RecalculateConsentResponse.ts index eb40eecb2d9..0a9e9b41840 100644 --- a/clients/admin-ui/src/types/api/models/RecalculateConsentResponse.ts +++ b/clients/admin-ui/src/types/api/models/RecalculateConsentResponse.ts @@ -1,12 +1,14 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * RecalculateConsentResponse + * * Response model for recalculate consent operations on staged resources */ export type RecalculateConsentResponse = { /** + * Updated + * * Number of resources updated */ updated: number; diff --git a/clients/admin-ui/src/types/api/models/RecordConsentServedRequest.ts b/clients/admin-ui/src/types/api/models/RecordConsentServedRequest.ts index 3f040a6d797..cc4ba79efc9 100644 --- a/clients/admin-ui/src/types/api/models/RecordConsentServedRequest.ts +++ b/clients/admin-ui/src/types/api/models/RecordConsentServedRequest.ts @@ -1,31 +1,82 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { Identity } from "./Identity"; -import type { ServingComponent } from "./ServingComponent"; +import type { fides__api__schemas__redis_cache__Identity } from "./fides__api__schemas__redis_cache__Identity"; +import { ServingComponent } from "./ServingComponent"; /** + * RecordConsentServedRequest + * * Request body to use when saving that consent was served */ export type RecordConsentServedRequest = { + /** + * Tcf Purpose Consents + */ tcf_purpose_consents?: Array; + /** + * Tcf Purpose Legitimate Interests + */ tcf_purpose_legitimate_interests?: Array; + /** + * Tcf Special Purposes + */ tcf_special_purposes?: Array; + /** + * Tcf Vendor Consents + */ tcf_vendor_consents?: Array; + /** + * Tcf Vendor Legitimate Interests + */ tcf_vendor_legitimate_interests?: Array; + /** + * Tcf Features + */ tcf_features?: Array; + /** + * Tcf Special Features + */ tcf_special_features?: Array; + /** + * Tcf System Consents + */ tcf_system_consents?: Array; + /** + * Tcf System Legitimate Interests + */ tcf_system_legitimate_interests?: Array; + /** + * Privacy Notice History Ids + */ privacy_notice_history_ids?: Array; - browser_identity: Identity; + browser_identity: fides__api__schemas__redis_cache__Identity; + /** + * Code + */ code?: string | null; + /** + * Privacy Experience Id + */ privacy_experience_id?: string | null; + /** + * Privacy Experience Config History Id + */ privacy_experience_config_history_id?: string | null; + /** + * User Geography + */ user_geography?: string | null; + /** + * Acknowledge Mode + */ acknowledge_mode?: boolean | null; + /** + * Served Notice History Id + */ served_notice_history_id?: string | null; serving_component: ServingComponent; + /** + * Property Id + */ property_id?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/RecordsServedResponse.ts b/clients/admin-ui/src/types/api/models/RecordsServedResponse.ts index 19207634b82..95549b553d5 100644 --- a/clients/admin-ui/src/types/api/models/RecordsServedResponse.ts +++ b/clients/admin-ui/src/types/api/models/RecordsServedResponse.ts @@ -1,20 +1,53 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * RecordsServedResponse + * * Response after saving notices served (v2) */ export type RecordsServedResponse = { + /** + * Tcf Purpose Consents + */ tcf_purpose_consents?: Array; + /** + * Tcf Purpose Legitimate Interests + */ tcf_purpose_legitimate_interests?: Array; + /** + * Tcf Special Purposes + */ tcf_special_purposes?: Array; + /** + * Tcf Vendor Consents + */ tcf_vendor_consents?: Array; + /** + * Tcf Vendor Legitimate Interests + */ tcf_vendor_legitimate_interests?: Array; + /** + * Tcf Features + */ tcf_features?: Array; + /** + * Tcf Special Features + */ tcf_special_features?: Array; + /** + * Tcf System Consents + */ tcf_system_consents?: Array; + /** + * Tcf System Legitimate Interests + */ tcf_system_legitimate_interests?: Array; + /** + * Privacy Notice History Ids + */ privacy_notice_history_ids?: Array; + /** + * Served Notice History Id + */ served_notice_history_id: string; }; diff --git a/clients/admin-ui/src/types/api/models/RedshiftDocsSchema.ts b/clients/admin-ui/src/types/api/models/RedshiftDocsSchema.ts index 7ba577770eb..bd960860454 100644 --- a/clients/admin-ui/src/types/api/models/RedshiftDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/RedshiftDocsSchema.ts @@ -1,36 +1,50 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * RedshiftDocsSchema + * * Redshift Secrets Schema for API Docs */ export type RedshiftDocsSchema = { /** + * Host + * * The hostname or IP address of the server where the database is running. */ host: string; /** + * Port + * * The network port number on which the server is listening for incoming connections (default: 5439). */ port?: number; /** + * Username + * * The user account used to authenticate and access the database. */ user: string; /** + * Password + * * The password used to authenticate and access the database. */ password: string; /** + * Database + * * The name of the specific database within the database server that you want to connect to. */ database: string; /** + * Schema + * * The default schema to be used for the database connection (defaults to public). */ db_schema?: string | null; /** + * SSH required + * * Indicates whether an SSH tunnel is required for the connection. Enable this option if your Redshift database is behind a firewall and requires SSH tunneling for remote connections. */ ssh_required?: boolean; diff --git a/clients/admin-ui/src/types/api/models/Registration.ts b/clients/admin-ui/src/types/api/models/Registration.ts index 258fdd0c526..30a2da3bff3 100644 --- a/clients/admin-ui/src/types/api/models/Registration.ts +++ b/clients/admin-ui/src/types/api/models/Registration.ts @@ -1,13 +1,25 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * Registration + * * Describes a Fides registration. */ export type Registration = { + /** + * Opt In + */ opt_in: boolean; + /** + * Analytics Id + */ analytics_id: string; + /** + * User Email + */ user_email: string | null; + /** + * User Organization + */ user_organization: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/RejectAllMechanism.ts b/clients/admin-ui/src/types/api/models/RejectAllMechanism.ts index 9923b0e184f..e6c4157d45c 100644 --- a/clients/admin-ui/src/types/api/models/RejectAllMechanism.ts +++ b/clients/admin-ui/src/types/api/models/RejectAllMechanism.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * RejectAllMechanism + * * Reject all mechanism options - not formalized in the db. * Used to configure the behavior of the reject all button in TCF experiences */ diff --git a/clients/admin-ui/src/types/api/models/RenderPromptRequest.ts b/clients/admin-ui/src/types/api/models/RenderPromptRequest.ts new file mode 100644 index 00000000000..0d8c461838c --- /dev/null +++ b/clients/admin-ui/src/types/api/models/RenderPromptRequest.ts @@ -0,0 +1,32 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { DataSectionConfig } from "./DataSectionConfig"; +import { PromptType } from "./PromptType"; + +/** + * RenderPromptRequest + * + * Request to render a prompt with data. + */ +export type RenderPromptRequest = { + prompt_type: PromptType; + data_sections?: DataSectionConfig; + /** + * Assessment Id + */ + assessment_id?: string | null; + /** + * Declaration Id + */ + declaration_id?: string | null; + /** + * Template Key + */ + template_key?: string | null; + /** + * Questionnaire Variables + */ + questionnaire_variables?: { + [key: string]: unknown; + } | null; +}; diff --git a/clients/admin-ui/src/types/api/models/RenderPromptResponse.ts b/clients/admin-ui/src/types/api/models/RenderPromptResponse.ts new file mode 100644 index 00000000000..bd8f1b67683 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/RenderPromptResponse.ts @@ -0,0 +1,28 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { PromptType } from "./PromptType"; + +/** + * RenderPromptResponse + * + * Response containing the rendered prompt. + */ +export type RenderPromptResponse = { + prompt_type: PromptType; + /** + * Rendered Prompt + */ + rendered_prompt: string; + /** + * Data Summary + */ + data_summary?: { + [key: string]: unknown; + }; + /** + * Variables Used + */ + variables_used?: { + [key: string]: unknown; + }; +}; diff --git a/clients/admin-ui/src/types/api/models/ReportExportFormat.ts b/clients/admin-ui/src/types/api/models/ReportExportFormat.ts index 384a86683b4..0f3d1529a68 100644 --- a/clients/admin-ui/src/types/api/models/ReportExportFormat.ts +++ b/clients/admin-ui/src/types/api/models/ReportExportFormat.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ReportExportFormat + */ export enum ReportExportFormat { XLSX = "xlsx", CSV = "csv", diff --git a/clients/admin-ui/src/types/api/models/ReportType.ts b/clients/admin-ui/src/types/api/models/ReportType.ts index 52f17eb08e1..2c1d383e90c 100644 --- a/clients/admin-ui/src/types/api/models/ReportType.ts +++ b/clients/admin-ui/src/types/api/models/ReportType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ReportType + * * Enum for custom report types. */ export enum ReportType { diff --git a/clients/admin-ui/src/types/api/models/RequestOrigin.ts b/clients/admin-ui/src/types/api/models/RequestOrigin.ts index ba7b26d2486..83b108676e0 100644 --- a/clients/admin-ui/src/types/api/models/RequestOrigin.ts +++ b/clients/admin-ui/src/types/api/models/RequestOrigin.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * RequestOrigin + * * We currently extract the RequestOrigin from the Privacy Experience * Config ComponentType when saving, so RequestOrigin needs to be a * superset of ComponentType. @@ -17,4 +17,5 @@ export enum RequestOrigin { BANNER_AND_MODAL = "banner_and_modal", API = "api", TCF_OVERLAY = "tcf_overlay", + HEADLESS = "headless", } diff --git a/clients/admin-ui/src/types/api/models/RequestTaskCallbackRequest.ts b/clients/admin-ui/src/types/api/models/RequestTaskCallbackRequest.ts index d78b86913c9..b2cdce80476 100644 --- a/clients/admin-ui/src/types/api/models/RequestTaskCallbackRequest.ts +++ b/clients/admin-ui/src/types/api/models/RequestTaskCallbackRequest.ts @@ -1,16 +1,22 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * RequestTaskCallbackRequest + * * Request body for Async Callback */ export type RequestTaskCallbackRequest = { /** + * Access Results + * * Access results collected asynchronously, as a list of rows. Use caution; this data may be used by dependent tasks downstream and/or uploaded to the end user. */ - access_results?: null; + access_results?: Array<{ + [key: string]: unknown; + }> | null; /** + * Rows Masked + * * Number of records masked, as an integer */ rows_masked?: number | null; diff --git a/clients/admin-ui/src/types/api/models/ResourceError.ts b/clients/admin-ui/src/types/api/models/ResourceError.ts index fbe59c976a4..906aa139c1c 100644 --- a/clients/admin-ui/src/types/api/models/ResourceError.ts +++ b/clients/admin-ui/src/types/api/models/ResourceError.ts @@ -1,19 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { DiffStatus } from "./DiffStatus"; -import type { ErrorType } from "./ErrorType"; +import { DiffStatus } from "./DiffStatus"; +import { ErrorType } from "./ErrorType"; /** + * ResourceError + * * Model for storing error information on a staged resource */ export type ResourceError = { /** + * Message + * * Error message */ message: string; /** + * Timestamp + * * When the error occurred */ timestamp: string; @@ -22,10 +26,12 @@ export type ResourceError = { */ error_type?: ErrorType; /** - * Phase where error occurred, i.e. the error diff_status value + * The error `diff_status`, which indicates the phase in which the error occurred */ - phase: DiffStatus; + diff_status: DiffStatus; /** + * Task Id + * * ID of the task that encountered the error */ task_id?: string | null; diff --git a/clients/admin-ui/src/types/api/models/ResourceFilter.ts b/clients/admin-ui/src/types/api/models/ResourceFilter.ts index ef667c55fc8..82536ed1678 100644 --- a/clients/admin-ui/src/types/api/models/ResourceFilter.ts +++ b/clients/admin-ui/src/types/api/models/ResourceFilter.ts @@ -1,16 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ResourceFilter + * * The ResourceFilter resource model. */ export type ResourceFilter = { /** + * Type + * * The type of filter to be used (i.e. ignore_resource_arn) */ type: string; /** + * Value + * * A string representation of resources to be filtered. Can include wildcards. */ value: string; diff --git a/clients/admin-ui/src/types/api/models/ResourceTypes.ts b/clients/admin-ui/src/types/api/models/ResourceTypes.ts index 4931028618a..d5f9df27969 100644 --- a/clients/admin-ui/src/types/api/models/ResourceTypes.ts +++ b/clients/admin-ui/src/types/api/models/ResourceTypes.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ResourceTypes + * * Resource types that can use custom fields. */ export enum ResourceTypes { diff --git a/clients/admin-ui/src/types/api/models/ResponseFormat.ts b/clients/admin-ui/src/types/api/models/ResponseFormat.ts index bf2c4df56af..4af2f76077b 100644 --- a/clients/admin-ui/src/types/api/models/ResponseFormat.ts +++ b/clients/admin-ui/src/types/api/models/ResponseFormat.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ResponseFormat + * * Response formats */ export enum ResponseFormat { diff --git a/clients/admin-ui/src/types/api/models/ResponseWithMessage.ts b/clients/admin-ui/src/types/api/models/ResponseWithMessage.ts index b201e943f4f..d43a7840e30 100644 --- a/clients/admin-ui/src/types/api/models/ResponseWithMessage.ts +++ b/clients/admin-ui/src/types/api/models/ResponseWithMessage.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ResponseWithMessage + * * Generic schema for responses with a message */ export type ResponseWithMessage = { + /** + * Message + */ message: string; }; diff --git a/clients/admin-ui/src/types/api/models/ResultSetStats.ts b/clients/admin-ui/src/types/api/models/ResultSetStats.ts new file mode 100644 index 00000000000..0095540772f --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ResultSetStats.ts @@ -0,0 +1,25 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { PaginationFilterParams } from "./PaginationFilterParams"; + +/** + * ResultSetStats + */ +export type ResultSetStats = { + /** + * Count + * + * Total number of records matching the filter + */ + count?: number; + /** + * The filter that this metadata describes + */ + filter: PaginationFilterParams; + /** + * Timestamp + * + * Timestamp of the result-set metadata + */ + timestamp?: number; +}; diff --git a/clients/admin-ui/src/types/api/models/RevertAnswerRequest.ts b/clients/admin-ui/src/types/api/models/RevertAnswerRequest.ts index a36be62f6d4..4dbc548cd4d 100644 --- a/clients/admin-ui/src/types/api/models/RevertAnswerRequest.ts +++ b/clients/admin-ui/src/types/api/models/RevertAnswerRequest.ts @@ -1,12 +1,14 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * RevertAnswerRequest + * * Request to revert an answer to a previous version. */ export type RevertAnswerRequest = { /** + * Version Number + * * Version number to revert to */ version_number: number; diff --git a/clients/admin-ui/src/types/api/models/ReviewPrivacyRequestIds.ts b/clients/admin-ui/src/types/api/models/ReviewPrivacyRequestIds.ts deleted file mode 100644 index 3bb1f9b4252..00000000000 --- a/clients/admin-ui/src/types/api/models/ReviewPrivacyRequestIds.ts +++ /dev/null @@ -1,10 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -/** - * Pass in a list of privacy request ids - */ -export type ReviewPrivacyRequestIds = { - request_ids: Array; -}; diff --git a/clients/admin-ui/src/types/api/models/RoleRegistryEnum.ts b/clients/admin-ui/src/types/api/models/RoleRegistryEnum.ts index cc2dfafb475..63151f28e1e 100644 --- a/clients/admin-ui/src/types/api/models/RoleRegistryEnum.ts +++ b/clients/admin-ui/src/types/api/models/RoleRegistryEnum.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * RoleRegistryEnum + * * Enum of available roles * * Owner - Full admin diff --git a/clients/admin-ui/src/types/api/models/RuleCreate.ts b/clients/admin-ui/src/types/api/models/RuleCreate.ts index 089d0f02595..f18a34000e0 100644 --- a/clients/admin-ui/src/types/api/models/RuleCreate.ts +++ b/clients/admin-ui/src/types/api/models/RuleCreate.ts @@ -1,18 +1,27 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ActionType } from "./ActionType"; +import { ActionType } from "./ActionType"; import type { PolicyMaskingSpec } from "./PolicyMaskingSpec"; /** + * RuleCreate + * * The schema to use when creating a Rule. This schema accepts a storage_destination_key * over a composite object. */ export type RuleCreate = { + /** + * Name + */ name: string; + /** + * Key + */ key?: string | null; action_type: ActionType; + /** + * Storage Destination Key + */ storage_destination_key?: string | null; masking_strategy?: PolicyMaskingSpec | null; }; diff --git a/clients/admin-ui/src/types/api/models/RuleCreateWithTargets.ts b/clients/admin-ui/src/types/api/models/RuleCreateWithTargets.ts new file mode 100644 index 00000000000..d1d3f3a0447 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/RuleCreateWithTargets.ts @@ -0,0 +1,31 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { ActionType } from "./ActionType"; +import type { PolicyMaskingSpec } from "./PolicyMaskingSpec"; +import type { RuleTarget } from "./RuleTarget"; + +/** + * RuleCreateWithTargets + * + * RuleCreate extended with inline targets for policy creation. + */ +export type RuleCreateWithTargets = { + /** + * Name + */ + name: string; + /** + * Key + */ + key?: string | null; + action_type: ActionType; + /** + * Storage Destination Key + */ + storage_destination_key?: string | null; + masking_strategy?: PolicyMaskingSpec | null; + /** + * Targets + */ + targets?: Array | null; +}; diff --git a/clients/admin-ui/src/types/api/models/RuleResponse.ts b/clients/admin-ui/src/types/api/models/RuleResponse.ts index 5dce7583c53..cd5b9304334 100644 --- a/clients/admin-ui/src/types/api/models/RuleResponse.ts +++ b/clients/admin-ui/src/types/api/models/RuleResponse.ts @@ -1,17 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ActionType } from "./ActionType"; +import { ActionType } from "./ActionType"; import type { PolicyMaskingSpecResponse } from "./PolicyMaskingSpecResponse"; import type { StorageDestinationResponse } from "./StorageDestinationResponse"; /** + * RuleResponse + * * The schema to use when returning a Rule via the API. This schema uses a censored version * of the `PolicyMaskingSpec` that omits the configuration to avoid exposing secrets. */ export type RuleResponse = { + /** + * Name + */ name: string; + /** + * Key + */ key?: string | null; action_type: ActionType; storage_destination?: StorageDestinationResponse | null; diff --git a/clients/admin-ui/src/types/api/models/RuleResponseWithTargets.ts b/clients/admin-ui/src/types/api/models/RuleResponseWithTargets.ts index bce2967311a..a5415b24cd5 100644 --- a/clients/admin-ui/src/types/api/models/RuleResponseWithTargets.ts +++ b/clients/admin-ui/src/types/api/models/RuleResponseWithTargets.ts @@ -1,21 +1,30 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ActionType } from "./ActionType"; +import { ActionType } from "./ActionType"; import type { PolicyMaskingSpecResponse } from "./PolicyMaskingSpecResponse"; import type { RuleTarget } from "./RuleTarget"; import type { StorageDestinationResponse } from "./StorageDestinationResponse"; /** + * RuleResponseWithTargets + * * The schema to use when returning a Rule via the API and when including the Rule's targets * is desired. This schema uses a censored version of the `PolicyMaskingSpec` that omits the * configuration to avoid exposing secrets. */ export type RuleResponseWithTargets = { + /** + * Name + */ name: string; + /** + * Key + */ key?: string | null; action_type: ActionType; + /** + * Targets + */ targets?: Array | null; storage_destination?: StorageDestinationResponse | null; masking_strategy?: PolicyMaskingSpecResponse | null; diff --git a/clients/admin-ui/src/types/api/models/RuleTarget.ts b/clients/admin-ui/src/types/api/models/RuleTarget.ts index b2b2976dd56..efc2ca08064 100644 --- a/clients/admin-ui/src/types/api/models/RuleTarget.ts +++ b/clients/admin-ui/src/types/api/models/RuleTarget.ts @@ -1,12 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * RuleTarget + * * An external representation of a Rule's target DataCategory within a Fidesops Policy */ export type RuleTarget = { + /** + * Name + */ name?: string | null; + /** + * Key + */ key?: string | null; + /** + * Data Category + */ data_category: string; }; diff --git a/clients/admin-ui/src/types/api/models/S3Config.ts b/clients/admin-ui/src/types/api/models/S3Config.ts new file mode 100644 index 00000000000..5031cd9c6e0 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/S3Config.ts @@ -0,0 +1,30 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * S3Config + * + * S3 configuration for storage. + * + * Simplified seed input for configuring S3 storage. + * See also: StorageConfig, StorageSecretsS3. + */ +export type S3Config = { + /** + * Aws Access Key Id + * + * AWS access key ID + */ + aws_access_key_id: string; + /** + * Aws Secret Access Key + * + * AWS secret access key + */ + aws_secret_access_key: string; + /** + * Bucket + * + * S3 bucket name + */ + bucket: string; +}; diff --git a/clients/admin-ui/src/types/api/models/S3DocsSchema.ts b/clients/admin-ui/src/types/api/models/S3DocsSchema.ts index 9343d0b6173..d90faf21613 100644 --- a/clients/admin-ui/src/types/api/models/S3DocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/S3DocsSchema.ts @@ -1,26 +1,34 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AWSAuthMethod } from "./AWSAuthMethod"; +import { AWSAuthMethod } from "./AWSAuthMethod"; /** + * S3DocsSchema + * * S3 Secrets Schema for API Docs */ export type S3DocsSchema = { /** + * Authentication Method + * * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. */ auth_method: AWSAuthMethod; /** + * Access Key ID + * * Part of the credentials that provide access to your AWS account. */ aws_access_key_id?: string | null; /** + * Secret Access Key + * * Part of the credentials that provide access to your AWS account. */ aws_secret_access_key?: string | null; /** + * Assume Role ARN + * * If provided, the ARN of the role that should be assumed to connect to AWS. */ aws_assume_role_arn?: string | null; diff --git a/clients/admin-ui/src/types/api/models/S3MonitorParams.ts b/clients/admin-ui/src/types/api/models/S3MonitorParams.ts index a499d7262c9..04a89513b1c 100644 --- a/clients/admin-ui/src/types/api/models/S3MonitorParams.ts +++ b/clients/admin-ui/src/types/api/models/S3MonitorParams.ts @@ -1,9 +1,12 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * S3MonitorParams + */ export type S3MonitorParams = { /** + * Max Objects + * * The maximum number of objects that will be detected, per bucket */ max_objects?: number | null; diff --git a/clients/admin-ui/src/types/api/models/SaaSConfig.ts b/clients/admin-ui/src/types/api/models/SaaSConfig.ts index 7758937b6f4..236258ecb95 100644 --- a/clients/admin-ui/src/types/api/models/SaaSConfig.ts +++ b/clients/admin-ui/src/types/api/models/SaaSConfig.ts @@ -1,6 +1,4 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ClientConfig } from "./ClientConfig"; import type { ConnectorParam } from "./ConnectorParam"; @@ -12,6 +10,8 @@ import type { SaaSDisplayInfo } from "./SaaSDisplayInfo"; import type { SaaSRequest } from "./SaaSRequest"; /** + * SaaSConfig + * * Used to store endpoint and param configurations for a SaaS connector. * This is done to separate the details of how to make the API calls * from the data provided by a given API collection. @@ -21,20 +21,46 @@ import type { SaaSRequest } from "./SaaSRequest"; * for the graph traversal. */ export type SaaSConfig = { + /** + * Fides Key + */ fides_key: string; + /** + * Name + */ name: string; + /** + * Type + */ type: string; + /** + * Description + */ description: string; + /** + * Version + */ version: string; - replaceable?: boolean; + /** + * Connector Params + */ connector_params: Array; + /** + * External References + */ external_references?: Array | null; client_config: ClientConfig; + /** + * Endpoints + */ endpoints: Array; test_request: SaaSRequest; data_protection_request?: SaaSRequest | null; rate_limit_config?: RateLimitConfig | null; consent_requests?: ConsentRequestMap | null; + /** + * User Guide + */ user_guide?: string | null; display_info?: SaaSDisplayInfo | null; }; diff --git a/clients/admin-ui/src/types/api/models/SaaSConfigBase.ts b/clients/admin-ui/src/types/api/models/SaaSConfigBase.ts index c9e78658835..303fc164a69 100644 --- a/clients/admin-ui/src/types/api/models/SaaSConfigBase.ts +++ b/clients/admin-ui/src/types/api/models/SaaSConfigBase.ts @@ -1,12 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * SaaSConfigBase + * * Used to store base info for a SaaS config */ export type SaaSConfigBase = { + /** + * Fides Key + */ fides_key: string; + /** + * Name + */ name: string; + /** + * Type + */ type: string; }; diff --git a/clients/admin-ui/src/types/api/models/SaaSConfigValidationDetails.ts b/clients/admin-ui/src/types/api/models/SaaSConfigValidationDetails.ts index 9447f55f102..83878990c46 100644 --- a/clients/admin-ui/src/types/api/models/SaaSConfigValidationDetails.ts +++ b/clients/admin-ui/src/types/api/models/SaaSConfigValidationDetails.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * SaaSConfigValidationDetails + * * Message with any validation issues with the SaaS config */ export type SaaSConfigValidationDetails = { + /** + * Msg + */ msg?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/SaaSDisplayInfo.ts b/clients/admin-ui/src/types/api/models/SaaSDisplayInfo.ts index 915bfb2d657..e39aaae5780 100644 --- a/clients/admin-ui/src/types/api/models/SaaSDisplayInfo.ts +++ b/clients/admin-ui/src/types/api/models/SaaSDisplayInfo.ts @@ -1,16 +1,22 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConnectionCategory } from "./ConnectionCategory"; -import type { IntegrationFeature } from "./IntegrationFeature"; +import { ConnectionCategory } from "./ConnectionCategory"; +import { IntegrationFeature } from "./IntegrationFeature"; /** + * SaaSDisplayInfo + * * Optional display information for SAAS integrations to enhance frontend presentation. * When not provided, smart defaults will be inferred based on the integration type. */ export type SaaSDisplayInfo = { category?: ConnectionCategory | null; + /** + * Tags + */ tags?: Array | null; + /** + * Enabled Features + */ enabled_features?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/SaaSRequest.ts b/clients/admin-ui/src/types/api/models/SaaSRequest.ts index 9c75458ca49..fe6977d245c 100644 --- a/clients/admin-ui/src/types/api/models/SaaSRequest.ts +++ b/clients/admin-ui/src/types/api/models/SaaSRequest.ts @@ -1,37 +1,75 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AsyncConfig } from "./AsyncConfig"; import type { ClientConfig } from "./ClientConfig"; import type { Header } from "./Header"; -import type { HTTPMethod } from "./HTTPMethod"; +import { HTTPMethod } from "./HTTPMethod"; import type { ParamValue } from "./ParamValue"; import type { QueryParam } from "./QueryParam"; import type { RateLimitConfig } from "./RateLimitConfig"; import type { Strategy } from "./Strategy"; /** + * SaaSRequest + * * A single request with static or dynamic path, headers, query, and body params. * Also specifies the names and sources for the param values needed to build the request. * * Includes optional strategies for postprocessing and pagination. */ export type SaaSRequest = { + /** + * Request Override + */ request_override?: string | null; + /** + * Path + */ path?: string | null; method?: HTTPMethod | null; + /** + * Headers + */ headers?: Array
| null; + /** + * Query Params + */ query_params?: Array | null; + /** + * Body + */ body?: string | null; + /** + * Param Values + */ param_values?: Array | null; client_config?: ClientConfig | null; + /** + * Data Path + */ data_path?: string | null; + /** + * Postprocessors + */ postprocessors?: Array | null; pagination?: Strategy | null; + /** + * Grouped Inputs + */ grouped_inputs?: Array | null; + /** + * Ignore Errors + */ ignore_errors?: boolean | Array | null; rate_limit_config?: RateLimitConfig | null; - async_config?: AsyncConfig | null; + async_config?: Strategy | null; + /** + * Skip Missing Param Values + */ skip_missing_param_values?: boolean | null; + /** + * Correlation Id Path + * + * The path to the correlation ID in the response. For use with async polling. + */ + correlation_id_path?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/SaaSRequestMap.ts b/clients/admin-ui/src/types/api/models/SaaSRequestMap.ts index bdd9deb42cc..a67487ffa39 100644 --- a/clients/admin-ui/src/types/api/models/SaaSRequestMap.ts +++ b/clients/admin-ui/src/types/api/models/SaaSRequestMap.ts @@ -1,14 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ReadSaaSRequest } from "./ReadSaaSRequest"; import type { SaaSRequest } from "./SaaSRequest"; /** + * SaaSRequestMap + * * A map of actions to SaaS requests */ export type SaaSRequestMap = { + /** + * Read + */ read?: ReadSaaSRequest | Array; update?: SaaSRequest | null; delete?: SaaSRequest | null; diff --git a/clients/admin-ui/src/types/api/models/SaaSSchema.ts b/clients/admin-ui/src/types/api/models/SaaSSchema.ts index 42475e31965..d6abb2cb39c 100644 --- a/clients/admin-ui/src/types/api/models/SaaSSchema.ts +++ b/clients/admin-ui/src/types/api/models/SaaSSchema.ts @@ -1,10 +1,12 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * SaaSSchema + * * Abstract base schema for updating SaaS connection configuration secrets. * Fields are added during runtime based on the connector_params and any * external_references in the passed in saas_config */ -export type SaaSSchema = {}; +export type SaaSSchema = { + [key: string]: unknown; +}; diff --git a/clients/admin-ui/src/types/api/models/SaasConnectionTemplateResponse.ts b/clients/admin-ui/src/types/api/models/SaasConnectionTemplateResponse.ts index c4b6001ec41..c5ca2c78b67 100644 --- a/clients/admin-ui/src/types/api/models/SaasConnectionTemplateResponse.ts +++ b/clients/admin-ui/src/types/api/models/SaasConnectionTemplateResponse.ts @@ -1,10 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConnectionConfigurationResponse } from "./ConnectionConfigurationResponse"; import type { Dataset } from "./Dataset"; +/** + * SaasConnectionTemplateResponse + */ export type SaasConnectionTemplateResponse = { connection: ConnectionConfigurationResponse; dataset: Dataset; diff --git a/clients/admin-ui/src/types/api/models/SaasConnectionTemplateValues.ts b/clients/admin-ui/src/types/api/models/SaasConnectionTemplateValues.ts index abac701166a..8d105aac139 100644 --- a/clients/admin-ui/src/types/api/models/SaasConnectionTemplateValues.ts +++ b/clients/admin-ui/src/types/api/models/SaasConnectionTemplateValues.ts @@ -1,65 +1,792 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { BigQueryDocsSchema } from "./BigQueryDocsSchema"; -import type { DatahubDocsSchema } from "./DatahubDocsSchema"; -import type { DynamicErasureEmailDocsSchema } from "./DynamicErasureEmailDocsSchema"; -import type { DynamoDBDocsSchema } from "./DynamoDBDocsSchema"; -import type { EmailDocsSchema } from "./EmailDocsSchema"; -import type { FidesDocsSchema } from "./FidesDocsSchema"; -import type { GoogleCloudSQLMySQLDocsSchema } from "./GoogleCloudSQLMySQLDocsSchema"; -import type { GoogleCloudSQLPostgresDocsSchema } from "./GoogleCloudSQLPostgresDocsSchema"; -import type { ManualWebhookDocsSchema } from "./ManualWebhookDocsSchema"; -import type { MariaDBDocsSchema } from "./MariaDBDocsSchema"; -import type { MongoDBDocsSchema } from "./MongoDBDocsSchema"; -import type { MSSQLDocsSchema } from "./MSSQLDocsSchema"; -import type { MySQLDocsSchema } from "./MySQLDocsSchema"; -import type { OktaDocsSchema } from "./OktaDocsSchema"; -import type { PostgreSQLDocsSchema } from "./PostgreSQLDocsSchema"; -import type { RDSMySQLDocsSchema } from "./RDSMySQLDocsSchema"; -import type { RDSPostgresDocsSchema } from "./RDSPostgresDocsSchema"; -import type { RedshiftDocsSchema } from "./RedshiftDocsSchema"; -import type { S3DocsSchema } from "./S3DocsSchema"; +import type { AdvancedSettings } from "./AdvancedSettings"; +import type { AdvancedSettingsWithExtendedIdentityTypes } from "./AdvancedSettingsWithExtendedIdentityTypes"; +import { AWSAuthMethod } from "./AWSAuthMethod"; +import type { fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds } from "./fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds"; +import type { fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds } from "./fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds"; +import type { fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds } from "./fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds"; +import type { FidesDatasetReference } from "./FidesDatasetReference"; +import { GoogleCloudSQLIPType } from "./GoogleCloudSQLIPType"; +import { MySQLSSLMode } from "./MySQLSSLMode"; +import { PeriodicIntegrationFrequency } from "./PeriodicIntegrationFrequency"; import type { SaaSSchema } from "./SaaSSchema"; -import type { ScyllaDocsSchema } from "./ScyllaDocsSchema"; -import type { SnowflakeDocsSchema } from "./SnowflakeDocsSchema"; -import type { SovrnDocsSchema } from "./SovrnDocsSchema"; -import type { TimescaleDocsSchema } from "./TimescaleDocsSchema"; import type { WebsiteSchema } from "./WebsiteSchema"; /** + * SaasConnectionTemplateValues + * * Schema with values to create both a Saas ConnectionConfig and DatasetConfig from a template */ export type SaasConnectionTemplateValues = { + /** + * Name + */ name?: string | null; + /** + * Key + */ key?: string | null; + /** + * Description + */ description?: string | null; + /** + * Secrets + */ secrets: - | BigQueryDocsSchema - | DatahubDocsSchema - | DynamicErasureEmailDocsSchema - | DynamoDBDocsSchema - | EmailDocsSchema - | FidesDocsSchema - | GoogleCloudSQLMySQLDocsSchema - | GoogleCloudSQLPostgresDocsSchema - | ManualWebhookDocsSchema - | MariaDBDocsSchema - | MongoDBDocsSchema - | MSSQLDocsSchema - | MySQLDocsSchema - | OktaDocsSchema - | PostgreSQLDocsSchema - | RDSMySQLDocsSchema - | RDSPostgresDocsSchema - | RedshiftDocsSchema - | S3DocsSchema + | { + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds; + /** + * Dataset + * + * Only provide a dataset to scope discovery monitors and privacy request automation to a specific BigQuery dataset. In most cases, this can be left blank. + */ + dataset?: string | null; + } + | { + /** + * DataHub server URL + * + * The URL of your DataHub server. + */ + datahub_server_url: string; + /** + * DataHub token + * + * The token used to authenticate with your DataHub server. + */ + datahub_token: string; + /** + * Frequency + * + * The frequency at which the integration should run. Available options are daily, weekly, monthly, and not scheduled. + */ + frequency: PeriodicIntegrationFrequency; + /** + * Glossary node + * + * The glossary node name to use on Datahub for Fides Data Categories. (e.g. FidesDataCategories) + */ + glossary_node: string; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettings; + /** + * Third party vendor name field + * + * Dataset reference to the field containing the third party vendor name. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. + */ + third_party_vendor_name: FidesDatasetReference; + /** + * Recipient email address field + * + * Dataset reference to the field containing the recipient email address. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. + */ + recipient_email_address: FidesDatasetReference; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * Region + * + * The AWS region where your DynamoDB table is located (ex. us-west-2). + */ + region_name: string; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettings; + /** + * Third Party Vendor Name + */ + third_party_vendor_name: string; + /** + * Recipient Email Address + */ + recipient_email_address: string; + } + | { + /** + * Uri + */ + uri: string; + /** + * Username + */ + username: string; + /** + * Password + */ + password: string; + /** + * Polling Timeout + */ + polling_timeout?: number | null; + /** + * Polling Interval + */ + polling_interval?: number | null; + } + | { + /** + * DB IAM user + * + * example: service-account@test.iam.gserviceaccount.com + */ + db_iam_user: string; + /** + * Instance connection name + * + * example: friendly-tower-424214-n8:us-central1:test-ethyca + */ + instance_connection_name: string; + /** + * Database name + */ + dbname: string; + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds; + /** + * IP type + * + * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview + */ + ip_type?: GoogleCloudSQLIPType | null; + } + | { + /** + * DB IAM user + * + * example: service-account@test.iam.gserviceaccount.com + */ + db_iam_user: string; + /** + * Instance connection name + * + * example: friendly-tower-424214-n8:us-central1:test-ethyca + */ + instance_connection_name: string; + /** + * Database name + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds; + /** + * IP type + * + * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview + */ + ip_type?: GoogleCloudSQLIPType | null; + } + | { + /** + * Access Token + */ + access_token?: string | null; + /** + * Refresh Token + */ + refresh_token?: string | null; + /** + * Token Expiry + */ + token_expiry?: string | null; + /** + * Cloud Id + */ + cloud_id?: string | null; + /** + * Site Url + */ + site_url?: string | null; + } + | { + [key: string]: unknown; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 3306). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 27017). Port will be ignored if using SRV. + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Default auth DB + * + * Used to specify the default authentication database. + */ + defaultauthdb: string; + /** + * Use SRV + * + * Enable SRV record lookup for service discovery (mongodb+srv://). Required for MongoDB Atlas. Enables SSL by default. + */ + use_srv?: boolean | null; + /** + * SSL enabled + * + * Enable SSL/TLS encryption. With SRV: defaults to enabled (can override). Without SRV: defaults to disabled. + */ + ssl_enabled?: boolean | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 1433). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Read Only Connection + * + * Whether to connect to the database in read-only mode. + */ + read_only_connection?: boolean | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 3306). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname: string; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your MySQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * SSL Mode + * + * The SSL mode to use for the connection. Accepted values are: 'required', 'preferred', 'disabled', or an empty value. + */ + ssl_mode?: MySQLSSLMode | null; + } + | { + /** + * Organization URL + * + * The URL of your Okta organization (e.g. https://your-org.okta.com) + */ + org_url: string; + /** + * OAuth2 Client ID + * + * The OAuth2 client ID from your Okta service application + */ + client_id: string; + /** + * Private Key + * + * RSA private key in JWK (JSON) format for signing JWT assertions. Download from Okta: Applications > Your App > Sign On > Client Credentials > Edit > Generate new key. + */ + private_key: string; + /** + * OAuth2 Scopes + * + * OAuth2 scopes to request (default: okta.apps.read) + */ + scopes?: Array | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5432). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSL Mode + */ + ssl_mode?: string | null; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * DB Username + * + * The user account used to authenticate and access the databases. + */ + db_username?: string; + /** + * Region + * + * The AWS region where the RDS instances are located. + */ + region: string; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * DB Username + * + * The user account used to authenticate and access the databases. + */ + db_username?: string; + /** + * Region + * + * The AWS region where the RDS instances are located. + */ + region: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5439). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + user: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + database: string; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your Redshift database is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + } | SaaSSchema - | ScyllaDocsSchema - | SnowflakeDocsSchema - | SovrnDocsSchema - | TimescaleDocsSchema + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 9042). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Keyspace + * + * The keyspace used. If not provided, DSRs for this integration will error. If the integration is used for D & D, then setting a keyspace is not required. + */ + keyspace?: string | null; + } + | { + /** + * Account Name + * + * The unique identifier for your Snowflake account. + */ + account_identifier: string; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + user_login_name: string; + /** + * Password + * + * The password used to authenticate and access the database. You can use a password or a private key, but not both. + */ + password?: string | null; + /** + * Private key + * + * The private key used to authenticate and access the database. If a `private_key_passphrase` is also provided, it is assumed to be encrypted; otherwise, it is assumed to be unencrypted. + */ + private_key?: string | null; + /** + * Passphrase + * + * The passphrase used for the encrypted private key. + */ + private_key_passphrase?: string | null; + /** + * Warehouse + * + * The name of the Snowflake warehouse where your queries will be executed. + */ + warehouse_name: string; + /** + * Database + * + * Only provide a database name to scope discovery monitors and privacy request automation to a specific database. In most cases, this can be left blank. + */ + database_name?: string | null; + /** + * Schema + * + * Only provide a schema to scope discovery monitors and privacy request automation to a specific schema. In most cases, this can be left blank. + */ + schema_name?: string | null; + /** + * Role + * + * The Snowflake role to assume for the session, if different than Username. + */ + role_name?: string | null; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettingsWithExtendedIdentityTypes; + /** + * Third Party Vendor Name + */ + third_party_vendor_name?: string; + /** + * Recipient Email Address + */ + recipient_email_address?: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5432). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSL Mode + */ + ssl_mode?: string | null; + } | WebsiteSchema; + /** + * Instance Key + */ instance_key: string; }; diff --git a/clients/admin-ui/src/types/api/models/SaasConnectionTemplateValuesExtended.ts b/clients/admin-ui/src/types/api/models/SaasConnectionTemplateValuesExtended.ts index d23ab9e346a..e5e0c14626b 100644 --- a/clients/admin-ui/src/types/api/models/SaasConnectionTemplateValuesExtended.ts +++ b/clients/admin-ui/src/types/api/models/SaasConnectionTemplateValuesExtended.ts @@ -1,64 +1,795 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ActionType } from "./ActionType"; -import type { BigQueryDocsSchema } from "./BigQueryDocsSchema"; -import type { DatahubDocsSchema } from "./DatahubDocsSchema"; -import type { DynamicErasureEmailDocsSchema } from "./DynamicErasureEmailDocsSchema"; -import type { DynamoDBDocsSchema } from "./DynamoDBDocsSchema"; -import type { EmailDocsSchema } from "./EmailDocsSchema"; -import type { FidesDocsSchema } from "./FidesDocsSchema"; -import type { GoogleCloudSQLMySQLDocsSchema } from "./GoogleCloudSQLMySQLDocsSchema"; -import type { GoogleCloudSQLPostgresDocsSchema } from "./GoogleCloudSQLPostgresDocsSchema"; -import type { ManualWebhookDocsSchema } from "./ManualWebhookDocsSchema"; -import type { MariaDBDocsSchema } from "./MariaDBDocsSchema"; -import type { MongoDBDocsSchema } from "./MongoDBDocsSchema"; -import type { MSSQLDocsSchema } from "./MSSQLDocsSchema"; -import type { MySQLDocsSchema } from "./MySQLDocsSchema"; -import type { OktaDocsSchema } from "./OktaDocsSchema"; -import type { PostgreSQLDocsSchema } from "./PostgreSQLDocsSchema"; -import type { RDSMySQLDocsSchema } from "./RDSMySQLDocsSchema"; -import type { RDSPostgresDocsSchema } from "./RDSPostgresDocsSchema"; -import type { RedshiftDocsSchema } from "./RedshiftDocsSchema"; -import type { S3DocsSchema } from "./S3DocsSchema"; +import { ActionType } from "./ActionType"; +import type { AdvancedSettings } from "./AdvancedSettings"; +import type { AdvancedSettingsWithExtendedIdentityTypes } from "./AdvancedSettingsWithExtendedIdentityTypes"; +import { AWSAuthMethod } from "./AWSAuthMethod"; +import type { fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds } from "./fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds"; +import type { fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds } from "./fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds"; +import type { fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds } from "./fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds"; +import type { FidesDatasetReference } from "./FidesDatasetReference"; +import { GoogleCloudSQLIPType } from "./GoogleCloudSQLIPType"; +import { MySQLSSLMode } from "./MySQLSSLMode"; +import { PeriodicIntegrationFrequency } from "./PeriodicIntegrationFrequency"; import type { SaaSSchema } from "./SaaSSchema"; -import type { ScyllaDocsSchema } from "./ScyllaDocsSchema"; -import type { SnowflakeDocsSchema } from "./SnowflakeDocsSchema"; -import type { SovrnDocsSchema } from "./SovrnDocsSchema"; -import type { TimescaleDocsSchema } from "./TimescaleDocsSchema"; import type { WebsiteSchema } from "./WebsiteSchema"; +/** + * SaasConnectionTemplateValuesExtended + */ export type SaasConnectionTemplateValuesExtended = { + /** + * Name + */ name?: string | null; + /** + * Key + */ key?: string | null; + /** + * Description + */ description?: string | null; + /** + * Secrets + */ secrets: - | BigQueryDocsSchema - | DatahubDocsSchema - | DynamicErasureEmailDocsSchema - | DynamoDBDocsSchema - | EmailDocsSchema - | FidesDocsSchema - | GoogleCloudSQLMySQLDocsSchema - | GoogleCloudSQLPostgresDocsSchema - | ManualWebhookDocsSchema - | MariaDBDocsSchema - | MongoDBDocsSchema - | MSSQLDocsSchema - | MySQLDocsSchema - | OktaDocsSchema - | PostgreSQLDocsSchema - | RDSMySQLDocsSchema - | RDSPostgresDocsSchema - | RedshiftDocsSchema - | S3DocsSchema + | { + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds; + /** + * Dataset + * + * Only provide a dataset to scope discovery monitors and privacy request automation to a specific BigQuery dataset. In most cases, this can be left blank. + */ + dataset?: string | null; + } + | { + /** + * DataHub server URL + * + * The URL of your DataHub server. + */ + datahub_server_url: string; + /** + * DataHub token + * + * The token used to authenticate with your DataHub server. + */ + datahub_token: string; + /** + * Frequency + * + * The frequency at which the integration should run. Available options are daily, weekly, monthly, and not scheduled. + */ + frequency: PeriodicIntegrationFrequency; + /** + * Glossary node + * + * The glossary node name to use on Datahub for Fides Data Categories. (e.g. FidesDataCategories) + */ + glossary_node: string; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettings; + /** + * Third party vendor name field + * + * Dataset reference to the field containing the third party vendor name. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. + */ + third_party_vendor_name: FidesDatasetReference; + /** + * Recipient email address field + * + * Dataset reference to the field containing the recipient email address. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. + */ + recipient_email_address: FidesDatasetReference; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * Region + * + * The AWS region where your DynamoDB table is located (ex. us-west-2). + */ + region_name: string; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettings; + /** + * Third Party Vendor Name + */ + third_party_vendor_name: string; + /** + * Recipient Email Address + */ + recipient_email_address: string; + } + | { + /** + * Uri + */ + uri: string; + /** + * Username + */ + username: string; + /** + * Password + */ + password: string; + /** + * Polling Timeout + */ + polling_timeout?: number | null; + /** + * Polling Interval + */ + polling_interval?: number | null; + } + | { + /** + * DB IAM user + * + * example: service-account@test.iam.gserviceaccount.com + */ + db_iam_user: string; + /** + * Instance connection name + * + * example: friendly-tower-424214-n8:us-central1:test-ethyca + */ + instance_connection_name: string; + /** + * Database name + */ + dbname: string; + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds; + /** + * IP type + * + * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview + */ + ip_type?: GoogleCloudSQLIPType | null; + } + | { + /** + * DB IAM user + * + * example: service-account@test.iam.gserviceaccount.com + */ + db_iam_user: string; + /** + * Instance connection name + * + * example: friendly-tower-424214-n8:us-central1:test-ethyca + */ + instance_connection_name: string; + /** + * Database name + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds; + /** + * IP type + * + * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview + */ + ip_type?: GoogleCloudSQLIPType | null; + } + | { + /** + * Access Token + */ + access_token?: string | null; + /** + * Refresh Token + */ + refresh_token?: string | null; + /** + * Token Expiry + */ + token_expiry?: string | null; + /** + * Cloud Id + */ + cloud_id?: string | null; + /** + * Site Url + */ + site_url?: string | null; + } + | { + [key: string]: unknown; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 3306). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 27017). Port will be ignored if using SRV. + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Default auth DB + * + * Used to specify the default authentication database. + */ + defaultauthdb: string; + /** + * Use SRV + * + * Enable SRV record lookup for service discovery (mongodb+srv://). Required for MongoDB Atlas. Enables SSL by default. + */ + use_srv?: boolean | null; + /** + * SSL enabled + * + * Enable SSL/TLS encryption. With SRV: defaults to enabled (can override). Without SRV: defaults to disabled. + */ + ssl_enabled?: boolean | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 1433). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Read Only Connection + * + * Whether to connect to the database in read-only mode. + */ + read_only_connection?: boolean | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 3306). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname: string; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your MySQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * SSL Mode + * + * The SSL mode to use for the connection. Accepted values are: 'required', 'preferred', 'disabled', or an empty value. + */ + ssl_mode?: MySQLSSLMode | null; + } + | { + /** + * Organization URL + * + * The URL of your Okta organization (e.g. https://your-org.okta.com) + */ + org_url: string; + /** + * OAuth2 Client ID + * + * The OAuth2 client ID from your Okta service application + */ + client_id: string; + /** + * Private Key + * + * RSA private key in JWK (JSON) format for signing JWT assertions. Download from Okta: Applications > Your App > Sign On > Client Credentials > Edit > Generate new key. + */ + private_key: string; + /** + * OAuth2 Scopes + * + * OAuth2 scopes to request (default: okta.apps.read) + */ + scopes?: Array | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5432). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSL Mode + */ + ssl_mode?: string | null; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * DB Username + * + * The user account used to authenticate and access the databases. + */ + db_username?: string; + /** + * Region + * + * The AWS region where the RDS instances are located. + */ + region: string; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * DB Username + * + * The user account used to authenticate and access the databases. + */ + db_username?: string; + /** + * Region + * + * The AWS region where the RDS instances are located. + */ + region: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5439). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + user: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + database: string; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your Redshift database is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + } | SaaSSchema - | ScyllaDocsSchema - | SnowflakeDocsSchema - | SovrnDocsSchema - | TimescaleDocsSchema + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 9042). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Keyspace + * + * The keyspace used. If not provided, DSRs for this integration will error. If the integration is used for D & D, then setting a keyspace is not required. + */ + keyspace?: string | null; + } + | { + /** + * Account Name + * + * The unique identifier for your Snowflake account. + */ + account_identifier: string; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + user_login_name: string; + /** + * Password + * + * The password used to authenticate and access the database. You can use a password or a private key, but not both. + */ + password?: string | null; + /** + * Private key + * + * The private key used to authenticate and access the database. If a `private_key_passphrase` is also provided, it is assumed to be encrypted; otherwise, it is assumed to be unencrypted. + */ + private_key?: string | null; + /** + * Passphrase + * + * The passphrase used for the encrypted private key. + */ + private_key_passphrase?: string | null; + /** + * Warehouse + * + * The name of the Snowflake warehouse where your queries will be executed. + */ + warehouse_name: string; + /** + * Database + * + * Only provide a database name to scope discovery monitors and privacy request automation to a specific database. In most cases, this can be left blank. + */ + database_name?: string | null; + /** + * Schema + * + * Only provide a schema to scope discovery monitors and privacy request automation to a specific schema. In most cases, this can be left blank. + */ + schema_name?: string | null; + /** + * Role + * + * The Snowflake role to assume for the session, if different than Username. + */ + role_name?: string | null; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettingsWithExtendedIdentityTypes; + /** + * Third Party Vendor Name + */ + third_party_vendor_name?: string; + /** + * Recipient Email Address + */ + recipient_email_address?: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5432). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSL Mode + */ + ssl_mode?: string | null; + } | WebsiteSchema; + /** + * Instance Key + */ instance_key: string; + /** + * Enabled Actions + */ enabled_actions: Array; }; diff --git a/clients/admin-ui/src/types/api/models/Schema.ts b/clients/admin-ui/src/types/api/models/Schema.ts index cc8713981fc..cdc84809cdb 100644 --- a/clients/admin-ui/src/types/api/models/Schema.ts +++ b/clients/admin-ui/src/types/api/models/Schema.ts @@ -1,24 +1,51 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ClassificationWithConfidence } from "./ClassificationWithConfidence"; -import type { DiffStatus } from "./DiffStatus"; +import { DiffStatus } from "./DiffStatus"; import type { ResourceError } from "./ResourceError"; -import type { StagedResourceTypeValue } from "./StagedResourceTypeValue"; +import { StagedResourceTypeValue } from "./StagedResourceTypeValue"; +/** + * Schema + */ export type Schema = { + /** + * Urn + */ urn: string; + /** + * User Assigned Data Categories + */ user_assigned_data_categories?: Array | null; /** + * User Assigned Data Uses + * * User assigned data uses overriding auto assigned data uses */ user_assigned_data_uses?: Array | null; + /** + * User Assigned System Key + */ user_assigned_system_key?: string | null; + /** + * Name + */ name?: string | null; + /** + * System Key + */ system_key?: string | null; + /** + * Description + */ description?: string | null; + /** + * Monitor Config Id + */ monitor_config_id?: string | null; + /** + * Updated At + */ updated_at?: string | null; /** * The diff status of the staged resource @@ -26,16 +53,74 @@ export type Schema = { diff_status?: DiffStatus | null; resource_type?: StagedResourceTypeValue | null; /** + * Data Uses + * * The data uses associated with the staged resource */ data_uses?: Array | null; /** + * Errors + * * List of errors encountered during processing */ errors?: Array; + /** + * Source Modified + */ source_modified?: string | null; + /** + * Classifications + */ classifications?: Array; + /** + * Database Name + */ database_name?: string | null; + /** + * Tables + */ tables?: Array; - namespace?: null; + /** + * Namespace + */ + namespace?: { + [key: string]: unknown; + } | null; + [key: string]: + | unknown + | string + | Array + | null + | Array + | null + | string + | null + | string + | null + | string + | null + | string + | null + | string + | null + | string + | null + | DiffStatus + | null + | StagedResourceTypeValue + | null + | Array + | null + | Array + | string + | null + | Array + | string + | null + | Array + | { + [key: string]: unknown; + } + | null + | undefined; }; diff --git a/clients/admin-ui/src/types/api/models/ScopeRegistryEnum.ts b/clients/admin-ui/src/types/api/models/ScopeRegistryEnum.ts index 52c992effc6..71ccb831458 100644 --- a/clients/admin-ui/src/types/api/models/ScopeRegistryEnum.ts +++ b/clients/admin-ui/src/types/api/models/ScopeRegistryEnum.ts @@ -1,227 +1,903 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ScopeRegistryEnum + */ export enum ScopeRegistryEnum { + /** + * ALLOW_LIST_CREATE + */ ALLOW_LIST_CREATE = "allow_list:create", + /** + * ALLOW_LIST_DELETE + */ ALLOW_LIST_DELETE = "allow_list:delete", + /** + * ALLOW_LIST_READ + */ ALLOW_LIST_READ = "allow_list:read", + /** + * ALLOW_LIST_UPDATE + */ ALLOW_LIST_UPDATE = "allow_list:update", + /** + * ATTACHMENT_CREATE + */ ATTACHMENT_CREATE = "attachment:create", + /** + * ATTACHMENT_DELETE + */ ATTACHMENT_DELETE = "attachment:delete", + /** + * ATTACHMENT_READ + */ ATTACHMENT_READ = "attachment:read", + /** + * BACKFILL_EXEC + */ BACKFILL_EXEC = "backfill:exec", + /** + * CHAT_PROVIDER_READ + */ CHAT_PROVIDER_READ = "chat_provider:read", + /** + * CHAT_PROVIDER_UPDATE + */ CHAT_PROVIDER_UPDATE = "chat_provider:update", + /** + * CLASSIFY_INSTANCE_CREATE + */ CLASSIFY_INSTANCE_CREATE = "classify_instance:create", + /** + * CLASSIFY_INSTANCE_READ + */ CLASSIFY_INSTANCE_READ = "classify_instance:read", + /** + * CLASSIFY_INSTANCE_UPDATE + */ CLASSIFY_INSTANCE_UPDATE = "classify_instance:update", + /** + * CLI_OBJECTS_CREATE + */ CLI_OBJECTS_CREATE = "cli-objects:create", + /** + * CLI_OBJECTS_DELETE + */ CLI_OBJECTS_DELETE = "cli-objects:delete", + /** + * CLI_OBJECTS_READ + */ CLI_OBJECTS_READ = "cli-objects:read", + /** + * CLI_OBJECTS_UPDATE + */ CLI_OBJECTS_UPDATE = "cli-objects:update", + /** + * CLIENT_CREATE + */ CLIENT_CREATE = "client:create", + /** + * CLIENT_DELETE + */ CLIENT_DELETE = "client:delete", + /** + * CLIENT_READ + */ CLIENT_READ = "client:read", + /** + * CLIENT_UPDATE + */ CLIENT_UPDATE = "client:update", + /** + * COMMENT_CREATE + */ COMMENT_CREATE = "comment:create", + /** + * COMMENT_READ + */ COMMENT_READ = "comment:read", + /** + * CONFIG_READ + */ CONFIG_READ = "config:read", + /** + * CONFIG_UPDATE + */ CONFIG_UPDATE = "config:update", + /** + * CONNECTION_AUTHORIZE + */ CONNECTION_AUTHORIZE = "connection:authorize", + /** + * CONNECTION_CREATE_OR_UPDATE + */ CONNECTION_CREATE_OR_UPDATE = "connection:create_or_update", + /** + * CONNECTION_DELETE + */ CONNECTION_DELETE = "connection:delete", + /** + * CONNECTION_INSTANTIATE + */ CONNECTION_INSTANTIATE = "connection:instantiate", + /** + * CONNECTION_READ + */ CONNECTION_READ = "connection:read", + /** + * CONNECTION_TYPE_READ + */ CONNECTION_TYPE_READ = "connection_type:read", + /** + * CONNECTOR_TEMPLATE_READ + */ CONNECTOR_TEMPLATE_READ = "connector_template:read", + /** + * CONNECTOR_TEMPLATE_REGISTER + */ CONNECTOR_TEMPLATE_REGISTER = "connector_template:register", + /** + * CONSENT_READ + */ CONSENT_READ = "consent:read", + /** + * CONSENT_SETTINGS_READ + */ CONSENT_SETTINGS_READ = "consent_settings:read", + /** + * CONSENT_SETTINGS_UPDATE + */ CONSENT_SETTINGS_UPDATE = "consent_settings:update", + /** + * CONSENT_WEBHOOK_POST + */ CONSENT_WEBHOOK_POST = "consent_webhook:post", + /** + * CONSENT_WEBHOOK_TOKEN_CREATE + */ CONSENT_WEBHOOK_TOKEN_CREATE = "consent_webhook_token:create", + /** + * CTL_DATASET_CREATE + */ CTL_DATASET_CREATE = "ctl_dataset:create", + /** + * CTL_DATASET_DELETE + */ CTL_DATASET_DELETE = "ctl_dataset:delete", + /** + * CTL_DATASET_READ + */ CTL_DATASET_READ = "ctl_dataset:read", + /** + * CTL_DATASET_UPDATE + */ CTL_DATASET_UPDATE = "ctl_dataset:update", + /** + * CTL_POLICY_CREATE + */ CTL_POLICY_CREATE = "ctl_policy:create", + /** + * CTL_POLICY_DELETE + */ CTL_POLICY_DELETE = "ctl_policy:delete", + /** + * CTL_POLICY_READ + */ CTL_POLICY_READ = "ctl_policy:read", + /** + * CTL_POLICY_UPDATE + */ CTL_POLICY_UPDATE = "ctl_policy:update", + /** + * CURRENT_PRIVACY_PREFERENCE_READ + */ CURRENT_PRIVACY_PREFERENCE_READ = "current-privacy-preference:read", + /** + * CUSTOM_ASSET_UPDATE + */ CUSTOM_ASSET_UPDATE = "custom_asset:update", + /** + * CUSTOM_FIELD_CREATE + */ CUSTOM_FIELD_CREATE = "custom_field:create", + /** + * CUSTOM_FIELD_DELETE + */ CUSTOM_FIELD_DELETE = "custom_field:delete", + /** + * CUSTOM_FIELD_READ + */ CUSTOM_FIELD_READ = "custom_field:read", + /** + * CUSTOM_FIELD_UPDATE + */ CUSTOM_FIELD_UPDATE = "custom_field:update", + /** + * CUSTOM_FIELD_DEFINITION_CREATE + */ CUSTOM_FIELD_DEFINITION_CREATE = "custom_field_definition:create", + /** + * CUSTOM_FIELD_DEFINITION_DELETE + */ CUSTOM_FIELD_DEFINITION_DELETE = "custom_field_definition:delete", + /** + * CUSTOM_FIELD_DEFINITION_READ + */ CUSTOM_FIELD_DEFINITION_READ = "custom_field_definition:read", + /** + * CUSTOM_FIELD_DEFINITION_UPDATE + */ CUSTOM_FIELD_DEFINITION_UPDATE = "custom_field_definition:update", + /** + * CUSTOM_REPORT_CREATE + */ CUSTOM_REPORT_CREATE = "custom_report:create", + /** + * CUSTOM_REPORT_DELETE + */ CUSTOM_REPORT_DELETE = "custom_report:delete", + /** + * CUSTOM_REPORT_READ + */ CUSTOM_REPORT_READ = "custom_report:read", + /** + * DATA_CATEGORY_CREATE + */ DATA_CATEGORY_CREATE = "data_category:create", + /** + * DATA_CATEGORY_DELETE + */ DATA_CATEGORY_DELETE = "data_category:delete", + /** + * DATA_CATEGORY_READ + */ DATA_CATEGORY_READ = "data_category:read", + /** + * DATA_CATEGORY_UPDATE + */ DATA_CATEGORY_UPDATE = "data_category:update", + /** + * DATA_SUBJECT_CREATE + */ DATA_SUBJECT_CREATE = "data_subject:create", + /** + * DATA_SUBJECT_DELETE + */ DATA_SUBJECT_DELETE = "data_subject:delete", + /** + * DATA_SUBJECT_READ + */ DATA_SUBJECT_READ = "data_subject:read", + /** + * DATA_SUBJECT_UPDATE + */ DATA_SUBJECT_UPDATE = "data_subject:update", + /** + * DATA_USE_CREATE + */ DATA_USE_CREATE = "data_use:create", + /** + * DATA_USE_DELETE + */ DATA_USE_DELETE = "data_use:delete", + /** + * DATA_USE_READ + */ DATA_USE_READ = "data_use:read", + /** + * DATA_USE_UPDATE + */ DATA_USE_UPDATE = "data_use:update", + /** + * DATABASE_RESET + */ DATABASE_RESET = "database:reset", + /** + * DATAMAP_READ + */ DATAMAP_READ = "datamap:read", + /** + * DATASET_CREATE_OR_UPDATE + */ DATASET_CREATE_OR_UPDATE = "dataset:create_or_update", + /** + * DATASET_DELETE + */ DATASET_DELETE = "dataset:delete", + /** + * DATASET_READ + */ DATASET_READ = "dataset:read", + /** + * DATASET_TEST + */ DATASET_TEST = "dataset:test", + /** + * DEVELOPER_READ + */ DEVELOPER_READ = "developer:read", + /** + * DEVELOPER_UPDATE + */ DEVELOPER_UPDATE = "developer:update", + /** + * DIGEST_CONFIG_CREATE + */ DIGEST_CONFIG_CREATE = "digest_config:create", + /** + * DIGEST_CONFIG_DELETE + */ DIGEST_CONFIG_DELETE = "digest_config:delete", + /** + * DIGEST_CONFIG_READ + */ DIGEST_CONFIG_READ = "digest_config:read", + /** + * DIGEST_CONFIG_UPDATE + */ DIGEST_CONFIG_UPDATE = "digest_config:update", + /** + * DISCOVERY_MONITOR_READ + */ DISCOVERY_MONITOR_READ = "discovery_monitor:read", + /** + * DISCOVERY_MONITOR_UPDATE + */ DISCOVERY_MONITOR_UPDATE = "discovery_monitor:update", + /** + * ENCRYPTION_EXEC + */ ENCRYPTION_EXEC = "encryption:exec", + /** + * ENDPOINT_CACHE_UPDATE + */ ENDPOINT_CACHE_UPDATE = "endpoint_cache:update", + /** + * EVALUATION_CREATE + */ EVALUATION_CREATE = "evaluation:create", + /** + * EVALUATION_DELETE + */ EVALUATION_DELETE = "evaluation:delete", + /** + * EVALUATION_READ + */ EVALUATION_READ = "evaluation:read", + /** + * EVALUATION_UPDATE + */ EVALUATION_UPDATE = "evaluation:update", + /** + * FIDES_CLOUD_CONFIG_READ + */ FIDES_CLOUD_CONFIG_READ = "fides_cloud_config:read", + /** + * FIDES_CLOUD_CONFIG_UPDATE + */ FIDES_CLOUD_CONFIG_UPDATE = "fides_cloud_config:update", + /** + * FIDES_TAXONOMY_UPDATE + */ FIDES_TAXONOMY_UPDATE = "fides_taxonomy:update", + /** + * GENERATE_EXEC + */ GENERATE_EXEC = "generate:exec", + /** + * GVL_UPDATE + */ GVL_UPDATE = "gvl:update", + /** + * HEAP_DUMP_EXEC + */ HEAP_DUMP_EXEC = "heap_dump:exec", + /** + * IDENTITY_DEFINITION_CREATE + */ IDENTITY_DEFINITION_CREATE = "identity_definition:create", + /** + * IDENTITY_DEFINITION_DELETE + */ IDENTITY_DEFINITION_DELETE = "identity_definition:delete", + /** + * IDENTITY_DEFINITION_READ + */ IDENTITY_DEFINITION_READ = "identity_definition:read", + /** + * LANGUAGE_READ + */ LANGUAGE_READ = "language:read", + /** + * LOCATION_READ + */ LOCATION_READ = "location:read", + /** + * LOCATION_UPDATE + */ LOCATION_UPDATE = "location:update", + /** + * MANUAL_FIELD_READ_ALL + */ MANUAL_FIELD_READ_ALL = "manual_field:read-all", + /** + * MANUAL_FIELD_READ_OWN + */ MANUAL_FIELD_READ_OWN = "manual_field:read-own", + /** + * MASKING_EXEC + */ MASKING_EXEC = "masking:exec", + /** + * MASKING_READ + */ MASKING_READ = "masking:read", + /** + * MESSAGING_TEMPLATE_UPDATE + */ MESSAGING_TEMPLATE_UPDATE = "messaging-template:update", + /** + * MESSAGING_CREATE_OR_UPDATE + */ MESSAGING_CREATE_OR_UPDATE = "messaging:create_or_update", + /** + * MESSAGING_DELETE + */ MESSAGING_DELETE = "messaging:delete", + /** + * MESSAGING_READ + */ MESSAGING_READ = "messaging:read", + /** + * MONITOR_STEWARD_DELETE + */ MONITOR_STEWARD_DELETE = "monitor_steward:delete", + /** + * MONITOR_STEWARD_READ + */ MONITOR_STEWARD_READ = "monitor_steward:read", + /** + * MONITOR_STEWARD_UPDATE + */ MONITOR_STEWARD_UPDATE = "monitor_steward:update", + /** + * OPENID_PROVIDER_CREATE + */ OPENID_PROVIDER_CREATE = "openid_provider:create", + /** + * OPENID_PROVIDER_DELETE + */ OPENID_PROVIDER_DELETE = "openid_provider:delete", + /** + * OPENID_PROVIDER_READ + */ OPENID_PROVIDER_READ = "openid_provider:read", + /** + * OPENID_PROVIDER_UPDATE + */ OPENID_PROVIDER_UPDATE = "openid_provider:update", + /** + * ORGANIZATION_CREATE + */ ORGANIZATION_CREATE = "organization:create", + /** + * ORGANIZATION_DELETE + */ ORGANIZATION_DELETE = "organization:delete", + /** + * ORGANIZATION_READ + */ ORGANIZATION_READ = "organization:read", + /** + * ORGANIZATION_UPDATE + */ ORGANIZATION_UPDATE = "organization:update", + /** + * POLICY_CREATE_OR_UPDATE + */ POLICY_CREATE_OR_UPDATE = "policy:create_or_update", + /** + * POLICY_DELETE + */ POLICY_DELETE = "policy:delete", + /** + * POLICY_READ + */ POLICY_READ = "policy:read", + /** + * PRIVACY_EXPERIENCE_CREATE + */ PRIVACY_EXPERIENCE_CREATE = "privacy-experience:create", + /** + * PRIVACY_EXPERIENCE_READ + */ PRIVACY_EXPERIENCE_READ = "privacy-experience:read", + /** + * PRIVACY_EXPERIENCE_UPDATE + */ PRIVACY_EXPERIENCE_UPDATE = "privacy-experience:update", + /** + * PRIVACY_NOTICE_CREATE + */ PRIVACY_NOTICE_CREATE = "privacy-notice:create", + /** + * PRIVACY_NOTICE_READ + */ PRIVACY_NOTICE_READ = "privacy-notice:read", + /** + * PRIVACY_NOTICE_UPDATE + */ PRIVACY_NOTICE_UPDATE = "privacy-notice:update", + /** + * PRIVACY_PREFERENCE_HISTORY_READ + */ PRIVACY_PREFERENCE_HISTORY_READ = "privacy-preference-history:read", + /** + * PRIVACY_REQUEST_ACCESS_RESULTS_READ + */ PRIVACY_REQUEST_ACCESS_RESULTS_READ = "privacy-request-access-results:read", + /** + * PRIVACY_REQUEST_EMAIL_INTEGRATIONS_SEND + */ PRIVACY_REQUEST_EMAIL_INTEGRATIONS_SEND = "privacy-request-email-integrations:send", + /** + * PRIVACY_REQUEST_NOTIFICATIONS_CREATE_OR_UPDATE + */ PRIVACY_REQUEST_NOTIFICATIONS_CREATE_OR_UPDATE = "privacy-request-notifications:create_or_update", + /** + * PRIVACY_REQUEST_NOTIFICATIONS_READ + */ PRIVACY_REQUEST_NOTIFICATIONS_READ = "privacy-request-notifications:read", + /** + * PRIVACY_REQUEST_REDACTION_PATTERNS_READ + */ PRIVACY_REQUEST_REDACTION_PATTERNS_READ = "privacy-request-redaction-patterns:read", + /** + * PRIVACY_REQUEST_REDACTION_PATTERNS_UPDATE + */ PRIVACY_REQUEST_REDACTION_PATTERNS_UPDATE = "privacy-request-redaction-patterns:update", + /** + * PRIVACY_REQUEST_CREATE + */ PRIVACY_REQUEST_CREATE = "privacy-request:create", + /** + * PRIVACY_REQUEST_DELETE + */ PRIVACY_REQUEST_DELETE = "privacy-request:delete", + /** + * PRIVACY_REQUEST_MANUAL_STEPS_RESPOND + */ PRIVACY_REQUEST_MANUAL_STEPS_RESPOND = "privacy-request:manual-steps:respond", + /** + * PRIVACY_REQUEST_MANUAL_STEPS_REVIEW + */ PRIVACY_REQUEST_MANUAL_STEPS_REVIEW = "privacy-request:manual-steps:review", + /** + * PRIVACY_REQUEST_READ + */ PRIVACY_REQUEST_READ = "privacy-request:read", + /** + * PRIVACY_REQUEST_RESUME + */ PRIVACY_REQUEST_RESUME = "privacy-request:resume", + /** + * PRIVACY_REQUEST_REVIEW + */ PRIVACY_REQUEST_REVIEW = "privacy-request:review", + /** + * PRIVACY_REQUEST_TRANSFER + */ PRIVACY_REQUEST_TRANSFER = "privacy-request:transfer", + /** + * PRIVACY_REQUEST_UPLOAD_DATA + */ PRIVACY_REQUEST_UPLOAD_DATA = "privacy-request:upload_data", + /** + * PRIVACY_REQUEST_VIEW_DATA + */ PRIVACY_REQUEST_VIEW_DATA = "privacy-request:view_data", + /** + * PRIVACY_ASSESSMENT_CREATE + */ PRIVACY_ASSESSMENT_CREATE = "privacy_assessment:create", + /** + * PRIVACY_ASSESSMENT_DELETE + */ PRIVACY_ASSESSMENT_DELETE = "privacy_assessment:delete", + /** + * PRIVACY_ASSESSMENT_READ + */ PRIVACY_ASSESSMENT_READ = "privacy_assessment:read", + /** + * PRIVACY_ASSESSMENT_UPDATE + */ PRIVACY_ASSESSMENT_UPDATE = "privacy_assessment:update", + /** + * PRIVACY_CENTER_CONFIG_READ + */ PRIVACY_CENTER_CONFIG_READ = "privacy_center_config:read", + /** + * PRIVACY_CENTER_CONFIG_UPDATE + */ PRIVACY_CENTER_CONFIG_UPDATE = "privacy_center_config:update", + /** + * PRIVACY_EXPERIENCE_CACHE_DELETE + */ PRIVACY_EXPERIENCE_CACHE_DELETE = "privacy_experience_cache:delete", + /** + * PRIVACY_EXPERIENCE_CACHE_READ + */ PRIVACY_EXPERIENCE_CACHE_READ = "privacy_experience_cache:read", + /** + * PRIVACY_EXPERIENCE_CACHE_UPDATE + */ PRIVACY_EXPERIENCE_CACHE_UPDATE = "privacy_experience_cache:update", + /** + * PRIVACY_PREFERENCES_CREATE + */ PRIVACY_PREFERENCES_CREATE = "privacy_preferences:create", + /** + * PROPERTY_CREATE + */ PROPERTY_CREATE = "property:create", + /** + * PROPERTY_DELETE + */ PROPERTY_DELETE = "property:delete", + /** + * PROPERTY_READ + */ PROPERTY_READ = "property:read", + /** + * PROPERTY_UPDATE + */ PROPERTY_UPDATE = "property:update", + /** + * RESPONDENT_CREATE + */ RESPONDENT_CREATE = "respondent:create", + /** + * RULE_CREATE_OR_UPDATE + */ RULE_CREATE_OR_UPDATE = "rule:create_or_update", + /** + * RULE_DELETE + */ RULE_DELETE = "rule:delete", + /** + * RULE_READ + */ RULE_READ = "rule:read", + /** + * SAAS_CONFIG_CREATE_OR_UPDATE + */ SAAS_CONFIG_CREATE_OR_UPDATE = "saas_config:create_or_update", + /** + * SAAS_CONFIG_DELETE + */ SAAS_CONFIG_DELETE = "saas_config:delete", + /** + * SAAS_CONFIG_READ + */ SAAS_CONFIG_READ = "saas_config:read", + /** + * SCOPE_READ + */ SCOPE_READ = "scope:read", + /** + * SHARED_MONITOR_CONFIG_CREATE + */ SHARED_MONITOR_CONFIG_CREATE = "shared_monitor_config:create", + /** + * SHARED_MONITOR_CONFIG_DELETE + */ SHARED_MONITOR_CONFIG_DELETE = "shared_monitor_config:delete", + /** + * SHARED_MONITOR_CONFIG_READ + */ SHARED_MONITOR_CONFIG_READ = "shared_monitor_config:read", + /** + * SHARED_MONITOR_CONFIG_UPDATE + */ SHARED_MONITOR_CONFIG_UPDATE = "shared_monitor_config:update", + /** + * STORAGE_CREATE_OR_UPDATE + */ STORAGE_CREATE_OR_UPDATE = "storage:create_or_update", + /** + * STORAGE_DELETE + */ STORAGE_DELETE = "storage:delete", + /** + * STORAGE_READ + */ STORAGE_READ = "storage:read", + /** + * SYSTEM_CREATE + */ SYSTEM_CREATE = "system:create", + /** + * SYSTEM_DELETE + */ SYSTEM_DELETE = "system:delete", + /** + * SYSTEM_READ + */ SYSTEM_READ = "system:read", + /** + * SYSTEM_UPDATE + */ SYSTEM_UPDATE = "system:update", + /** + * SYSTEM_GROUP_CREATE + */ SYSTEM_GROUP_CREATE = "system_group:create", + /** + * SYSTEM_GROUP_DELETE + */ SYSTEM_GROUP_DELETE = "system_group:delete", + /** + * SYSTEM_GROUP_READ + */ SYSTEM_GROUP_READ = "system_group:read", + /** + * SYSTEM_GROUP_UPDATE + */ SYSTEM_GROUP_UPDATE = "system_group:update", + /** + * SYSTEM_HISTORY_READ + */ SYSTEM_HISTORY_READ = "system_history:read", + /** + * SYSTEM_INTEGRATION_LINK_CREATE_OR_UPDATE + */ + SYSTEM_INTEGRATION_LINK_CREATE_OR_UPDATE = "system_integration_link:create_or_update", + /** + * SYSTEM_INTEGRATION_LINK_DELETE + */ + SYSTEM_INTEGRATION_LINK_DELETE = "system_integration_link:delete", + /** + * SYSTEM_INTEGRATION_LINK_READ + */ + SYSTEM_INTEGRATION_LINK_READ = "system_integration_link:read", + /** + * SYSTEM_MANAGER_DELETE + */ SYSTEM_MANAGER_DELETE = "system_manager:delete", + /** + * SYSTEM_MANAGER_READ + */ SYSTEM_MANAGER_READ = "system_manager:read", + /** + * SYSTEM_MANAGER_UPDATE + */ SYSTEM_MANAGER_UPDATE = "system_manager:update", + /** + * SYSTEM_SCAN_CREATE + */ SYSTEM_SCAN_CREATE = "system_scan:create", + /** + * SYSTEM_SCAN_READ + */ SYSTEM_SCAN_READ = "system_scan:read", + /** + * TAXONOMY_CREATE + */ TAXONOMY_CREATE = "taxonomy:create", + /** + * TAXONOMY_DELETE + */ TAXONOMY_DELETE = "taxonomy:delete", + /** + * TAXONOMY_READ + */ TAXONOMY_READ = "taxonomy:read", + /** + * TAXONOMY_UPDATE + */ TAXONOMY_UPDATE = "taxonomy:update", + /** + * TAXONOMY_HISTORY_READ + */ TAXONOMY_HISTORY_READ = "taxonomy_history:read", + /** + * TCF_CONFIGURATIONS_CREATE + */ TCF_CONFIGURATIONS_CREATE = "tcf_configurations:create", + /** + * TCF_CONFIGURATIONS_DELETE + */ TCF_CONFIGURATIONS_DELETE = "tcf_configurations:delete", + /** + * TCF_CONFIGURATIONS_READ + */ TCF_CONFIGURATIONS_READ = "tcf_configurations:read", + /** + * TCF_CONFIGURATIONS_UPDATE + */ TCF_CONFIGURATIONS_UPDATE = "tcf_configurations:update", + /** + * TCF_PUBLISHER_OVERRIDE_READ + */ TCF_PUBLISHER_OVERRIDE_READ = "tcf_publisher_override:read", + /** + * TCF_PUBLISHER_OVERRIDE_UPDATE + */ TCF_PUBLISHER_OVERRIDE_UPDATE = "tcf_publisher_override:update", + /** + * TCF_PUBLISHER_RESTRICTIONS_CREATE + */ TCF_PUBLISHER_RESTRICTIONS_CREATE = "tcf_publisher_restrictions:create", + /** + * TCF_PUBLISHER_RESTRICTIONS_DELETE + */ TCF_PUBLISHER_RESTRICTIONS_DELETE = "tcf_publisher_restrictions:delete", + /** + * TCF_PUBLISHER_RESTRICTIONS_READ + */ TCF_PUBLISHER_RESTRICTIONS_READ = "tcf_publisher_restrictions:read", + /** + * TCF_PUBLISHER_RESTRICTIONS_UPDATE + */ TCF_PUBLISHER_RESTRICTIONS_UPDATE = "tcf_publisher_restrictions:update", + /** + * USER_PERMISSION_ASSIGN_OWNERS + */ USER_PERMISSION_ASSIGN_OWNERS = "user-permission:assign_owners", + /** + * USER_PERMISSION_CREATE + */ USER_PERMISSION_CREATE = "user-permission:create", + /** + * USER_PERMISSION_READ + */ USER_PERMISSION_READ = "user-permission:read", + /** + * USER_PERMISSION_UPDATE + */ USER_PERMISSION_UPDATE = "user-permission:update", + /** + * USER_CREATE + */ USER_CREATE = "user:create", + /** + * USER_DELETE + */ USER_DELETE = "user:delete", + /** + * USER_PASSWORD_RESET + */ USER_PASSWORD_RESET = "user:password-reset", + /** + * USER_READ + */ USER_READ = "user:read", + /** + * USER_READ_OWN + */ USER_READ_OWN = "user:read-own", + /** + * USER_UPDATE + */ USER_UPDATE = "user:update", + /** + * VALIDATE_EXEC + */ VALIDATE_EXEC = "validate:exec", + /** + * WEBHOOK_CREATE_OR_UPDATE + */ WEBHOOK_CREATE_OR_UPDATE = "webhook:create_or_update", + /** + * WEBHOOK_DELETE + */ WEBHOOK_DELETE = "webhook:delete", + /** + * WEBHOOK_READ + */ WEBHOOK_READ = "webhook:read", + /** + * WORKER_STATS_READ + */ WORKER_STATS_READ = "worker-stats:read", } diff --git a/clients/admin-ui/src/types/api/models/ScyllaDocsSchema.ts b/clients/admin-ui/src/types/api/models/ScyllaDocsSchema.ts index b8e9413ed64..1f2c2c5a205 100644 --- a/clients/admin-ui/src/types/api/models/ScyllaDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/ScyllaDocsSchema.ts @@ -1,28 +1,38 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ScyllaDocsSchema + * * Scylla Secrets Schema for API docs */ export type ScyllaDocsSchema = { /** + * Host + * * The hostname or IP address of the server where the database is running. */ host: string; /** + * Port + * * The network port number on which the server is listening for incoming connections (default: 9042). */ port?: number; /** + * Username + * * The user account used to authenticate and access the database. */ username: string; /** + * Password + * * The password used to authenticate and access the database. */ password: string; /** + * Keyspace + * * The keyspace used. If not provided, DSRs for this integration will error. If the integration is used for D & D, then setting a keyspace is not required. */ keyspace?: string | null; diff --git a/clients/admin-ui/src/types/api/models/SecurityApplicationConfig.ts b/clients/admin-ui/src/types/api/models/SecurityApplicationConfig.ts index 920583b3243..e4588013eb8 100644 --- a/clients/admin-ui/src/types/api/models/SecurityApplicationConfig.ts +++ b/clients/admin-ui/src/types/api/models/SecurityApplicationConfig.ts @@ -1,9 +1,12 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * SecurityApplicationConfig + */ export type SecurityApplicationConfig = { /** + * Cors Origins + * * A list of client addresses allowed to communicate with the Fides webserver. */ cors_origins?: Array | null; diff --git a/clients/admin-ui/src/types/api/models/SeedExecutionStatus.ts b/clients/admin-ui/src/types/api/models/SeedExecutionStatus.ts new file mode 100644 index 00000000000..c44e82bf7af --- /dev/null +++ b/clients/admin-ui/src/types/api/models/SeedExecutionStatus.ts @@ -0,0 +1,13 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * SeedExecutionStatus + * + * Overall status of a seed execution. + */ +export enum SeedExecutionStatus { + PENDING = "pending", + IN_PROGRESS = "in_progress", + COMPLETE = "complete", + ERROR = "error", +} diff --git a/clients/admin-ui/src/types/api/models/SeedRequest.ts b/clients/admin-ui/src/types/api/models/SeedRequest.ts new file mode 100644 index 00000000000..314dac46f2b --- /dev/null +++ b/clients/admin-ui/src/types/api/models/SeedRequest.ts @@ -0,0 +1,33 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { DiscoveryMonitorsConfig } from "./DiscoveryMonitorsConfig"; +import type { MailgunConfig } from "./MailgunConfig"; +import type { S3Config } from "./S3Config"; +import type { SeedTasksConfig } from "./SeedTasksConfig"; + +/** + * SeedRequest + * + * Request schema for triggering environment seed. + * + * Extra fields are ignored for backward compatibility: older clients or + * newer payloads with additional keys (e.g. new monitor types) won't fail validation. + */ +export type SeedRequest = { + /** + * Which seed tasks to run + */ + tasks?: SeedTasksConfig; + /** + * Mailgun credentials (required if messaging_mailgun) + */ + mailgun?: MailgunConfig | null; + /** + * S3 credentials (required if storage_s3) + */ + s3?: S3Config | null; + /** + * Discovery monitor configs (required if discovery_monitors) + */ + discovery_monitors?: DiscoveryMonitorsConfig | null; +}; diff --git a/clients/admin-ui/src/types/api/models/SeedResponse.ts b/clients/admin-ui/src/types/api/models/SeedResponse.ts new file mode 100644 index 00000000000..bcd29858b89 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/SeedResponse.ts @@ -0,0 +1,21 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * SeedResponse + * + * Response schema after triggering environment seed. + */ +export type SeedResponse = { + /** + * Execution Id + * + * Unique execution ID for tracking + */ + execution_id: string; + /** + * Message + * + * Status message + */ + message: string; +}; diff --git a/clients/admin-ui/src/types/api/models/SeedStatusResponse.ts b/clients/admin-ui/src/types/api/models/SeedStatusResponse.ts new file mode 100644 index 00000000000..7a1670a7f47 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/SeedStatusResponse.ts @@ -0,0 +1,48 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { SeedExecutionStatus } from "./SeedExecutionStatus"; +import type { SeedStepStatus } from "./SeedStepStatus"; + +/** + * SeedStatusResponse + * + * Response schema for seed execution status. + */ +export type SeedStatusResponse = { + /** + * Id + * + * Execution ID + */ + id: string; + /** + * Overall execution status + */ + status: SeedExecutionStatus; + /** + * Started At + * + * When the execution started + */ + started_at: string; + /** + * Completed At + * + * When the execution completed + */ + completed_at?: string | null; + /** + * Steps + * + * Status of each step + */ + steps?: { + [key: string]: SeedStepStatus; + }; + /** + * Error + * + * Error message if execution failed + */ + error?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/SeedStepStatus.ts b/clients/admin-ui/src/types/api/models/SeedStepStatus.ts new file mode 100644 index 00000000000..f0bc74edf0e --- /dev/null +++ b/clients/admin-ui/src/types/api/models/SeedStepStatus.ts @@ -0,0 +1,33 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import { SeedTaskStatus } from "./SeedTaskStatus"; + +/** + * SeedStepStatus + * + * Status of an individual seed step. + */ +export type SeedStepStatus = { + /** + * Current status of the step + */ + status: SeedTaskStatus; + /** + * Message + * + * Status or error message + */ + message?: string | null; + /** + * Started At + * + * When the step started + */ + started_at?: string | null; + /** + * Completed At + * + * When the step completed + */ + completed_at?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/SeedTaskStatus.ts b/clients/admin-ui/src/types/api/models/SeedTaskStatus.ts new file mode 100644 index 00000000000..e0dbf28a617 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/SeedTaskStatus.ts @@ -0,0 +1,14 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * SeedTaskStatus + * + * Status of an individual seed task. + */ +export enum SeedTaskStatus { + PENDING = "pending", + IN_PROGRESS = "in_progress", + COMPLETE = "complete", + SKIPPED = "skipped", + ERROR = "error", +} diff --git a/clients/admin-ui/src/types/api/models/SeedTasksConfig.ts b/clients/admin-ui/src/types/api/models/SeedTasksConfig.ts new file mode 100644 index 00000000000..c013f5582fd --- /dev/null +++ b/clients/admin-ui/src/types/api/models/SeedTasksConfig.ts @@ -0,0 +1,63 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * SeedTasksConfig + * + * Configuration for which seed tasks to run. + */ +export type SeedTasksConfig = { + /** + * Sample Resources + * + * Load sample resources from demo/.fides (systems, datasets, policies) + */ + sample_resources?: boolean; + /** + * Messaging Mailgun + * + * Configure Mailgun for messaging + */ + messaging_mailgun?: boolean; + /** + * Storage S3 + * + * Configure S3 for storage + */ + storage_s3?: boolean; + /** + * Linked Connections + * + * Link sample connections to systems + */ + linked_connections?: boolean; + /** + * Consent Notices + * + * Enable default consent notices + */ + consent_notices?: boolean; + /** + * Consent Experiences + * + * Enable default consent experiences + */ + consent_experiences?: boolean; + /** + * Compass Vendors + * + * Enable default Compass vendors + */ + compass_vendors?: boolean; + /** + * Email Templates + * + * Update email templates with HTML versions + */ + email_templates?: boolean; + /** + * Discovery Monitors + * + * Create discovery monitors + */ + discovery_monitors?: boolean; +}; diff --git a/clients/admin-ui/src/types/api/models/Selection.ts b/clients/admin-ui/src/types/api/models/Selection.ts index df02f86f8aa..a9371bab06e 100644 --- a/clients/admin-ui/src/types/api/models/Selection.ts +++ b/clients/admin-ui/src/types/api/models/Selection.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * Selection + * * Selection schema */ export type Selection = { + /** + * Id + */ id: string; + /** + * Selected + */ selected?: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/SendMessageRequest.ts b/clients/admin-ui/src/types/api/models/SendMessageRequest.ts index 7adb4f426a1..0d4b8c48623 100644 --- a/clients/admin-ui/src/types/api/models/SendMessageRequest.ts +++ b/clients/admin-ui/src/types/api/models/SendMessageRequest.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * SendMessageRequest + * * Request schema for sending a chat message. */ export type SendMessageRequest = { + /** + * Channel Id + */ channel_id: string; + /** + * Message + */ message: string; }; diff --git a/clients/admin-ui/src/types/api/models/SendMessageResponse.ts b/clients/admin-ui/src/types/api/models/SendMessageResponse.ts index cce7d784e41..85144049038 100644 --- a/clients/admin-ui/src/types/api/models/SendMessageResponse.ts +++ b/clients/admin-ui/src/types/api/models/SendMessageResponse.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * SendMessageResponse + * * Response schema for send message result. */ export type SendMessageResponse = { + /** + * Success + */ success: boolean; + /** + * Message + */ message: string; }; diff --git a/clients/admin-ui/src/types/api/models/SendQuestionnaireRequest.ts b/clients/admin-ui/src/types/api/models/SendQuestionnaireRequest.ts new file mode 100644 index 00000000000..075bbddf263 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/SendQuestionnaireRequest.ts @@ -0,0 +1,27 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * SendQuestionnaireRequest + * + * Request to send a questionnaire for an assessment. + */ +export type SendQuestionnaireRequest = { + /** + * Channel + * + * Slack channel ID to send to + */ + channel: string; + /** + * Message + * + * Optional custom intro message + */ + message?: string | null; + /** + * Include Question Ids + * + * Optional list of specific question IDs to include + */ + include_question_ids?: Array | null; +}; diff --git a/clients/admin-ui/src/types/api/models/SendQuestionnaireResponse.ts b/clients/admin-ui/src/types/api/models/SendQuestionnaireResponse.ts new file mode 100644 index 00000000000..d2ff07c8e2b --- /dev/null +++ b/clients/admin-ui/src/types/api/models/SendQuestionnaireResponse.ts @@ -0,0 +1,25 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * SendQuestionnaireResponse + * + * Response from sending a questionnaire. + */ +export type SendQuestionnaireResponse = { + /** + * Sent At + */ + sent_at: string; + /** + * Channel + */ + channel: string; + /** + * Questions Sent + */ + questions_sent: number; + /** + * Message Id + */ + message_id?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/SendReminderRequest.ts b/clients/admin-ui/src/types/api/models/SendReminderRequest.ts new file mode 100644 index 00000000000..1cf1cef28f2 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/SendReminderRequest.ts @@ -0,0 +1,15 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * SendReminderRequest + * + * Request to send a questionnaire reminder. + */ +export type SendReminderRequest = { + /** + * Message + * + * Optional custom reminder message + */ + message?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/SendReminderResponse.ts b/clients/admin-ui/src/types/api/models/SendReminderResponse.ts new file mode 100644 index 00000000000..ad20d53eb05 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/SendReminderResponse.ts @@ -0,0 +1,25 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * SendReminderResponse + * + * Response from sending a reminder. + */ +export type SendReminderResponse = { + /** + * Sent At + */ + sent_at: string; + /** + * Channel + */ + channel?: string | null; + /** + * Pending Questions + */ + pending_questions: number; + /** + * Message Id + */ + message_id?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/ServiceHealth.ts b/clients/admin-ui/src/types/api/models/ServiceHealth.ts index 0d065dc0bf2..d5aba0ab68b 100644 --- a/clients/admin-ui/src/types/api/models/ServiceHealth.ts +++ b/clients/admin-ui/src/types/api/models/ServiceHealth.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ServiceHealth + * * Service health options */ export enum ServiceHealth { diff --git a/clients/admin-ui/src/types/api/models/ServingComponent.ts b/clients/admin-ui/src/types/api/models/ServingComponent.ts index ab8a634d483..e1962d4feb9 100644 --- a/clients/admin-ui/src/types/api/models/ServingComponent.ts +++ b/clients/admin-ui/src/types/api/models/ServingComponent.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ServingComponent + * * This differs from component type because we want to record exactly * where consent was served. * diff --git a/clients/admin-ui/src/types/api/models/SetSystemLinksRequest.ts b/clients/admin-ui/src/types/api/models/SetSystemLinksRequest.ts new file mode 100644 index 00000000000..0d33df08330 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/SetSystemLinksRequest.ts @@ -0,0 +1,13 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { SystemLinkRequest } from "./SystemLinkRequest"; + +/** + * SetSystemLinksRequest + */ +export type SetSystemLinksRequest = { + /** + * Links + */ + links: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/SharedMonitorConfig.ts b/clients/admin-ui/src/types/api/models/SharedMonitorConfig.ts index d97d155daf1..57f37c6b75b 100644 --- a/clients/admin-ui/src/types/api/models/SharedMonitorConfig.ts +++ b/clients/admin-ui/src/types/api/models/SharedMonitorConfig.ts @@ -1,24 +1,33 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { MinimalClassifyParams } from "./MinimalClassifyParams"; /** + * SharedMonitorConfig + * * Model for shareable monitor configurations that can be reused across monitors. * Initially only sharing regex patterns, but extensible for future fields. */ export type SharedMonitorConfig = { + /** + * Id + */ id?: string | null; /** + * Name + * * The name of the shared monitor config. */ name: string; /** + * Key + * * Optional key of the shared monitor config. If a key is not provided, one will be generated from the name. */ key?: string | null; /** + * Description + * * A description of the shared monitor config. */ description?: string | null; diff --git a/clients/admin-ui/src/types/api/models/SingleFieldSubmissionResponse.ts b/clients/admin-ui/src/types/api/models/SingleFieldSubmissionResponse.ts index f9442511d63..0229c209824 100644 --- a/clients/admin-ui/src/types/api/models/SingleFieldSubmissionResponse.ts +++ b/clients/admin-ui/src/types/api/models/SingleFieldSubmissionResponse.ts @@ -1,34 +1,77 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { AttachmentResponse } from "./AttachmentResponse"; import type { CommentResponse } from "./CommentResponse"; /** + * SingleFieldSubmissionResponse + * * Response schema for single field submission */ export type SingleFieldSubmissionResponse = { + /** + * Privacy Request Id + */ privacy_request_id: string; + /** + * Connection Key + */ connection_key: string; + /** + * Field Key + */ field_key: string; /** + * Field Value + * * The field value (may be empty if attachments were provided) */ field_value: string; + /** + * Submission Id + */ submission_id: string; + /** + * Instance Id + */ instance_id: string; + /** + * Instance Status + */ instance_status: string; + /** + * Is Complete + */ is_complete: boolean; + /** + * Completed At + */ completed_at?: string | null; comment?: CommentResponse | null; /** + * Attachments + * * List of attachments for this field submission */ attachments?: Array; + /** + * Message + */ message: string; + /** + * User Id + */ user_id?: string | null; + /** + * User First Name + */ user_first_name?: string | null; + /** + * User Last Name + */ user_last_name?: string | null; + /** + * User Email Address + */ user_email_address?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/SlackChannel.ts b/clients/admin-ui/src/types/api/models/SlackChannel.ts index 9228417d55d..27a0583ce21 100644 --- a/clients/admin-ui/src/types/api/models/SlackChannel.ts +++ b/clients/admin-ui/src/types/api/models/SlackChannel.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * SlackChannel + * * Schema for a Slack channel. */ export type SlackChannel = { + /** + * Id + */ id: string; + /** + * Name + */ name: string; }; diff --git a/clients/admin-ui/src/types/api/models/SnowflakeDocsSchema.ts b/clients/admin-ui/src/types/api/models/SnowflakeDocsSchema.ts index 1993773b8ce..d4a0698a0a9 100644 --- a/clients/admin-ui/src/types/api/models/SnowflakeDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/SnowflakeDocsSchema.ts @@ -1,44 +1,62 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * SnowflakeDocsSchema + * * Snowflake Secrets Schema for API Docs */ export type SnowflakeDocsSchema = { /** + * Account Name + * * The unique identifier for your Snowflake account. */ account_identifier: string; /** + * Username + * * The user account used to authenticate and access the database. */ user_login_name: string; /** + * Password + * * The password used to authenticate and access the database. You can use a password or a private key, but not both. */ password?: string | null; /** + * Private key + * * The private key used to authenticate and access the database. If a `private_key_passphrase` is also provided, it is assumed to be encrypted; otherwise, it is assumed to be unencrypted. */ private_key?: string | null; /** + * Passphrase + * * The passphrase used for the encrypted private key. */ private_key_passphrase?: string | null; /** + * Warehouse + * * The name of the Snowflake warehouse where your queries will be executed. */ warehouse_name: string; /** + * Database + * * Only provide a database name to scope discovery monitors and privacy request automation to a specific database. In most cases, this can be left blank. */ database_name?: string | null; /** + * Schema + * * Only provide a schema to scope discovery monitors and privacy request automation to a specific schema. In most cases, this can be left blank. */ schema_name?: string | null; /** + * Role + * * The Snowflake role to assume for the session, if different than Username. */ role_name?: string | null; diff --git a/clients/admin-ui/src/types/api/models/SourcePreference.ts b/clients/admin-ui/src/types/api/models/SourcePreference.ts new file mode 100644 index 00000000000..e966e516666 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/SourcePreference.ts @@ -0,0 +1,21 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * SourcePreference + * + * Source preference information for preferences created by a propagation policy. + */ +export type SourcePreference = { + /** + * Notice Key + * + * The notice_key of the source preference, for a preference created by a propagation policy. + */ + notice_key: string; + /** + * Notice History Id + * + * The notice_history_id of the source preference, for a preference created by a propagation policy. + */ + notice_history_id: string; +}; diff --git a/clients/admin-ui/src/types/api/models/SovrnDocsSchema.ts b/clients/admin-ui/src/types/api/models/SovrnDocsSchema.ts index d44d9240cb0..cbcbfbc4451 100644 --- a/clients/admin-ui/src/types/api/models/SovrnDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/SovrnDocsSchema.ts @@ -1,15 +1,24 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { AdvancedSettingsWithExtendedIdentityTypes } from "./AdvancedSettingsWithExtendedIdentityTypes"; /** + * SovrnDocsSchema + * * SovrnDocsSchema Secrets Schema for API Docs */ export type SovrnDocsSchema = { + /** + * Test Email Address + */ test_email_address?: string | null; advanced_settings?: AdvancedSettingsWithExtendedIdentityTypes; + /** + * Third Party Vendor Name + */ third_party_vendor_name?: string; + /** + * Recipient Email Address + */ recipient_email_address?: string; }; diff --git a/clients/admin-ui/src/types/api/models/SpecialCategoryLegalBasisEnum.ts b/clients/admin-ui/src/types/api/models/SpecialCategoryLegalBasisEnum.ts index 8c16a65b64a..775c8411fa3 100644 --- a/clients/admin-ui/src/types/api/models/SpecialCategoryLegalBasisEnum.ts +++ b/clients/admin-ui/src/types/api/models/SpecialCategoryLegalBasisEnum.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * SpecialCategoryLegalBasisEnum + * * The model for the legal basis for processing special categories of personal data * on privacy declarations * @@ -10,13 +10,13 @@ */ export enum SpecialCategoryLegalBasisEnum { EXPLICIT_CONSENT = "Explicit consent", - EMPLOYMENT_SOCIAL_SECURITY_AND_SOCIAL_PROTECTION = "Employment, social security and social protection", + "EMPLOYMENT,_SOCIAL_SECURITY_AND_SOCIAL_PROTECTION" = "Employment, social security and social protection", VITAL_INTERESTS = "Vital interests", NOT_FOR_PROFIT_BODIES = "Not-for-profit bodies", MADE_PUBLIC_BY_THE_DATA_SUBJECT = "Made public by the data subject", LEGAL_CLAIMS_OR_JUDICIAL_ACTS = "Legal claims or judicial acts", - REASONS_OF_SUBSTANTIAL_PUBLIC_INTEREST_WITH_A_BASIS_IN_LAW_ = "Reasons of substantial public interest (with a basis in law)", - HEALTH_OR_SOCIAL_CARE_WITH_A_BASIS_IN_LAW_ = "Health or social care (with a basis in law)", - PUBLIC_HEALTH_WITH_A_BASIS_IN_LAW_ = "Public health (with a basis in law)", - ARCHIVING_RESEARCH_AND_STATISTICS_WITH_A_BASIS_IN_LAW_ = "Archiving, research and statistics (with a basis in law)", + "REASONS_OF_SUBSTANTIAL_PUBLIC_INTEREST (WITH_A_BASIS_IN_LAW)" = "Reasons of substantial public interest (with a basis in law)", + "HEALTH_OR_SOCIAL_CARE (WITH_A_BASIS_IN_LAW)" = "Health or social care (with a basis in law)", + "PUBLIC_HEALTH (WITH_A_BASIS_IN_LAW)" = "Public health (with a basis in law)", + "ARCHIVING,_RESEARCH_AND_STATISTICS (WITH_A_BASIS_IN_LAW)" = "Archiving, research and statistics (with a basis in law)", } diff --git a/clients/admin-ui/src/types/api/models/SqlDryRunMode.ts b/clients/admin-ui/src/types/api/models/SqlDryRunMode.ts index 5e1a9bcc069..7d7089b8a88 100644 --- a/clients/admin-ui/src/types/api/models/SqlDryRunMode.ts +++ b/clients/admin-ui/src/types/api/models/SqlDryRunMode.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * SqlDryRunMode + * * SQL dry run mode for controlling execution of SQL statements in privacy requests */ export enum SqlDryRunMode { diff --git a/clients/admin-ui/src/types/api/models/StagedResource.ts b/clients/admin-ui/src/types/api/models/StagedResource.ts index 72001140aef..72c1f1d6d0d 100644 --- a/clients/admin-ui/src/types/api/models/StagedResource.ts +++ b/clients/admin-ui/src/types/api/models/StagedResource.ts @@ -1,25 +1,52 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { DiffStatus } from "./DiffStatus"; -import type { StagedResourceTypeValue } from "./StagedResourceTypeValue"; +import { DiffStatus } from "./DiffStatus"; +import type { ResourceError } from "./ResourceError"; +import { StagedResourceTypeValue } from "./StagedResourceTypeValue"; /** + * StagedResource + * * Base API model that represents a staged resource, fields common to all types of staged resources */ export type StagedResource = { + /** + * Urn + */ urn: string; + /** + * User Assigned Data Categories + */ user_assigned_data_categories?: Array | null; /** + * User Assigned Data Uses + * * User assigned data uses overriding auto assigned data uses */ user_assigned_data_uses?: Array | null; + /** + * User Assigned System Key + */ user_assigned_system_key?: string | null; + /** + * Name + */ name?: string | null; + /** + * System Key + */ system_key?: string | null; + /** + * Description + */ description?: string | null; + /** + * Monitor Config Id + */ monitor_config_id?: string | null; + /** + * Updated At + */ updated_at?: string | null; /** * The diff status of the staged resource @@ -27,7 +54,15 @@ export type StagedResource = { diff_status?: DiffStatus | null; resource_type?: StagedResourceTypeValue | null; /** + * Data Uses + * * The data uses associated with the staged resource */ data_uses?: Array | null; + /** + * Errors + * + * List of errors encountered during processing + */ + errors?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/StagedResourceAPIResponse.ts b/clients/admin-ui/src/types/api/models/StagedResourceAPIResponse.ts index 0b841336a69..0e1fc76fb13 100644 --- a/clients/admin-ui/src/types/api/models/StagedResourceAPIResponse.ts +++ b/clients/admin-ui/src/types/api/models/StagedResourceAPIResponse.ts @@ -1,17 +1,18 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { Classification } from "./Classification"; +import type { ClassificationWithConfidence } from "./ClassificationWithConfidence"; import type { ConsentInfo } from "./ConsentInfo"; -import type { ConsentStatus } from "./ConsentStatus"; +import { ConsentStatus } from "./ConsentStatus"; +import type { ConsentStatusDetail } from "./ConsentStatusDetail"; import type { Constraint } from "./Constraint"; -import type { DiffStatus } from "./DiffStatus"; -import { IdentityProviderApplicationMetadata } from "./IdentityProviderApplicationMetadata"; +import { DiffStatus } from "./DiffStatus"; +import type { IdentityProviderApplicationMetadata } from "./IdentityProviderApplicationMetadata"; import type { ResourceError } from "./ResourceError"; -import type { StagedResourceTypeValue } from "./StagedResourceTypeValue"; +import { StagedResourceTypeValue } from "./StagedResourceTypeValue"; /** + * StagedResourceAPIResponse + * * Pydantic Schema used to represent any StageResource plus extra fields, used only for API responses. * It includes all the StagedResource fields, plus all the fields from Database, Schema, Table, and Field, * making these optional (since some resources will have them and some won't, depending on the type). @@ -26,17 +27,43 @@ import type { StagedResourceTypeValue } from "./StagedResourceTypeValue"; * - system: the name of the system related to the monitor, if applicable */ export type StagedResourceAPIResponse = { + /** + * Urn + */ urn: string; + /** + * User Assigned Data Categories + */ user_assigned_data_categories?: Array | null; /** + * User Assigned Data Uses + * * User assigned data uses overriding auto assigned data uses */ user_assigned_data_uses?: Array | null; + /** + * User Assigned System Key + */ user_assigned_system_key?: string | null; + /** + * Name + */ name?: string | null; + /** + * System Key + */ system_key?: string | null; + /** + * Description + */ description?: string | null; + /** + * Monitor Config Id + */ monitor_config_id?: string | null; + /** + * Updated At + */ updated_at?: string | null; /** * The diff status of the staged resource @@ -44,22 +71,48 @@ export type StagedResourceAPIResponse = { diff_status?: DiffStatus | null; resource_type?: StagedResourceTypeValue | null; /** + * Data Uses + * * The data uses associated with the staged resource */ data_uses?: Array | null; + /** + * Errors + * + * List of errors encountered during processing + */ + errors?: Array; + /** + * Source Modified + */ source_modified?: string | null; - classifications?: Array; + /** + * Classifications + */ + classifications?: Array; + /** + * Domain + */ domain?: string | null; /** + * Parent + * * The parent(s) of the asset, i.e. from where the asset was identified */ parent?: Array; /** + * Page + * * The page(s) where the asset was discovered */ page?: Array; + /** + * Parent Domain + */ parent_domain?: string | null; /** + * Locations + * * The location(s) from which the asset was discovered */ locations?: Array; @@ -72,35 +125,101 @@ export type StagedResourceAPIResponse = { */ consent_aggregated?: ConsentStatus | null; /** + * Consent Status Details + * + * Detailed consent status for each page and location where the asset was found + */ + consent_status_details?: { + [key: string]: { + [key: string]: ConsentStatusDetail; + }; + } | null; + /** + * Group Id + * + * The web monitor group ID associated with the asset + */ + group_id?: string | null; + /** + * Llm Classification + * + * LLM classification metadata stored for auditing + */ + llm_classification?: { + [key: string]: unknown; + } | null; + /** + * Vendor Id + * * The Compass Vendor ID associated with the asset */ vendor_id?: string | null; /** + * System Id + * * The Fides System ID associated with the asset */ system_id?: string | null; /** + * User Assigned System Id + * * User assigned system ID overriding auto assigned system ID */ user_assigned_system_id?: string | null; + /** + * Database Name + */ database_name?: string | null; + /** + * Schema Name + */ schema_name?: string | null; + /** + * Parent Table Urn + */ parent_table_urn?: string | null; + /** + * Table Name + */ table_name?: string | null; + /** + * Data Type + */ data_type?: string | null; + /** + * Fields + */ fields?: Array; + /** + * Num Rows + */ num_rows?: number | null; + /** + * Constraints + */ constraints?: Array; + /** + * Tables + */ tables?: Array; + /** + * Schemas + */ schemas?: Array; + /** + * System + */ system?: string | null; /** + * Child Diff Statuses + * * A map of diff statuses present in the descendants of this resource, e.g. {'addition': true} */ - child_diff_statuses?: Record; - /** An array of the "preferred" data uses for the asset; this encapsulates backend logic - * that will use either user_assigned_data_uses or data_uses, depending on their values. + child_diff_statuses?: { + [key in DiffStatus]?: boolean; + }; + /** + * Okta application metadata for identity provider resources (app_type, status, created, sign_on_url, etc.) */ metadata?: IdentityProviderApplicationMetadata | null; - preferred_data_uses?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/StagedResourceTypeValue.ts b/clients/admin-ui/src/types/api/models/StagedResourceTypeValue.ts index ca74a697b75..97ad1bd3750 100644 --- a/clients/admin-ui/src/types/api/models/StagedResourceTypeValue.ts +++ b/clients/admin-ui/src/types/api/models/StagedResourceTypeValue.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * StagedResourceTypeValue + * * Enum of the values used for `StagedResource.resource_type`s in the DB */ export enum StagedResourceTypeValue { diff --git a/clients/admin-ui/src/types/api/models/StagedResourceUpdateRequest.ts b/clients/admin-ui/src/types/api/models/StagedResourceUpdateRequest.ts index 7b9e35671fe..7aaa4679241 100644 --- a/clients/admin-ui/src/types/api/models/StagedResourceUpdateRequest.ts +++ b/clients/admin-ui/src/types/api/models/StagedResourceUpdateRequest.ts @@ -1,16 +1,27 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * StagedResourceUpdateRequest + * * Defines the subset of StagedResource fields permissable on update request payloads */ export type StagedResourceUpdateRequest = { + /** + * Urn + */ urn: string; + /** + * User Assigned Data Categories + */ user_assigned_data_categories?: Array | null; /** + * User Assigned Data Uses + * * User assigned data uses overriding auto assigned data uses */ user_assigned_data_uses?: Array | null; + /** + * User Assigned System Key + */ user_assigned_system_key?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/StatusEnum.ts b/clients/admin-ui/src/types/api/models/StatusEnum.ts index 7145b86bab1..fe59f27e2c0 100644 --- a/clients/admin-ui/src/types/api/models/StatusEnum.ts +++ b/clients/admin-ui/src/types/api/models/StatusEnum.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * StatusEnum + * * The model for possible evaluation results. */ export enum StatusEnum { diff --git a/clients/admin-ui/src/types/api/models/StatusType.ts b/clients/admin-ui/src/types/api/models/StatusType.ts index afa536a2cf9..364ea46d71b 100644 --- a/clients/admin-ui/src/types/api/models/StatusType.ts +++ b/clients/admin-ui/src/types/api/models/StatusType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * StatusType + * * Enum for manual task status. */ export enum StatusType { diff --git a/clients/admin-ui/src/types/api/models/StorageApplicationConfig.ts b/clients/admin-ui/src/types/api/models/StorageApplicationConfig.ts index 6a3a44392c1..60e0ab68813 100644 --- a/clients/admin-ui/src/types/api/models/StorageApplicationConfig.ts +++ b/clients/admin-ui/src/types/api/models/StorageApplicationConfig.ts @@ -1,9 +1,10 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { StorageTypeApiAccepted } from "./StorageTypeApiAccepted"; +import { StorageTypeApiAccepted } from "./StorageTypeApiAccepted"; +/** + * StorageApplicationConfig + */ export type StorageApplicationConfig = { active_default_storage_type: StorageTypeApiAccepted; }; diff --git a/clients/admin-ui/src/types/api/models/StorageConfigStatus.ts b/clients/admin-ui/src/types/api/models/StorageConfigStatus.ts index 719410563d9..f29189d904a 100644 --- a/clients/admin-ui/src/types/api/models/StorageConfigStatus.ts +++ b/clients/admin-ui/src/types/api/models/StorageConfigStatus.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * StorageConfigStatus + * * Enum for configuration statuses of a storage config */ export enum StorageConfigStatus { diff --git a/clients/admin-ui/src/types/api/models/StorageConfigStatusMessage.ts b/clients/admin-ui/src/types/api/models/StorageConfigStatusMessage.ts index 69c9ded8fdf..28885499753 100644 --- a/clients/admin-ui/src/types/api/models/StorageConfigStatusMessage.ts +++ b/clients/admin-ui/src/types/api/models/StorageConfigStatusMessage.ts @@ -1,13 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { StorageConfigStatus } from "./StorageConfigStatus"; +import { StorageConfigStatus } from "./StorageConfigStatus"; /** + * StorageConfigStatusMessage + * * A schema for checking configuration status of storage config. */ export type StorageConfigStatusMessage = { config_status?: StorageConfigStatus | null; + /** + * Detail + */ detail?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/StorageDestination.ts b/clients/admin-ui/src/types/api/models/StorageDestination.ts index dcc7ff53a7a..b81d5f82f44 100644 --- a/clients/admin-ui/src/types/api/models/StorageDestination.ts +++ b/clients/admin-ui/src/types/api/models/StorageDestination.ts @@ -1,20 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ResponseFormat } from "./ResponseFormat"; +import { ResponseFormat } from "./ResponseFormat"; import type { StorageDetailsGCS } from "./StorageDetailsGCS"; import type { StorageDetailsLocal } from "./StorageDetailsLocal"; import type { StorageDetailsS3 } from "./StorageDetailsS3"; -import type { StorageType } from "./StorageType"; +import { StorageType } from "./StorageType"; /** + * StorageDestination + * * Storage Destination Schema */ export type StorageDestination = { type: StorageType; + /** + * Details + */ details: StorageDetailsS3 | StorageDetailsGCS | StorageDetailsLocal; format?: ResponseFormat | null; + /** + * Name + */ name: string; + /** + * Key + */ key?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/StorageDestinationBase.ts b/clients/admin-ui/src/types/api/models/StorageDestinationBase.ts index 77023360167..b1ca4efcf22 100644 --- a/clients/admin-ui/src/types/api/models/StorageDestinationBase.ts +++ b/clients/admin-ui/src/types/api/models/StorageDestinationBase.ts @@ -1,18 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ResponseFormat } from "./ResponseFormat"; +import { ResponseFormat } from "./ResponseFormat"; import type { StorageDetailsGCS } from "./StorageDetailsGCS"; import type { StorageDetailsLocal } from "./StorageDetailsLocal"; import type { StorageDetailsS3 } from "./StorageDetailsS3"; -import type { StorageType } from "./StorageType"; +import { StorageType } from "./StorageType"; /** + * StorageDestinationBase + * * Storage Destination Schema -- used for setting defaults */ export type StorageDestinationBase = { type: StorageType; + /** + * Details + */ details: StorageDetailsS3 | StorageDetailsGCS | StorageDetailsLocal; format?: ResponseFormat | null; }; diff --git a/clients/admin-ui/src/types/api/models/StorageDestinationResponse.ts b/clients/admin-ui/src/types/api/models/StorageDestinationResponse.ts index 6dfc92bc1fb..66d97a778e5 100644 --- a/clients/admin-ui/src/types/api/models/StorageDestinationResponse.ts +++ b/clients/admin-ui/src/types/api/models/StorageDestinationResponse.ts @@ -1,18 +1,33 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ResponseFormat } from "./ResponseFormat"; -import type { StorageType } from "./StorageType"; +import { ResponseFormat } from "./ResponseFormat"; +import { StorageDetails } from "./StorageDetails"; +import { StorageType } from "./StorageType"; /** + * StorageDestinationResponse + * * Storage Destination Response Schema */ export type StorageDestinationResponse = { + /** + * Name + */ name: string; type: StorageType; - details: any; + /** + * Details + */ + details: { + [key in StorageDetails]?: unknown; + }; + /** + * Key + */ key: string; format: ResponseFormat; + /** + * Is Default + */ is_default?: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/StorageDetails.ts b/clients/admin-ui/src/types/api/models/StorageDetails.ts index 53bf055a0f5..dc860854c8a 100644 --- a/clients/admin-ui/src/types/api/models/StorageDetails.ts +++ b/clients/admin-ui/src/types/api/models/StorageDetails.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * StorageDetails + * * Enum for storage detail keys */ export enum StorageDetails { @@ -10,4 +10,6 @@ export enum StorageDetails { NAMING = "naming", MAX_RETRIES = "max_retries", AUTH_METHOD = "auth_method", + ENABLE_STREAMING = "enable_streaming", + ENABLE_ACCESS_PACKAGE_REDIRECT = "enable_access_package_redirect", } diff --git a/clients/admin-ui/src/types/api/models/StorageDetailsGCS.ts b/clients/admin-ui/src/types/api/models/StorageDetailsGCS.ts index ca6c0f490c0..913cf3de7f6 100644 --- a/clients/admin-ui/src/types/api/models/StorageDetailsGCS.ts +++ b/clients/admin-ui/src/types/api/models/StorageDetailsGCS.ts @@ -1,15 +1,24 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { GCSAuthMethod } from "./GCSAuthMethod"; +import { GCSAuthMethod } from "./GCSAuthMethod"; /** + * StorageDetailsGCS + * * The details required to represent a Google Cloud Storage bucket. */ export type StorageDetailsGCS = { + /** + * Naming + */ naming?: string; auth_method: GCSAuthMethod; + /** + * Bucket + */ bucket: string; + /** + * Max Retries + */ max_retries?: number | null; }; diff --git a/clients/admin-ui/src/types/api/models/StorageDetailsLocal.ts b/clients/admin-ui/src/types/api/models/StorageDetailsLocal.ts index 99af5c939fb..d73401a21f7 100644 --- a/clients/admin-ui/src/types/api/models/StorageDetailsLocal.ts +++ b/clients/admin-ui/src/types/api/models/StorageDetailsLocal.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * StorageDetailsLocal + * * The details required to configurate local storage configuration */ export type StorageDetailsLocal = { + /** + * Naming + */ naming?: string; }; diff --git a/clients/admin-ui/src/types/api/models/StorageDetailsS3.ts b/clients/admin-ui/src/types/api/models/StorageDetailsS3.ts index cd766b89b2d..eb84cc917ef 100644 --- a/clients/admin-ui/src/types/api/models/StorageDetailsS3.ts +++ b/clients/admin-ui/src/types/api/models/StorageDetailsS3.ts @@ -1,15 +1,32 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { AWSAuthMethod } from "./AWSAuthMethod"; +import { AWSAuthMethod } from "./AWSAuthMethod"; /** + * StorageDetailsS3 + * * The details required to represent an AWS S3 storage bucket. */ export type StorageDetailsS3 = { + /** + * Naming + */ naming?: string; auth_method: AWSAuthMethod; + /** + * Bucket + */ bucket: string; + /** + * Max Retries + */ max_retries?: number | null; + /** + * Enable Streaming + */ + enable_streaming?: boolean | null; + /** + * Enable Access Package Redirect + */ + enable_access_package_redirect?: boolean | null; }; diff --git a/clients/admin-ui/src/types/api/models/StorageSecretsGCSDocs.ts b/clients/admin-ui/src/types/api/models/StorageSecretsGCSDocs.ts index 73251fd3d7f..c97afb5deed 100644 --- a/clients/admin-ui/src/types/api/models/StorageSecretsGCSDocs.ts +++ b/clients/admin-ui/src/types/api/models/StorageSecretsGCSDocs.ts @@ -1,20 +1,53 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * StorageSecretsGCSDocs + * * The secrets required to connect to Google Cloud Storage, for documentation */ export type StorageSecretsGCSDocs = { + /** + * Type + */ type?: string; + /** + * Project Id + */ project_id: string; + /** + * Private Key Id + */ private_key_id: string; + /** + * Private Key + */ private_key: string; + /** + * Client Email + */ client_email: string; + /** + * Client Id + */ client_id: string; + /** + * Auth Uri + */ auth_uri: string; + /** + * Token Uri + */ token_uri: string; + /** + * Auth Provider X509 Cert Url + */ auth_provider_x509_cert_url: string; + /** + * Client X509 Cert Url + */ client_x509_cert_url: string; + /** + * Universe Domain + */ universe_domain: string; }; diff --git a/clients/admin-ui/src/types/api/models/StorageSecretsS3Docs.ts b/clients/admin-ui/src/types/api/models/StorageSecretsS3Docs.ts index ca94a4556c5..0802c9c83f6 100644 --- a/clients/admin-ui/src/types/api/models/StorageSecretsS3Docs.ts +++ b/clients/admin-ui/src/types/api/models/StorageSecretsS3Docs.ts @@ -1,13 +1,25 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * StorageSecretsS3Docs + * * The secrets required to connect to S3, for documentation */ export type StorageSecretsS3Docs = { + /** + * Aws Access Key Id + */ aws_access_key_id?: string | null; + /** + * Aws Secret Access Key + */ aws_secret_access_key?: string | null; + /** + * Region Name + */ region_name?: string | null; + /** + * Assume Role Arn + */ assume_role_arn?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/StorageType.ts b/clients/admin-ui/src/types/api/models/StorageType.ts index ed389750086..0a001867b9a 100644 --- a/clients/admin-ui/src/types/api/models/StorageType.ts +++ b/clients/admin-ui/src/types/api/models/StorageType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * StorageType + * * Enum for storage destination types */ export enum StorageType { diff --git a/clients/admin-ui/src/types/api/models/StorageTypeApiAccepted.ts b/clients/admin-ui/src/types/api/models/StorageTypeApiAccepted.ts index ee138e43149..276b5709f2c 100644 --- a/clients/admin-ui/src/types/api/models/StorageTypeApiAccepted.ts +++ b/clients/admin-ui/src/types/api/models/StorageTypeApiAccepted.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * StorageTypeApiAccepted + * * Enum for storage destination types accepted in API updates */ export enum StorageTypeApiAccepted { diff --git a/clients/admin-ui/src/types/api/models/Strategy.ts b/clients/admin-ui/src/types/api/models/Strategy.ts index 002a0e99ee5..0da9a3ab0d4 100644 --- a/clients/admin-ui/src/types/api/models/Strategy.ts +++ b/clients/admin-ui/src/types/api/models/Strategy.ts @@ -1,11 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * Strategy + * * General shape for swappable strategies (ex: auth, processors, pagination, etc.) */ export type Strategy = { + /** + * Strategy + */ strategy: string; - configuration: any; + /** + * Configuration + */ + configuration?: { + [key: string]: unknown; + } | null; }; diff --git a/clients/admin-ui/src/types/api/models/SupportedLanguage.ts b/clients/admin-ui/src/types/api/models/SupportedLanguage.ts index af6c8fb5cda..ebf892c5e40 100644 --- a/clients/admin-ui/src/types/api/models/SupportedLanguage.ts +++ b/clients/admin-ui/src/types/api/models/SupportedLanguage.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * SupportedLanguage + */ export enum SupportedLanguage { AR = "ar", BG = "bg", diff --git a/clients/admin-ui/src/types/api/models/System.ts b/clients/admin-ui/src/types/api/models/System.ts index 9fd0d01311b..f1bc3760633 100644 --- a/clients/admin-ui/src/types/api/models/System.ts +++ b/clients/admin-ui/src/types/api/models/System.ts @@ -1,40 +1,55 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { DataFlow } from "./DataFlow"; -import type { DataResponsibilityTitle } from "./DataResponsibilityTitle"; -import type { LegalBasisForProfilingEnum } from "./LegalBasisForProfilingEnum"; +import { DataResponsibilityTitle } from "./DataResponsibilityTitle"; +import { LegalBasisForProfilingEnum } from "./LegalBasisForProfilingEnum"; import type { PrivacyDeclaration } from "./PrivacyDeclaration"; import type { SystemMetadata } from "./SystemMetadata"; /** + * System + * * The System resource model. * * Describes an application and includes a list of PrivacyDeclaration resources. */ export type System = { /** + * Fides Key + * * A unique key used to identify this resource. */ fides_key: string; /** + * Organization Fides Key + * * Defines the Organization that this resource belongs to. */ organization_fides_key?: string; + /** + * Tags + */ tags?: Array | null; /** + * Name + * * Human-Readable name for this resource. */ name?: string | null; /** + * Description + * * A detailed description of what this resource is. */ description?: string | null; /** + * Meta + * * An optional property to store any extra information for a resource. Data can be structured in any way: simple set of `key: value` pairs or deeply nested objects. */ - meta?: null; + meta?: { + [key: string]: unknown; + } | null; /** * * The SystemMetadata resource model. @@ -44,18 +59,26 @@ export type System = { */ fidesctl_meta?: SystemMetadata | null; /** + * System Type + * * A required value to describe the type of system being modeled, examples include: Service, Application, Third Party, etc. */ system_type: string; /** + * Egress + * * The resources to which the system sends data. */ egress?: Array | null; /** + * Ingress + * * The resources from which the system receives data. */ ingress?: Array | null; /** + * Privacy Declarations + * * * The PrivacyDeclaration resource model. * @@ -65,78 +88,116 @@ export type System = { */ privacy_declarations: Array; /** + * Administrating Department + * * An optional value to identify the owning department or group of the system within your organization */ administrating_department?: string | null; /** + * Vendor Id + * * The unique identifier for the vendor that's associated with this system. */ vendor_id?: string | null; /** + * Previous Vendor Id + * * If specified, the unique identifier for the vendor that was previously associated with this system. */ previous_vendor_id?: string | null; /** + * Vendor Deleted Date + * * The deleted date of the vendor that's associated with this system. */ vendor_deleted_date?: string | null; /** + * Dataset References + * * Referenced Dataset fides keys used by the system. */ dataset_references?: Array; /** + * Processes Personal Data + * * This toggle indicates whether the system stores or processes personal data. */ processes_personal_data?: boolean; /** + * Exempt From Privacy Regulations + * * This toggle indicates whether the system is exempt from privacy regulation if they do process personal data. */ exempt_from_privacy_regulations?: boolean; /** + * Reason For Exemption + * * The reason that the system is exempt from privacy regulation. */ reason_for_exemption?: string | null; /** + * Uses Profiling + * * Whether the vendor uses data to profile a consumer in a way that has a legal effect. */ uses_profiling?: boolean; /** + * Legal Basis For Profiling + * * The legal basis (or bases) for performing profiling that has a legal effect. */ legal_basis_for_profiling?: Array; /** + * Does International Transfers + * * Whether this system transfers data to other countries or international organizations. */ does_international_transfers?: boolean; /** + * Legal Basis For Transfers + * * The legal basis (or bases) under which the data is transferred. */ legal_basis_for_transfers?: Array; /** + * Requires Data Protection Assessments + * * Whether this system requires data protection impact assessments. */ requires_data_protection_assessments?: boolean; /** + * Dpa Location + * * Location where the DPAs or DIPAs can be found. */ dpa_location?: string | null; /** + * Dpa Progress + * * The optional status of a Data Protection Impact Assessment */ dpa_progress?: string | null; /** + * Privacy Policy + * * A URL that points to the system's publicly accessible privacy policy. */ privacy_policy?: string | null; /** + * Legal Name + * * The legal name for the business represented by the system. */ legal_name?: string | null; /** + * Legal Address + * * The legal address for the business represented by the system. */ legal_address?: string | null; /** + * Responsibility + * * * The model defining the responsibility or role over * the system that processes personal data. @@ -147,34 +208,50 @@ export type System = { */ responsibility?: Array; /** + * Dpo + * * The official privacy contact address or DPO. */ dpo?: string | null; /** + * Joint Controller Info + * * The party or parties that share the responsibility for processing personal data. */ joint_controller_info?: string | null; /** + * Data Security Practices + * * The data security practices employed by this system. */ data_security_practices?: string | null; /** + * Cookie Max Age Seconds + * * The maximum storage duration, in seconds, for cookies used by this system. */ cookie_max_age_seconds?: number | null; /** + * Uses Cookies + * * Whether this system uses cookie storage. */ uses_cookies?: boolean; /** + * Cookie Refresh + * * Whether the system's cookies are refreshed after being initially set. */ cookie_refresh?: boolean; /** + * Uses Non Cookie Access + * * Whether the system uses non-cookie methods of storage or accessing information stored on a user's device. */ uses_non_cookie_access?: boolean; /** + * Legitimate Interest Disclosure Url + * * A URL that points to the system's publicly accessible legitimate interest disclosure. */ legitimate_interest_disclosure_url?: string | null; diff --git a/clients/admin-ui/src/types/api/models/SystemGroup.ts b/clients/admin-ui/src/types/api/models/SystemGroup.ts index 49598f340a2..f5c763d1115 100644 --- a/clients/admin-ui/src/types/api/models/SystemGroup.ts +++ b/clients/admin-ui/src/types/api/models/SystemGroup.ts @@ -1,30 +1,40 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { CustomTaxonomyColor } from "./CustomTaxonomyColor"; +import { CustomTaxonomyColor } from "./CustomTaxonomyColor"; /** + * SystemGroup + * * Schema for system group entities. */ export type SystemGroup = { /** + * Fides Key + * * A unique key used to identify this resource */ fides_key: string; /** + * Name + * * Human-readable name for this resource */ - name?: string; + name?: string | null; /** + * Description + * * A detailed description of what this resource is */ description?: string | null; /** + * Parent Key + * * The parent key for hierarchical relationships */ parent_key?: string | null; /** + * Active + * * Whether the resource is active */ active?: boolean; @@ -33,14 +43,20 @@ export type SystemGroup = { */ label_color?: CustomTaxonomyColor | null; /** + * Data Steward + * * Optional username of the group's steward */ data_steward?: string | null; /** + * Data Uses + * * List of DataUse fides_keys associated with the group */ data_uses?: Array; /** + * Systems + * * A list of system fides_keys that are part of this group */ systems?: Array; diff --git a/clients/admin-ui/src/types/api/models/SystemGroupCreate.ts b/clients/admin-ui/src/types/api/models/SystemGroupCreate.ts index 6cfb4f12040..f4ae3923d47 100644 --- a/clients/admin-ui/src/types/api/models/SystemGroupCreate.ts +++ b/clients/admin-ui/src/types/api/models/SystemGroupCreate.ts @@ -1,30 +1,40 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { CustomTaxonomyColor } from "./CustomTaxonomyColor"; +import { CustomTaxonomyColor } from "./CustomTaxonomyColor"; /** + * SystemGroupCreate + * * Schema for creating system group entities. */ export type SystemGroupCreate = { /** + * Fides Key + * * A unique key used to identify this resource */ fides_key?: string | null; /** + * Name + * * Human-readable name for this resource */ name: string; /** + * Description + * * A detailed description of what this resource is */ description?: string | null; /** + * Parent Key + * * The parent key for hierarchical relationships */ parent_key?: string | null; /** + * Active + * * Whether the resource is active */ active?: boolean | null; @@ -33,14 +43,20 @@ export type SystemGroupCreate = { */ label_color?: CustomTaxonomyColor | null; /** + * Data Steward + * * Optional username of the group's steward */ data_steward?: string | null; /** + * Data Uses + * * List of DataUse fides_keys associated with the group */ data_uses?: Array; /** + * Systems + * * A list of system fides_keys that are part of this group */ systems?: Array; diff --git a/clients/admin-ui/src/types/api/models/SystemGroupUpdate.ts b/clients/admin-ui/src/types/api/models/SystemGroupUpdate.ts index e0f84318489..3928394c933 100644 --- a/clients/admin-ui/src/types/api/models/SystemGroupUpdate.ts +++ b/clients/admin-ui/src/types/api/models/SystemGroupUpdate.ts @@ -1,26 +1,34 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { CustomTaxonomyColor } from "./CustomTaxonomyColor"; +import { CustomTaxonomyColor } from "./CustomTaxonomyColor"; /** + * SystemGroupUpdate + * * Schema for updating system group entities. */ export type SystemGroupUpdate = { /** + * Name + * * Human-readable name for this resource */ - name?: string; + name?: string | null; /** + * Description + * * A detailed description of what this resource is */ description?: string | null; /** + * Parent Key + * * The parent key for hierarchical relationships */ parent_key?: string | null; /** + * Active + * * Whether the resource is active */ active?: boolean | null; @@ -29,14 +37,20 @@ export type SystemGroupUpdate = { */ label_color?: CustomTaxonomyColor | null; /** + * Data Steward + * * Optional username of the group's steward */ data_steward?: string | null; /** + * Data Uses + * * List of DataUse fides_keys associated with the group */ data_uses?: Array | null; /** + * Systems + * * A list of system fides_keys that are part of this group */ systems?: Array | null; diff --git a/clients/admin-ui/src/types/api/models/SystemHistoryResponse.ts b/clients/admin-ui/src/types/api/models/SystemHistoryResponse.ts index 52896e90da8..be02e91c135 100644 --- a/clients/admin-ui/src/types/api/models/SystemHistoryResponse.ts +++ b/clients/admin-ui/src/types/api/models/SystemHistoryResponse.ts @@ -1,14 +1,33 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * SystemHistoryResponse + * * Response schema for a single system history entry */ export type SystemHistoryResponse = { + /** + * Edited By + */ edited_by?: string | null; + /** + * System Id + */ system_id: string; - before: any; - after: any; + /** + * Before + */ + before: { + [key: string]: unknown; + }; + /** + * After + */ + after: { + [key: string]: unknown; + }; + /** + * Created At + */ created_at: string; }; diff --git a/clients/admin-ui/src/types/api/models/SystemLinkRequest.ts b/clients/admin-ui/src/types/api/models/SystemLinkRequest.ts index 64b0c24a263..953b6961fee 100644 --- a/clients/admin-ui/src/types/api/models/SystemLinkRequest.ts +++ b/clients/admin-ui/src/types/api/models/SystemLinkRequest.ts @@ -1,7 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * SystemLinkRequest + */ export type SystemLinkRequest = { + /** + * System Fides Key + */ system_fides_key: string; }; diff --git a/clients/admin-ui/src/types/api/models/SystemLinkResponse.ts b/clients/admin-ui/src/types/api/models/SystemLinkResponse.ts index 60c8e9267e1..d15eb73706f 100644 --- a/clients/admin-ui/src/types/api/models/SystemLinkResponse.ts +++ b/clients/admin-ui/src/types/api/models/SystemLinkResponse.ts @@ -1,9 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * SystemLinkResponse + */ export type SystemLinkResponse = { - system_fides_key?: string | null; + /** + * System Fides Key + */ + system_fides_key: string; + /** + * System Name + */ system_name?: string | null; + /** + * Created At + */ created_at: string; }; diff --git a/clients/admin-ui/src/types/api/models/SystemMetadata.ts b/clients/admin-ui/src/types/api/models/SystemMetadata.ts index 8d64d4e6f14..495ef5d93b1 100644 --- a/clients/admin-ui/src/types/api/models/SystemMetadata.ts +++ b/clients/admin-ui/src/types/api/models/SystemMetadata.ts @@ -1,22 +1,28 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * SystemMetadata + * * The SystemMetadata resource model. * * Object used to hold application specific metadata for a system */ export type SystemMetadata = { /** + * Resource Id + * * The external resource id for the system being modeled. */ resource_id?: string | null; /** + * Endpoint Address + * * The host of the external resource for the system being modeled. */ endpoint_address?: string | null; /** + * Endpoint Port + * * The port of the external resource for the system being modeled. */ endpoint_port?: string | null; diff --git a/clients/admin-ui/src/types/api/models/SystemPurposeSummary.ts b/clients/admin-ui/src/types/api/models/SystemPurposeSummary.ts index c57bb717124..8c47bd8cff6 100644 --- a/clients/admin-ui/src/types/api/models/SystemPurposeSummary.ts +++ b/clients/admin-ui/src/types/api/models/SystemPurposeSummary.ts @@ -1,14 +1,33 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * SystemPurposeSummary + * * A summary of privacy declaration information for a system aggregated by TCF purpose. */ export type SystemPurposeSummary = { + /** + * Fides Key + */ fides_key: string; + /** + * Name + */ name: string; - purposes: Record>>; + /** + * Purposes + */ + purposes: { + [key: string]: { + [key: string]: Array; + }; + }; + /** + * Features + */ features: Array; + /** + * Data Categories + */ data_categories: Array; }; diff --git a/clients/admin-ui/src/types/api/models/SystemResponse.ts b/clients/admin-ui/src/types/api/models/SystemResponse.ts index 035efeaf1c1..69bfc836d03 100644 --- a/clients/admin-ui/src/types/api/models/SystemResponse.ts +++ b/clients/admin-ui/src/types/api/models/SystemResponse.ts @@ -1,16 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConnectionConfigurationResponse } from "./ConnectionConfigurationResponse"; import type { DataFlow } from "./DataFlow"; -import type { DataResponsibilityTitle } from "./DataResponsibilityTitle"; -import type { LegalBasisForProfilingEnum } from "./LegalBasisForProfilingEnum"; +import { DataResponsibilityTitle } from "./DataResponsibilityTitle"; +import { LegalBasisForProfilingEnum } from "./LegalBasisForProfilingEnum"; import type { PrivacyDeclarationResponse } from "./PrivacyDeclarationResponse"; import type { SystemMetadata } from "./SystemMetadata"; import type { UserResponse } from "./UserResponse"; /** + * SystemResponse + * * Extension of base pydantic response model to include additional relationship fields that * may require extra DB queries, like `privacy_declarations`, connection_config fields and cookies. * @@ -19,26 +19,41 @@ import type { UserResponse } from "./UserResponse"; */ export type SystemResponse = { /** + * Fides Key + * * A unique key used to identify this resource. */ fides_key: string; /** + * Organization Fides Key + * * Defines the Organization that this resource belongs to. */ organization_fides_key?: string; + /** + * Tags + */ tags?: Array | null; /** + * Name + * * Human-Readable name for this resource. */ name?: string | null; /** + * Description + * * A detailed description of what this resource is. */ description?: string | null; /** + * Meta + * * An optional property to store any extra information for a resource. Data can be structured in any way: simple set of `key: value` pairs or deeply nested objects. */ - meta?: null; + meta?: { + [key: string]: unknown; + } | null; /** * * The SystemMetadata resource model. @@ -48,94 +63,140 @@ export type SystemResponse = { */ fidesctl_meta?: SystemMetadata | null; /** + * System Type + * * A required value to describe the type of system being modeled, examples include: Service, Application, Third Party, etc. */ system_type: string; /** + * Egress + * * The resources to which the system sends data. */ egress?: Array | null; /** + * Ingress + * * The resources from which the system receives data. */ ingress?: Array | null; /** + * Privacy Declarations + * * Extension of base pydantic model to include DB `id` field in the response */ privacy_declarations: Array; /** + * Administrating Department + * * An optional value to identify the owning department or group of the system within your organization */ administrating_department?: string | null; /** + * Vendor Id + * * The unique identifier for the vendor that's associated with this system. */ vendor_id?: string | null; /** + * Previous Vendor Id + * * If specified, the unique identifier for the vendor that was previously associated with this system. */ previous_vendor_id?: string | null; /** + * Vendor Deleted Date + * * The deleted date of the vendor that's associated with this system. */ vendor_deleted_date?: string | null; /** + * Dataset References + * * Referenced Dataset fides keys used by the system. */ dataset_references?: Array; /** + * Processes Personal Data + * * This toggle indicates whether the system stores or processes personal data. */ processes_personal_data?: boolean; /** + * Exempt From Privacy Regulations + * * This toggle indicates whether the system is exempt from privacy regulation if they do process personal data. */ exempt_from_privacy_regulations?: boolean; /** + * Reason For Exemption + * * The reason that the system is exempt from privacy regulation. */ reason_for_exemption?: string | null; /** + * Uses Profiling + * * Whether the vendor uses data to profile a consumer in a way that has a legal effect. */ uses_profiling?: boolean; /** + * Legal Basis For Profiling + * * The legal basis (or bases) for performing profiling that has a legal effect. */ legal_basis_for_profiling?: Array; /** + * Does International Transfers + * * Whether this system transfers data to other countries or international organizations. */ does_international_transfers?: boolean; /** + * Legal Basis For Transfers + * * The legal basis (or bases) under which the data is transferred. */ legal_basis_for_transfers?: Array; /** + * Requires Data Protection Assessments + * * Whether this system requires data protection impact assessments. */ requires_data_protection_assessments?: boolean; /** + * Dpa Location + * * Location where the DPAs or DIPAs can be found. */ dpa_location?: string | null; /** + * Dpa Progress + * * The optional status of a Data Protection Impact Assessment */ dpa_progress?: string | null; /** + * Privacy Policy + * * A URL that points to the system's publicly accessible privacy policy. */ privacy_policy?: string | null; /** + * Legal Name + * * The legal name for the business represented by the system. */ legal_name?: string | null; /** + * Legal Address + * * The legal address for the business represented by the system. */ legal_address?: string | null; /** + * Responsibility + * * * The model defining the responsibility or role over * the system that processes personal data. @@ -146,45 +207,68 @@ export type SystemResponse = { */ responsibility?: Array; /** + * Dpo + * * The official privacy contact address or DPO. */ dpo?: string | null; /** + * Joint Controller Info + * * The party or parties that share the responsibility for processing personal data. */ joint_controller_info?: string | null; /** + * Data Security Practices + * * The data security practices employed by this system. */ data_security_practices?: string | null; /** + * Cookie Max Age Seconds + * * The maximum storage duration, in seconds, for cookies used by this system. */ cookie_max_age_seconds?: number | null; /** + * Uses Cookies + * * Whether this system uses cookie storage. */ uses_cookies?: boolean; /** + * Cookie Refresh + * * Whether the system's cookies are refreshed after being initially set. */ cookie_refresh?: boolean; /** + * Uses Non Cookie Access + * * Whether the system uses non-cookie methods of storage or accessing information stored on a user's device. */ uses_non_cookie_access?: boolean; /** + * Legitimate Interest Disclosure Url + * * A URL that points to the system's publicly accessible legitimate interest disclosure. */ legitimate_interest_disclosure_url?: string | null; + /** + * Created At + */ created_at: string; /** + * Connection Configs + * * * Describes the returned schema for a ConnectionConfiguration. * */ connection_configs: Array | null; /** + * Data Stewards + * * System managers of the current system */ data_stewards: Array | null; diff --git a/clients/admin-ui/src/types/api/models/SystemResponseExtended.ts b/clients/admin-ui/src/types/api/models/SystemResponseExtended.ts index 87a9351e3a6..846be19f31e 100644 --- a/clients/admin-ui/src/types/api/models/SystemResponseExtended.ts +++ b/clients/admin-ui/src/types/api/models/SystemResponseExtended.ts @@ -1,16 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConnectionConfigurationResponse } from "./ConnectionConfigurationResponse"; import type { DataFlow } from "./DataFlow"; -import type { DataResponsibilityTitle } from "./DataResponsibilityTitle"; -import type { LegalBasisForProfilingEnum } from "./LegalBasisForProfilingEnum"; +import { DataResponsibilityTitle } from "./DataResponsibilityTitle"; +import { LegalBasisForProfilingEnum } from "./LegalBasisForProfilingEnum"; import type { PrivacyDeclarationResponse } from "./PrivacyDeclarationResponse"; import type { SystemMetadata } from "./SystemMetadata"; import type { UserResponse } from "./UserResponse"; /** + * SystemResponseExtended + * * Extended version of SystemResponse that includes system group information. * * This response model extends the full SystemResponse (which includes connection_configs, @@ -18,26 +18,41 @@ import type { UserResponse } from "./UserResponse"; */ export type SystemResponseExtended = { /** + * Fides Key + * * A unique key used to identify this resource. */ fides_key: string; /** + * Organization Fides Key + * * Defines the Organization that this resource belongs to. */ organization_fides_key?: string; + /** + * Tags + */ tags?: Array | null; /** + * Name + * * Human-Readable name for this resource. */ name?: string | null; /** + * Description + * * A detailed description of what this resource is. */ description?: string | null; /** + * Meta + * * An optional property to store any extra information for a resource. Data can be structured in any way: simple set of `key: value` pairs or deeply nested objects. */ - meta?: null; + meta?: { + [key: string]: unknown; + } | null; /** * * The SystemMetadata resource model. @@ -47,94 +62,140 @@ export type SystemResponseExtended = { */ fidesctl_meta?: SystemMetadata | null; /** + * System Type + * * A required value to describe the type of system being modeled, examples include: Service, Application, Third Party, etc. */ system_type: string; /** + * Egress + * * The resources to which the system sends data. */ egress?: Array | null; /** + * Ingress + * * The resources from which the system receives data. */ ingress?: Array | null; /** + * Privacy Declarations + * * Extension of base pydantic model to include DB `id` field in the response */ privacy_declarations: Array; /** + * Administrating Department + * * An optional value to identify the owning department or group of the system within your organization */ administrating_department?: string | null; /** + * Vendor Id + * * The unique identifier for the vendor that's associated with this system. */ vendor_id?: string | null; /** + * Previous Vendor Id + * * If specified, the unique identifier for the vendor that was previously associated with this system. */ previous_vendor_id?: string | null; /** + * Vendor Deleted Date + * * The deleted date of the vendor that's associated with this system. */ vendor_deleted_date?: string | null; /** + * Dataset References + * * Referenced Dataset fides keys used by the system. */ dataset_references?: Array; /** + * Processes Personal Data + * * This toggle indicates whether the system stores or processes personal data. */ processes_personal_data?: boolean; /** + * Exempt From Privacy Regulations + * * This toggle indicates whether the system is exempt from privacy regulation if they do process personal data. */ exempt_from_privacy_regulations?: boolean; /** + * Reason For Exemption + * * The reason that the system is exempt from privacy regulation. */ reason_for_exemption?: string | null; /** + * Uses Profiling + * * Whether the vendor uses data to profile a consumer in a way that has a legal effect. */ uses_profiling?: boolean; /** + * Legal Basis For Profiling + * * The legal basis (or bases) for performing profiling that has a legal effect. */ legal_basis_for_profiling?: Array; /** + * Does International Transfers + * * Whether this system transfers data to other countries or international organizations. */ does_international_transfers?: boolean; /** + * Legal Basis For Transfers + * * The legal basis (or bases) under which the data is transferred. */ legal_basis_for_transfers?: Array; /** + * Requires Data Protection Assessments + * * Whether this system requires data protection impact assessments. */ requires_data_protection_assessments?: boolean; /** + * Dpa Location + * * Location where the DPAs or DIPAs can be found. */ dpa_location?: string | null; /** + * Dpa Progress + * * The optional status of a Data Protection Impact Assessment */ dpa_progress?: string | null; /** + * Privacy Policy + * * A URL that points to the system's publicly accessible privacy policy. */ privacy_policy?: string | null; /** + * Legal Name + * * The legal name for the business represented by the system. */ legal_name?: string | null; /** + * Legal Address + * * The legal address for the business represented by the system. */ legal_address?: string | null; /** + * Responsibility + * * * The model defining the responsibility or role over * the system that processes personal data. @@ -145,49 +206,74 @@ export type SystemResponseExtended = { */ responsibility?: Array; /** + * Dpo + * * The official privacy contact address or DPO. */ dpo?: string | null; /** + * Joint Controller Info + * * The party or parties that share the responsibility for processing personal data. */ joint_controller_info?: string | null; /** + * Data Security Practices + * * The data security practices employed by this system. */ data_security_practices?: string | null; /** + * Cookie Max Age Seconds + * * The maximum storage duration, in seconds, for cookies used by this system. */ cookie_max_age_seconds?: number | null; /** + * Uses Cookies + * * Whether this system uses cookie storage. */ uses_cookies?: boolean; /** + * Cookie Refresh + * * Whether the system's cookies are refreshed after being initially set. */ cookie_refresh?: boolean; /** + * Uses Non Cookie Access + * * Whether the system uses non-cookie methods of storage or accessing information stored on a user's device. */ uses_non_cookie_access?: boolean; /** + * Legitimate Interest Disclosure Url + * * A URL that points to the system's publicly accessible legitimate interest disclosure. */ legitimate_interest_disclosure_url?: string | null; + /** + * Created At + */ created_at: string; /** + * Connection Configs + * * * Describes the returned schema for a ConnectionConfiguration. * */ connection_configs: Array | null; /** + * Data Stewards + * * System managers of the current system */ data_stewards: Array | null; /** + * System Groups + * * List of system group fides_keys this system belongs to */ system_groups?: Array; diff --git a/clients/admin-ui/src/types/api/models/SystemScanHistory.ts b/clients/admin-ui/src/types/api/models/SystemScanHistory.ts index 5c17eb58723..e95afd6cb0b 100644 --- a/clients/admin-ui/src/types/api/models/SystemScanHistory.ts +++ b/clients/admin-ui/src/types/api/models/SystemScanHistory.ts @@ -1,13 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { System } from "./System"; +/** + * SystemScanHistory + */ export type SystemScanHistory = { + /** + * Id + */ id: number; + /** + * Status + */ status: string; + /** + * Result + */ result: Array; + /** + * Created At + */ created_at: string; + /** + * Updated At + */ updated_at: string; }; diff --git a/clients/admin-ui/src/types/api/models/SystemScanResponse.ts b/clients/admin-ui/src/types/api/models/SystemScanResponse.ts index 988568275fb..5fec3c4cab2 100644 --- a/clients/admin-ui/src/types/api/models/SystemScanResponse.ts +++ b/clients/admin-ui/src/types/api/models/SystemScanResponse.ts @@ -1,9 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { System } from "./System"; +/** + * SystemScanResponse + */ export type SystemScanResponse = { + /** + * Systems + */ systems: Array; }; diff --git a/clients/admin-ui/src/types/api/models/SystemScannerStatus.ts b/clients/admin-ui/src/types/api/models/SystemScannerStatus.ts index c816da2ab87..19d15723d02 100644 --- a/clients/admin-ui/src/types/api/models/SystemScannerStatus.ts +++ b/clients/admin-ui/src/types/api/models/SystemScannerStatus.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ClusterHealth } from "./ClusterHealth"; +import { ClusterHealth } from "./ClusterHealth"; /** + * SystemScannerStatus + * * System scanner status schema */ export type SystemScannerStatus = { + /** + * Enabled + */ enabled?: boolean; cluster_health?: ClusterHealth | null; + /** + * Cluster Error + */ cluster_error?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/SystemSchemaExtended.ts b/clients/admin-ui/src/types/api/models/SystemSchemaExtended.ts index eccea543cc6..342a73d8834 100644 --- a/clients/admin-ui/src/types/api/models/SystemSchemaExtended.ts +++ b/clients/admin-ui/src/types/api/models/SystemSchemaExtended.ts @@ -1,39 +1,54 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { DataFlow } from "./DataFlow"; -import type { DataResponsibilityTitle } from "./DataResponsibilityTitle"; -import type { LegalBasisForProfilingEnum } from "./LegalBasisForProfilingEnum"; +import { DataResponsibilityTitle } from "./DataResponsibilityTitle"; +import { LegalBasisForProfilingEnum } from "./LegalBasisForProfilingEnum"; import type { PrivacyDeclaration } from "./PrivacyDeclaration"; import type { SystemMetadata } from "./SystemMetadata"; /** + * SystemSchemaExtended + * * Extends the base Fideslang System schema with a `system_groups` field used by * Fidesplus to assign the system to one or more system groups during update operations. */ export type SystemSchemaExtended = { /** + * Fides Key + * * A unique key used to identify this resource. */ fides_key: string; /** + * Organization Fides Key + * * Defines the Organization that this resource belongs to. */ organization_fides_key?: string; + /** + * Tags + */ tags?: Array | null; /** + * Name + * * Human-Readable name for this resource. */ name?: string | null; /** + * Description + * * A detailed description of what this resource is. */ description?: string | null; /** + * Meta + * * An optional property to store any extra information for a resource. Data can be structured in any way: simple set of `key: value` pairs or deeply nested objects. */ - meta?: null; + meta?: { + [key: string]: unknown; + } | null; /** * * The SystemMetadata resource model. @@ -43,18 +58,26 @@ export type SystemSchemaExtended = { */ fidesctl_meta?: SystemMetadata | null; /** + * System Type + * * A required value to describe the type of system being modeled, examples include: Service, Application, Third Party, etc. */ system_type: string; /** + * Egress + * * The resources to which the system sends data. */ egress?: Array | null; /** + * Ingress + * * The resources from which the system receives data. */ ingress?: Array | null; /** + * Privacy Declarations + * * * The PrivacyDeclaration resource model. * @@ -64,78 +87,116 @@ export type SystemSchemaExtended = { */ privacy_declarations: Array; /** + * Administrating Department + * * An optional value to identify the owning department or group of the system within your organization */ administrating_department?: string | null; /** + * Vendor Id + * * The unique identifier for the vendor that's associated with this system. */ vendor_id?: string | null; /** + * Previous Vendor Id + * * If specified, the unique identifier for the vendor that was previously associated with this system. */ previous_vendor_id?: string | null; /** + * Vendor Deleted Date + * * The deleted date of the vendor that's associated with this system. */ vendor_deleted_date?: string | null; /** + * Dataset References + * * Referenced Dataset fides keys used by the system. */ dataset_references?: Array; /** + * Processes Personal Data + * * This toggle indicates whether the system stores or processes personal data. */ processes_personal_data?: boolean; /** + * Exempt From Privacy Regulations + * * This toggle indicates whether the system is exempt from privacy regulation if they do process personal data. */ exempt_from_privacy_regulations?: boolean; /** + * Reason For Exemption + * * The reason that the system is exempt from privacy regulation. */ reason_for_exemption?: string | null; /** + * Uses Profiling + * * Whether the vendor uses data to profile a consumer in a way that has a legal effect. */ uses_profiling?: boolean; /** + * Legal Basis For Profiling + * * The legal basis (or bases) for performing profiling that has a legal effect. */ legal_basis_for_profiling?: Array; /** + * Does International Transfers + * * Whether this system transfers data to other countries or international organizations. */ does_international_transfers?: boolean; /** + * Legal Basis For Transfers + * * The legal basis (or bases) under which the data is transferred. */ legal_basis_for_transfers?: Array; /** + * Requires Data Protection Assessments + * * Whether this system requires data protection impact assessments. */ requires_data_protection_assessments?: boolean; /** + * Dpa Location + * * Location where the DPAs or DIPAs can be found. */ dpa_location?: string | null; /** + * Dpa Progress + * * The optional status of a Data Protection Impact Assessment */ dpa_progress?: string | null; /** + * Privacy Policy + * * A URL that points to the system's publicly accessible privacy policy. */ privacy_policy?: string | null; /** + * Legal Name + * * The legal name for the business represented by the system. */ legal_name?: string | null; /** + * Legal Address + * * The legal address for the business represented by the system. */ legal_address?: string | null; /** + * Responsibility + * * * The model defining the responsibility or role over * the system that processes personal data. @@ -146,38 +207,56 @@ export type SystemSchemaExtended = { */ responsibility?: Array; /** + * Dpo + * * The official privacy contact address or DPO. */ dpo?: string | null; /** + * Joint Controller Info + * * The party or parties that share the responsibility for processing personal data. */ joint_controller_info?: string | null; /** + * Data Security Practices + * * The data security practices employed by this system. */ data_security_practices?: string | null; /** + * Cookie Max Age Seconds + * * The maximum storage duration, in seconds, for cookies used by this system. */ cookie_max_age_seconds?: number | null; /** + * Uses Cookies + * * Whether this system uses cookie storage. */ uses_cookies?: boolean; /** + * Cookie Refresh + * * Whether the system's cookies are refreshed after being initially set. */ cookie_refresh?: boolean; /** + * Uses Non Cookie Access + * * Whether the system uses non-cookie methods of storage or accessing information stored on a user's device. */ uses_non_cookie_access?: boolean; /** + * Legitimate Interest Disclosure Url + * * A URL that points to the system's publicly accessible legitimate interest disclosure. */ legitimate_interest_disclosure_url?: string | null; /** + * System Groups + * * List of system group fides_keys this system should belong to after the update. */ system_groups?: Array; diff --git a/clients/admin-ui/src/types/api/models/SystemStagedResourcesAggregateRecord.ts b/clients/admin-ui/src/types/api/models/SystemStagedResourcesAggregateRecord.ts index bbc5a32c156..b00045c7da1 100644 --- a/clients/admin-ui/src/types/api/models/SystemStagedResourcesAggregateRecord.ts +++ b/clients/admin-ui/src/types/api/models/SystemStagedResourcesAggregateRecord.ts @@ -1,25 +1,46 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConsentAlertInfo } from "./ConsentAlertInfo"; -import { IdentityProviderApplicationMetadata } from "./IdentityProviderApplicationMetadata"; /** + * SystemStagedResourcesAggregateRecord + * * API response model for records of aggregated staged resources by system */ export type SystemStagedResourcesAggregateRecord = { /** + * Id + * * The aggregate record ID, either a system fides_key or a vendor ID */ id?: string | null; + /** + * Name + */ name?: string | null; + /** + * System Key + */ system_key?: string | null; + /** + * Data Uses + */ data_uses?: Array; + /** + * Vendor Id + */ vendor_id?: string | null; + /** + * Total Updates + */ total_updates?: number; + /** + * Locations + */ locations?: Array; + /** + * Domains + */ domains?: Array; consent_status?: ConsentAlertInfo | null; - metadata?: IdentityProviderApplicationMetadata | null; }; diff --git a/clients/admin-ui/src/types/api/models/SystemSummary.ts b/clients/admin-ui/src/types/api/models/SystemSummary.ts index 270a81d02ed..4b9cb1819cf 100644 --- a/clients/admin-ui/src/types/api/models/SystemSummary.ts +++ b/clients/admin-ui/src/types/api/models/SystemSummary.ts @@ -1,18 +1,45 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * SystemSummary + * * A summary of a system with aggregate counts for select fields. */ export type SystemSummary = { + /** + * Id + */ id: string; + /** + * Fides Key + */ fides_key: string; + /** + * Vendor Id + */ vendor_id?: string | null; + /** + * Name + */ name: string; + /** + * Purposes + */ purposes: number; + /** + * Cookies + */ cookies: number; + /** + * Data Uses + */ data_uses: number; + /** + * Legal Bases + */ legal_bases: number; + /** + * Consent Categories + */ consent_categories: number; }; diff --git a/clients/admin-ui/src/types/api/models/SystemType.ts b/clients/admin-ui/src/types/api/models/SystemType.ts index d858c1e3371..538460cab8f 100644 --- a/clients/admin-ui/src/types/api/models/SystemType.ts +++ b/clients/admin-ui/src/types/api/models/SystemType.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * SystemType + */ export enum SystemType { DATA_CATALOG = "data_catalog", DATABASE = "database", diff --git a/clients/admin-ui/src/types/api/models/SystemWithMonitorKeys.ts b/clients/admin-ui/src/types/api/models/SystemWithMonitorKeys.ts index 175f5fdf5ea..38e73c2d374 100644 --- a/clients/admin-ui/src/types/api/models/SystemWithMonitorKeys.ts +++ b/clients/admin-ui/src/types/api/models/SystemWithMonitorKeys.ts @@ -1,40 +1,55 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConnectionConfigurationResponse } from "./ConnectionConfigurationResponse"; import type { DataFlow } from "./DataFlow"; -import type { DataResponsibilityTitle } from "./DataResponsibilityTitle"; -import type { LegalBasisForProfilingEnum } from "./LegalBasisForProfilingEnum"; +import { DataResponsibilityTitle } from "./DataResponsibilityTitle"; +import { LegalBasisForProfilingEnum } from "./LegalBasisForProfilingEnum"; import type { PrivacyDeclarationResponse } from "./PrivacyDeclarationResponse"; import type { SystemMetadata } from "./SystemMetadata"; import type { UserResponse } from "./UserResponse"; /** + * SystemWithMonitorKeys + * * Extended System response with the monitor config keys attached to the system via ConnectionConfig */ export type SystemWithMonitorKeys = { /** + * Fides Key + * * A unique key used to identify this resource. */ fides_key: string; /** + * Organization Fides Key + * * Defines the Organization that this resource belongs to. */ organization_fides_key?: string; + /** + * Tags + */ tags?: Array | null; /** + * Name + * * Human-Readable name for this resource. */ name?: string | null; /** + * Description + * * A detailed description of what this resource is. */ description?: string | null; /** + * Meta + * * An optional property to store any extra information for a resource. Data can be structured in any way: simple set of `key: value` pairs or deeply nested objects. */ - meta?: null; + meta?: { + [key: string]: unknown; + } | null; /** * * The SystemMetadata resource model. @@ -44,94 +59,140 @@ export type SystemWithMonitorKeys = { */ fidesctl_meta?: SystemMetadata | null; /** + * System Type + * * A required value to describe the type of system being modeled, examples include: Service, Application, Third Party, etc. */ system_type: string; /** + * Egress + * * The resources to which the system sends data. */ egress?: Array | null; /** + * Ingress + * * The resources from which the system receives data. */ ingress?: Array | null; /** + * Privacy Declarations + * * Extension of base pydantic model to include DB `id` field in the response */ privacy_declarations: Array; /** + * Administrating Department + * * An optional value to identify the owning department or group of the system within your organization */ administrating_department?: string | null; /** + * Vendor Id + * * The unique identifier for the vendor that's associated with this system. */ vendor_id?: string | null; /** + * Previous Vendor Id + * * If specified, the unique identifier for the vendor that was previously associated with this system. */ previous_vendor_id?: string | null; /** + * Vendor Deleted Date + * * The deleted date of the vendor that's associated with this system. */ vendor_deleted_date?: string | null; /** + * Dataset References + * * Referenced Dataset fides keys used by the system. */ dataset_references?: Array; /** + * Processes Personal Data + * * This toggle indicates whether the system stores or processes personal data. */ processes_personal_data?: boolean; /** + * Exempt From Privacy Regulations + * * This toggle indicates whether the system is exempt from privacy regulation if they do process personal data. */ exempt_from_privacy_regulations?: boolean; /** + * Reason For Exemption + * * The reason that the system is exempt from privacy regulation. */ reason_for_exemption?: string | null; /** + * Uses Profiling + * * Whether the vendor uses data to profile a consumer in a way that has a legal effect. */ uses_profiling?: boolean; /** + * Legal Basis For Profiling + * * The legal basis (or bases) for performing profiling that has a legal effect. */ legal_basis_for_profiling?: Array; /** + * Does International Transfers + * * Whether this system transfers data to other countries or international organizations. */ does_international_transfers?: boolean; /** + * Legal Basis For Transfers + * * The legal basis (or bases) under which the data is transferred. */ legal_basis_for_transfers?: Array; /** + * Requires Data Protection Assessments + * * Whether this system requires data protection impact assessments. */ requires_data_protection_assessments?: boolean; /** + * Dpa Location + * * Location where the DPAs or DIPAs can be found. */ dpa_location?: string | null; /** + * Dpa Progress + * * The optional status of a Data Protection Impact Assessment */ dpa_progress?: string | null; /** + * Privacy Policy + * * A URL that points to the system's publicly accessible privacy policy. */ privacy_policy?: string | null; /** + * Legal Name + * * The legal name for the business represented by the system. */ legal_name?: string | null; /** + * Legal Address + * * The legal address for the business represented by the system. */ legal_address?: string | null; /** + * Responsibility + * * * The model defining the responsibility or role over * the system that processes personal data. @@ -142,47 +203,73 @@ export type SystemWithMonitorKeys = { */ responsibility?: Array; /** + * Dpo + * * The official privacy contact address or DPO. */ dpo?: string | null; /** + * Joint Controller Info + * * The party or parties that share the responsibility for processing personal data. */ joint_controller_info?: string | null; /** + * Data Security Practices + * * The data security practices employed by this system. */ data_security_practices?: string | null; /** + * Cookie Max Age Seconds + * * The maximum storage duration, in seconds, for cookies used by this system. */ cookie_max_age_seconds?: number | null; /** + * Uses Cookies + * * Whether this system uses cookie storage. */ uses_cookies?: boolean; /** + * Cookie Refresh + * * Whether the system's cookies are refreshed after being initially set. */ cookie_refresh?: boolean; /** + * Uses Non Cookie Access + * * Whether the system uses non-cookie methods of storage or accessing information stored on a user's device. */ uses_non_cookie_access?: boolean; /** + * Legitimate Interest Disclosure Url + * * A URL that points to the system's publicly accessible legitimate interest disclosure. */ legitimate_interest_disclosure_url?: string | null; + /** + * Created At + */ created_at: string; /** + * Connection Configs + * * * Describes the returned schema for a ConnectionConfiguration. * */ connection_configs: Array | null; /** + * Data Stewards + * * System managers of the current system */ data_stewards: Array | null; + /** + * Monitor Config Keys + */ monitor_config_keys?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/SystemsDiff.ts b/clients/admin-ui/src/types/api/models/SystemsDiff.ts index f2af3d3b9fc..76f6e3e0eb8 100644 --- a/clients/admin-ui/src/types/api/models/SystemsDiff.ts +++ b/clients/admin-ui/src/types/api/models/SystemsDiff.ts @@ -1,17 +1,43 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { System } from "./System"; /** + * SystemsDiff + * * A schema representing the diff between the scan and saved systems */ export type SystemsDiff = { - added_ingress: Record>; - added_egress: Record>; - removed_ingress: Record>; - removed_egress: Record>; + /** + * Added Ingress + */ + added_ingress: { + [key: string]: Array; + }; + /** + * Added Egress + */ + added_egress: { + [key: string]: Array; + }; + /** + * Removed Ingress + */ + removed_ingress: { + [key: string]: Array; + }; + /** + * Removed Egress + */ + removed_egress: { + [key: string]: Array; + }; + /** + * Added Systems + */ added_systems: Array; + /** + * Removed Systems + */ removed_systems: Array; }; diff --git a/clients/admin-ui/src/types/api/models/TCDecode.ts b/clients/admin-ui/src/types/api/models/TCDecode.ts index 9a83dc1d9de..f0ae72b9450 100644 --- a/clients/admin-ui/src/types/api/models/TCDecode.ts +++ b/clients/admin-ui/src/types/api/models/TCDecode.ts @@ -1,10 +1,10 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { TCMobileData } from "./TCMobileData"; /** + * TCDecode + * * Decode response schema for returning TC Mobile Data */ export type TCDecode = { diff --git a/clients/admin-ui/src/types/api/models/TCFBannerExperienceMinimalResponse.ts b/clients/admin-ui/src/types/api/models/TCFBannerExperienceMinimalResponse.ts index 454f141cdc3..55f50752a8a 100644 --- a/clients/admin-ui/src/types/api/models/TCFBannerExperienceMinimalResponse.ts +++ b/clients/admin-ui/src/types/api/models/TCFBannerExperienceMinimalResponse.ts @@ -1,6 +1,4 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ExperienceMinimalMeta } from "./ExperienceMinimalMeta"; import type { fidesplus__schemas__tcf_experience__TCFPublisherRestrictionResponse } from "./fidesplus__schemas__tcf_experience__TCFPublisherRestrictionResponse"; @@ -9,11 +7,15 @@ import type { PrivacyExperienceGPPSettings } from "./PrivacyExperienceGPPSetting import type { PrivacyNoticeResponse } from "./PrivacyNoticeResponse"; /** + * TCFBannerExperienceMinimalResponse + * * Minimal TCF Banner Privacy Experience response that has the details to show the most minimal * TCF banner possible and the details to make a follow up request to save that notices were served. */ export type TCFBannerExperienceMinimalResponse = { /** + * Available Locales + * * Available translations for this experience */ available_locales?: Array | null; @@ -22,77 +24,118 @@ export type TCFBannerExperienceMinimalResponse = { */ experience_config?: MinimalTCFExperienceConfig | null; /** + * Privacy Notices + * * The Privacy Notices associated with this experience, if applicable */ privacy_notices?: Array | null; /** + * Non Applicable Privacy Notices + * * The notice keys of the Privacy Notices that are enabled, but not applicable to the experience */ non_applicable_privacy_notices?: Array | null; gpp_settings?: PrivacyExperienceGPPSettings | null; /** + * Id + * * Privacy Experience ID */ id: string; - gvl?: null; + /** + * Gvl + */ + gvl?: { + [key: string]: unknown; + } | null; meta?: ExperienceMinimalMeta | null; /** + * Minimal Tcf + * * Helps FE detect that this is a minimal TCF response */ minimal_tcf?: boolean | null; /** + * Tcf Purpose Names + * * TCF Purpose names for banner display */ tcf_purpose_names: Array; /** + * Tcf Special Feature Names + * * TCF Special Feature names for banner display */ tcf_special_feature_names: Array; /** + * Tcf Feature Ids + * * Feature IDs */ tcf_feature_ids: Array; /** + * Tcf Purpose Consent Ids + * * Purpose IDs used with legal basis of consent */ tcf_purpose_consent_ids: Array; /** + * Tcf Purpose Legitimate Interest Ids + * * Purpose IDs used with legal basis of legitimate interests */ tcf_purpose_legitimate_interest_ids: Array; /** + * Tcf Special Feature Ids + * * Special feature IDs */ tcf_special_feature_ids: Array; /** + * Tcf Special Purpose Ids + * * Special purpose IDs */ tcf_special_purpose_ids: Array; /** + * Tcf System Consent Ids + * * Fides system IDs using data with legal basis of legitimate interests */ tcf_system_consent_ids: Array; /** + * Tcf System Legitimate Interest Ids + * * Fides System IDs using data with legal basis of legitimate interests */ tcf_system_legitimate_interest_ids: Array; /** + * Tcf Vendor Consent Ids + * * Vendor IDs using data with legal basis of consent */ tcf_vendor_consent_ids: Array; /** + * Tcf Vendor Legitimate Interest Ids + * * Vendor IDs using data with legal basis of legitimate interests */ tcf_vendor_legitimate_interest_ids: Array; /** + * Tcf Publisher Restrictions + * * Publisher restrictions for the TCF Experience */ tcf_publisher_restrictions?: Array; /** + * Tcf Publisher Country Code + * * The country code of the country that determines the legislation of reference. Commonly, this corresponds to the country in which the publisher's business entity is established. */ tcf_publisher_country_code?: string | null; /** + * Vendor Count + * * The total number of Vendors and Fides systems displayed in the TCF Experience */ vendor_count?: number | null; diff --git a/clients/admin-ui/src/types/api/models/TCFConfigurationDetail.ts b/clients/admin-ui/src/types/api/models/TCFConfigurationDetail.ts index 49a82b25bc2..294c84d96d6 100644 --- a/clients/admin-ui/src/types/api/models/TCFConfigurationDetail.ts +++ b/clients/admin-ui/src/types/api/models/TCFConfigurationDetail.ts @@ -1,23 +1,31 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { TCFRestrictionType } from "./TCFRestrictionType"; +import { TCFRestrictionType } from "./TCFRestrictionType"; /** + * TCFConfigurationDetail + * * Schema for TCF Configuration detail responses */ export type TCFConfigurationDetail = { /** + * Id + * * The unique identifier of the TCF Configuration */ id: string; /** + * Name + * * The unique name of the TCF Configuration */ name: string; /** + * Restriction Types Per Purpose + * * The restriction_types defined for this configuration, grouped per purpose */ - restriction_types_per_purpose?: Record>; + restriction_types_per_purpose?: { + [key: string]: Array; + }; }; diff --git a/clients/admin-ui/src/types/api/models/TCFConfigurationRequest.ts b/clients/admin-ui/src/types/api/models/TCFConfigurationRequest.ts index 527b8593b55..eab39566dfb 100644 --- a/clients/admin-ui/src/types/api/models/TCFConfigurationRequest.ts +++ b/clients/admin-ui/src/types/api/models/TCFConfigurationRequest.ts @@ -1,12 +1,14 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TCFConfigurationRequest + * * Schema for TCF Configuration creation/update requests */ export type TCFConfigurationRequest = { /** + * Name + * * The unique name of the TCF Configuration */ name: string; diff --git a/clients/admin-ui/src/types/api/models/TCFConfigurationResponse.ts b/clients/admin-ui/src/types/api/models/TCFConfigurationResponse.ts index ff69fe1e083..6b06cdbff7a 100644 --- a/clients/admin-ui/src/types/api/models/TCFConfigurationResponse.ts +++ b/clients/admin-ui/src/types/api/models/TCFConfigurationResponse.ts @@ -1,16 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TCFConfigurationResponse + * * Schema for TCF Configuration responses */ export type TCFConfigurationResponse = { /** + * Id + * * The unique identifier of the TCF Configuration */ id: string; /** + * Name + * * The unique name of the TCF Configuration */ name: string; diff --git a/clients/admin-ui/src/types/api/models/TCFFeatureRecord.ts b/clients/admin-ui/src/types/api/models/TCFFeatureRecord.ts index 27df382c816..b11b90c46ae 100644 --- a/clients/admin-ui/src/types/api/models/TCFFeatureRecord.ts +++ b/clients/admin-ui/src/types/api/models/TCFFeatureRecord.ts @@ -1,27 +1,39 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { EmbeddedVendor } from "./EmbeddedVendor"; -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * TCFFeatureRecord + * * Schema for a TCF Feature: returned in the TCF Overlay Experience */ export type TCFFeatureRecord = { /** + * Id + * * Official GVL feature ID or special feature ID */ id: number; /** + * Name + * * Name of the GVL feature or special feature. */ name: string; /** + * Description + * * Description of the GVL feature or special feature. */ description: string; default_preference?: UserConsentPreference | null; + /** + * Vendors + */ vendors?: Array; + /** + * Systems + */ systems?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/TCFFeatureSave.ts b/clients/admin-ui/src/types/api/models/TCFFeatureSave.ts index 5cd9d6729a3..fafb093a8d9 100644 --- a/clients/admin-ui/src/types/api/models/TCFFeatureSave.ts +++ b/clients/admin-ui/src/types/api/models/TCFFeatureSave.ts @@ -1,13 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * TCFFeatureSave + * * Schema for saving a user's preference with respect to a TCF feature */ export type TCFFeatureSave = { + /** + * Id + */ id: number; preference: UserConsentPreference; }; diff --git a/clients/admin-ui/src/types/api/models/TCFLegalBasisEnum.ts b/clients/admin-ui/src/types/api/models/TCFLegalBasisEnum.ts index 59a20d7b0f9..6baaf6d3fe9 100644 --- a/clients/admin-ui/src/types/api/models/TCFLegalBasisEnum.ts +++ b/clients/admin-ui/src/types/api/models/TCFLegalBasisEnum.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TCFLegalBasisEnum + * * Restricts the Legal Basis to just those that are relevant for TCF */ export enum TCFLegalBasisEnum { diff --git a/clients/admin-ui/src/types/api/models/TCFPreferences.ts b/clients/admin-ui/src/types/api/models/TCFPreferences.ts index 2fd24bd720d..234e61873fa 100644 --- a/clients/admin-ui/src/types/api/models/TCFPreferences.ts +++ b/clients/admin-ui/src/types/api/models/TCFPreferences.ts @@ -1,6 +1,4 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { TCFFeatureSave } from "./TCFFeatureSave"; import type { TCFPurposeSave } from "./TCFPurposeSave"; @@ -9,16 +7,45 @@ import type { TCFSpecialPurposeSave } from "./TCFSpecialPurposeSave"; import type { TCFVendorSave } from "./TCFVendorSave"; /** + * TCFPreferences + * * All TCF Attributes against which consent can be saved */ export type TCFPreferences = { + /** + * Purpose Consent Preferences + */ purpose_consent_preferences?: Array; + /** + * Purpose Legitimate Interests Preferences + */ purpose_legitimate_interests_preferences?: Array; + /** + * Vendor Consent Preferences + */ vendor_consent_preferences?: Array; + /** + * Vendor Legitimate Interests Preferences + */ vendor_legitimate_interests_preferences?: Array; + /** + * Special Feature Preferences + */ special_feature_preferences?: Array; + /** + * Special Purpose Preferences + */ special_purpose_preferences?: Array; + /** + * Feature Preferences + */ feature_preferences?: Array; + /** + * System Consent Preferences + */ system_consent_preferences?: Array; + /** + * System Legitimate Interests Preferences + */ system_legitimate_interests_preferences?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/TCFPublisherRestrictionRequest.ts b/clients/admin-ui/src/types/api/models/TCFPublisherRestrictionRequest.ts index 8118016495d..404f821c6fa 100644 --- a/clients/admin-ui/src/types/api/models/TCFPublisherRestrictionRequest.ts +++ b/clients/admin-ui/src/types/api/models/TCFPublisherRestrictionRequest.ts @@ -1,16 +1,18 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { RangeEntry } from "./RangeEntry"; -import type { TCFRestrictionType } from "./TCFRestrictionType"; -import type { TCFVendorRestriction } from "./TCFVendorRestriction"; +import { TCFRestrictionType } from "./TCFRestrictionType"; +import { TCFVendorRestriction } from "./TCFVendorRestriction"; /** + * TCFPublisherRestrictionRequest + * * Schema for TCF Publisher Restriction creation/update requests */ export type TCFPublisherRestrictionRequest = { /** + * Purpose Id + * * The ID of the purpose this restriction applies to */ purpose_id: number; @@ -23,6 +25,8 @@ export type TCFPublisherRestrictionRequest = { */ vendor_restriction: TCFVendorRestriction; /** + * Range Entries + * * List of vendor ranges this restriction applies to */ range_entries?: Array; diff --git a/clients/admin-ui/src/types/api/models/TCFPublisherRestrictionUpdateRequest.ts b/clients/admin-ui/src/types/api/models/TCFPublisherRestrictionUpdateRequest.ts index 8a59023bcbb..2a845ab9a65 100644 --- a/clients/admin-ui/src/types/api/models/TCFPublisherRestrictionUpdateRequest.ts +++ b/clients/admin-ui/src/types/api/models/TCFPublisherRestrictionUpdateRequest.ts @@ -1,12 +1,12 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { RangeEntry } from "./RangeEntry"; -import type { TCFRestrictionType } from "./TCFRestrictionType"; -import type { TCFVendorRestriction } from "./TCFVendorRestriction"; +import { TCFRestrictionType } from "./TCFRestrictionType"; +import { TCFVendorRestriction } from "./TCFVendorRestriction"; /** + * TCFPublisherRestrictionUpdateRequest + * * Schema for TCF Publisher Restriction update requests */ export type TCFPublisherRestrictionUpdateRequest = { @@ -19,6 +19,8 @@ export type TCFPublisherRestrictionUpdateRequest = { */ vendor_restriction?: TCFVendorRestriction | null; /** + * Range Entries + * * List of vendor ranges this restriction applies to */ range_entries?: Array | null; diff --git a/clients/admin-ui/src/types/api/models/TCFPurposeConsentRecord.ts b/clients/admin-ui/src/types/api/models/TCFPurposeConsentRecord.ts index 00f8c4b8771..195bec0142b 100644 --- a/clients/admin-ui/src/types/api/models/TCFPurposeConsentRecord.ts +++ b/clients/admin-ui/src/types/api/models/TCFPurposeConsentRecord.ts @@ -1,35 +1,51 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { EmbeddedVendor } from "./EmbeddedVendor"; -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * TCFPurposeConsentRecord + * * Schema for a TCF Purpose with Consent Legal Basis returned in the TCF Overlay Experience */ export type TCFPurposeConsentRecord = { /** + * Id + * * Official GVL purpose ID. Used for linking with other records, e.g. vendors, cookies, etc. */ id: number; /** + * Name + * * Name of the GVL purpose. */ name: string; /** + * Description + * * Description of the GVL purpose. */ description: string; /** + * Illustrations + * * Illustrative examples of the purpose. */ illustrations: Array; /** + * Data Uses + * * The fideslang default taxonomy data uses that are associated with the purpose. */ data_uses: Array; default_preference?: UserConsentPreference | null; + /** + * Vendors + */ vendors?: Array; + /** + * Systems + */ systems?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/TCFPurposeLegitimateInterestsRecord.ts b/clients/admin-ui/src/types/api/models/TCFPurposeLegitimateInterestsRecord.ts index 122b45500dc..656f63ff579 100644 --- a/clients/admin-ui/src/types/api/models/TCFPurposeLegitimateInterestsRecord.ts +++ b/clients/admin-ui/src/types/api/models/TCFPurposeLegitimateInterestsRecord.ts @@ -1,35 +1,51 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { EmbeddedVendor } from "./EmbeddedVendor"; -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * TCFPurposeLegitimateInterestsRecord + * * Schema for a TCF Purpose with Legitimate Interests Legal Basis returned in the TCF Overlay Experience */ export type TCFPurposeLegitimateInterestsRecord = { /** + * Id + * * Official GVL purpose ID. Used for linking with other records, e.g. vendors, cookies, etc. */ id: number; /** + * Name + * * Name of the GVL purpose. */ name: string; /** + * Description + * * Description of the GVL purpose. */ description: string; /** + * Illustrations + * * Illustrative examples of the purpose. */ illustrations: Array; /** + * Data Uses + * * The fideslang default taxonomy data uses that are associated with the purpose. */ data_uses: Array; default_preference?: UserConsentPreference | null; + /** + * Vendors + */ vendors?: Array; + /** + * Systems + */ systems?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/TCFPurposeOverrideSchema.ts b/clients/admin-ui/src/types/api/models/TCFPurposeOverrideSchema.ts index e91662cb073..733d72d2f22 100644 --- a/clients/admin-ui/src/types/api/models/TCFPurposeOverrideSchema.ts +++ b/clients/admin-ui/src/types/api/models/TCFPurposeOverrideSchema.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { TCFLegalBasisEnum } from "./TCFLegalBasisEnum"; +import { TCFLegalBasisEnum } from "./TCFLegalBasisEnum"; /** + * TCFPurposeOverrideSchema + * * TCF Purpose Override Schema */ export type TCFPurposeOverrideSchema = { + /** + * Purpose + */ purpose: number; + /** + * Is Included + */ is_included?: boolean | null; required_legal_basis?: TCFLegalBasisEnum | null; }; diff --git a/clients/admin-ui/src/types/api/models/TCFPurposeSave.ts b/clients/admin-ui/src/types/api/models/TCFPurposeSave.ts index 6d1182dcaa2..51f0237b187 100644 --- a/clients/admin-ui/src/types/api/models/TCFPurposeSave.ts +++ b/clients/admin-ui/src/types/api/models/TCFPurposeSave.ts @@ -1,13 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * TCFPurposeSave + * * Schema for saving preferences with respect to a TCF Purpose */ export type TCFPurposeSave = { + /** + * Id + */ id: number; preference: UserConsentPreference; }; diff --git a/clients/admin-ui/src/types/api/models/TCFRestrictionType.ts b/clients/admin-ui/src/types/api/models/TCFRestrictionType.ts index 158312d1461..c19402db83e 100644 --- a/clients/admin-ui/src/types/api/models/TCFRestrictionType.ts +++ b/clients/admin-ui/src/types/api/models/TCFRestrictionType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TCFRestrictionType + * * Enum for TCF restriction types */ export enum TCFRestrictionType { diff --git a/clients/admin-ui/src/types/api/models/TCFSpecialFeatureRecord.ts b/clients/admin-ui/src/types/api/models/TCFSpecialFeatureRecord.ts index d823ff30797..df7c4ca5850 100644 --- a/clients/admin-ui/src/types/api/models/TCFSpecialFeatureRecord.ts +++ b/clients/admin-ui/src/types/api/models/TCFSpecialFeatureRecord.ts @@ -1,27 +1,39 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { EmbeddedVendor } from "./EmbeddedVendor"; -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * TCFSpecialFeatureRecord + * * Schema for a TCF Special Feature: returned in the TCF Overlay Experience */ export type TCFSpecialFeatureRecord = { /** + * Id + * * Official GVL feature ID or special feature ID */ id: number; /** + * Name + * * Name of the GVL feature or special feature. */ name: string; /** + * Description + * * Description of the GVL feature or special feature. */ description: string; default_preference?: UserConsentPreference | null; + /** + * Vendors + */ vendors?: Array; + /** + * Systems + */ systems?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/TCFSpecialFeatureSave.ts b/clients/admin-ui/src/types/api/models/TCFSpecialFeatureSave.ts index 446df985ab2..303a41c4da0 100644 --- a/clients/admin-ui/src/types/api/models/TCFSpecialFeatureSave.ts +++ b/clients/admin-ui/src/types/api/models/TCFSpecialFeatureSave.ts @@ -1,13 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * TCFSpecialFeatureSave + * * Schema for saving a user's preference with respect to a TCF special feature */ export type TCFSpecialFeatureSave = { + /** + * Id + */ id: number; preference: UserConsentPreference; }; diff --git a/clients/admin-ui/src/types/api/models/TCFSpecialPurposeRecord.ts b/clients/admin-ui/src/types/api/models/TCFSpecialPurposeRecord.ts index ddfce6108e4..1d4e8e4340a 100644 --- a/clients/admin-ui/src/types/api/models/TCFSpecialPurposeRecord.ts +++ b/clients/admin-ui/src/types/api/models/TCFSpecialPurposeRecord.ts @@ -1,36 +1,55 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { EmbeddedVendor } from "./EmbeddedVendor"; -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * TCFSpecialPurposeRecord + * * Schema for a TCF Special Purpose returned in the TCF Overlay Experience */ export type TCFSpecialPurposeRecord = { /** + * Id + * * Official GVL purpose ID. Used for linking with other records, e.g. vendors, cookies, etc. */ id: number; /** + * Name + * * Name of the GVL purpose. */ name: string; /** + * Description + * * Description of the GVL purpose. */ description: string; /** + * Illustrations + * * Illustrative examples of the purpose. */ illustrations: Array; /** + * Data Uses + * * The fideslang default taxonomy data uses that are associated with the purpose. */ data_uses: Array; default_preference?: UserConsentPreference | null; + /** + * Vendors + */ vendors?: Array; + /** + * Systems + */ systems?: Array; + /** + * Legal Bases + */ legal_bases?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/TCFSpecialPurposeSave.ts b/clients/admin-ui/src/types/api/models/TCFSpecialPurposeSave.ts index 27b4ac46b9f..ecaaaee8114 100644 --- a/clients/admin-ui/src/types/api/models/TCFSpecialPurposeSave.ts +++ b/clients/admin-ui/src/types/api/models/TCFSpecialPurposeSave.ts @@ -1,13 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * TCFSpecialPurposeSave + * * Schema for saving preferences with respect to a TCF Special Purpose */ export type TCFSpecialPurposeSave = { + /** + * Id + */ id: number; preference: UserConsentPreference; }; diff --git a/clients/admin-ui/src/types/api/models/TCFStatus.ts b/clients/admin-ui/src/types/api/models/TCFStatus.ts index d387682fcfc..0baf081be91 100644 --- a/clients/admin-ui/src/types/api/models/TCFStatus.ts +++ b/clients/admin-ui/src/types/api/models/TCFStatus.ts @@ -1,7 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * TCFStatus + */ export type TCFStatus = { + /** + * Enabled + */ enabled?: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/TCFVendorConsentRecord.ts b/clients/admin-ui/src/types/api/models/TCFVendorConsentRecord.ts index 8f22b0cc86c..c9a3f858212 100644 --- a/clients/admin-ui/src/types/api/models/TCFVendorConsentRecord.ts +++ b/clients/admin-ui/src/types/api/models/TCFVendorConsentRecord.ts @@ -1,19 +1,37 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { EmbeddedPurpose } from "./EmbeddedPurpose"; -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * TCFVendorConsentRecord + * * Schema for a TCF Vendor with Consent legal basis */ export type TCFVendorConsentRecord = { + /** + * Id + */ id: string; + /** + * Has Vendor Id + */ has_vendor_id?: boolean | null; + /** + * Name + */ name?: string | null; + /** + * Description + */ description?: string | null; + /** + * Vendor Deleted Date + */ vendor_deleted_date?: string | null; default_preference?: UserConsentPreference | null; + /** + * Purpose Consents + */ purpose_consents?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/TCFVendorLegitimateInterestsRecord.ts b/clients/admin-ui/src/types/api/models/TCFVendorLegitimateInterestsRecord.ts index c5dc56aea7d..2e13b9c45f5 100644 --- a/clients/admin-ui/src/types/api/models/TCFVendorLegitimateInterestsRecord.ts +++ b/clients/admin-ui/src/types/api/models/TCFVendorLegitimateInterestsRecord.ts @@ -1,19 +1,37 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { EmbeddedPurpose } from "./EmbeddedPurpose"; -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * TCFVendorLegitimateInterestsRecord + * * Schema for a TCF Vendor with Legitimate interests legal basis */ export type TCFVendorLegitimateInterestsRecord = { + /** + * Id + */ id: string; + /** + * Has Vendor Id + */ has_vendor_id?: boolean | null; + /** + * Name + */ name?: string | null; + /** + * Description + */ description?: string | null; + /** + * Vendor Deleted Date + */ vendor_deleted_date?: string | null; default_preference?: UserConsentPreference | null; + /** + * Purpose Legitimate Interests + */ purpose_legitimate_interests?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/TCFVendorRelationships.ts b/clients/admin-ui/src/types/api/models/TCFVendorRelationships.ts index 6734c7249ba..c488cecbda2 100644 --- a/clients/admin-ui/src/types/api/models/TCFVendorRelationships.ts +++ b/clients/admin-ui/src/types/api/models/TCFVendorRelationships.ts @@ -1,26 +1,68 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { EmbeddedLineItem } from "./EmbeddedLineItem"; import type { EmbeddedPurpose } from "./EmbeddedPurpose"; /** + * TCFVendorRelationships + * * Collects the other relationships for a given vendor - no preferences are saved here */ export type TCFVendorRelationships = { + /** + * Id + */ id: string; + /** + * Has Vendor Id + */ has_vendor_id?: boolean | null; + /** + * Name + */ name?: string | null; + /** + * Description + */ description?: string | null; + /** + * Vendor Deleted Date + */ vendor_deleted_date?: string | null; + /** + * Special Purposes + */ special_purposes?: Array; + /** + * Features + */ features?: Array; + /** + * Special Features + */ special_features?: Array; + /** + * Cookie Max Age Seconds + */ cookie_max_age_seconds?: number | null; + /** + * Uses Cookies + */ uses_cookies?: boolean | null; + /** + * Cookie Refresh + */ cookie_refresh?: boolean | null; + /** + * Uses Non Cookie Access + */ uses_non_cookie_access?: boolean | null; + /** + * Legitimate Interest Disclosure Url + */ legitimate_interest_disclosure_url?: string | null; + /** + * Privacy Policy Url + */ privacy_policy_url?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/TCFVendorRestriction.ts b/clients/admin-ui/src/types/api/models/TCFVendorRestriction.ts index d29e43cb9dc..cd249c3cee7 100644 --- a/clients/admin-ui/src/types/api/models/TCFVendorRestriction.ts +++ b/clients/admin-ui/src/types/api/models/TCFVendorRestriction.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TCFVendorRestriction + * * Enum for TCF vendor restriction types */ export enum TCFVendorRestriction { diff --git a/clients/admin-ui/src/types/api/models/TCFVendorSave.ts b/clients/admin-ui/src/types/api/models/TCFVendorSave.ts index 99920a009af..875266f40b3 100644 --- a/clients/admin-ui/src/types/api/models/TCFVendorSave.ts +++ b/clients/admin-ui/src/types/api/models/TCFVendorSave.ts @@ -1,14 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { UserConsentPreference } from "./UserConsentPreference"; +import { UserConsentPreference } from "./UserConsentPreference"; /** + * TCFVendorSave + * * Base schema for saving preferences with respect to a TCF Vendor or a System * TODO: TCF Add validation for allowable vendors (in GVL or dictionary?) */ export type TCFVendorSave = { + /** + * Id + */ id: string; preference: UserConsentPreference; }; diff --git a/clients/admin-ui/src/types/api/models/TCMobileData.ts b/clients/admin-ui/src/types/api/models/TCMobileData.ts index f3c05539603..76353ad5519 100644 --- a/clients/admin-ui/src/types/api/models/TCMobileData.ts +++ b/clients/admin-ui/src/types/api/models/TCMobileData.ts @@ -1,72 +1,115 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TCMobileData + * * Pre-parsed TC data and TC string for a CMP SDK: * * https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/TCFv2/IAB%20Tech%20Lab%20-%20CMP%20API%20v2.md#in-app-details */ export type TCMobileData = { /** + * Iabtcf Cmpsdkid + * * The unsigned integer ID of CMP SDK */ IABTCF_CmpSdkID?: number | null; /** + * Iabtcf Cmpsdkversion + * * The unsigned integer version number of CMP SDK */ IABTCF_CmpSdkVersion?: number | null; /** + * Iabtcf Policyversion + * * The unsigned integer representing the version of the TCF that these consents adhere to. */ IABTCF_PolicyVersion?: number | null; /** + * Iabtcf Gdprapplies + * * 1: GDPR applies in current context, 0 - GDPR does not apply in current context, None=undetermined */ IABTCF_gdprApplies?: number | null; /** + * Iabtcf Publishercc + * * Two-letter ISO 3166-1 alpha-2 code */ IABTCF_PublisherCC?: string | null; /** + * Iabtcf Purposeonetreatment + * * Vendors can use this value to determine whether consent for purpose one is required. 0: no special treatment. 1: purpose one not disclosed */ IABTCF_PurposeOneTreatment?: number | null; /** + * Iabtcf Usenonstandardtexts + * * 1 - CMP uses customized stack descriptions and/or modified or supplemented standard illustrations.0 - CMP did not use a non-standard stack desc. and/or modified or supplemented Illustrations */ IABTCF_UseNonStandardTexts?: number | null; /** + * Iabtcf Tcstring + * * Fully encoded TC string */ IABTCF_TCString: string | null; /** + * Iabtcf Vendorconsents + * * Binary string: The '0' or '1' at position n – where n's indexing begins at 0 – indicates the consent status for Vendor ID n+1; false and true respectively. eg. '1' at index 0 is consent true for vendor ID 1 */ IABTCF_VendorConsents: string | null; /** + * Iabtcf Vendorlegitimateinterests + * * Binary String: The '0' or '1' at position n – where n's indexing begins at 0 – indicates the legitimate interest status for Vendor ID n+1; false and true respectively. eg. '1' at index 0 is legitimate interest established true for vendor ID 1 */ IABTCF_VendorLegitimateInterests?: string | null; /** + * Iabtcf Purposeconsents + * * Binary String: The '0' or '1' at position n – where n's indexing begins at 0 – indicates the consent status for purpose ID n+1; false and true respectively. eg. '1' at index 0 is consent true for purpose ID 1 */ IABTCF_PurposeConsents?: string | null; /** + * Iabtcf Purposelegitimateinterests + * * Binary String: The '0' or '1' at position n – where n's indexing begins at 0 – indicates the legitimate interest status for purpose ID n+1; false and true respectively. eg. '1' at index 0 is legitimate interest established true for purpose ID 1 */ IABTCF_PurposeLegitimateInterests?: string | null; /** + * Iabtcf Specialfeaturesoptins + * * Binary String: The '0' or '1' at position n – where n's indexing begins at 0 – indicates the opt-in status for special feature ID n+1; false and true respectively. eg. '1' at index 0 is opt-in true for special feature ID 1 */ IABTCF_SpecialFeaturesOptIns?: string | null; /** + * Iabtcf Disclosedvendors + * * Binary String: The '0' or '1' at position n – where n's indexing begins at 0 – indicates the status of disclosure in CMP for Vendor ID n+1; false and true respectively. eg. '1' at index 0 is vendor disclosed true for vendor ID 1 */ IABTCF_DisclosedVendors?: string | null; + /** + * Iabtcf Publisherconsent + */ IABTCF_PublisherConsent?: string | null; + /** + * Iabtcf Publisherlegitimateinterests + */ IABTCF_PublisherLegitimateInterests?: string | null; + /** + * Iabtcf Publishercustompurposesconsents + */ IABTCF_PublisherCustomPurposesConsents?: string | null; + /** + * Iabtcf Publishercustompurposeslegitimateinterests + */ IABTCF_PublisherCustomPurposesLegitimateInterests?: string | null; + /** + * Iabtcf Addtlconsent + */ IABTCF_AddtlConsent?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/Table.ts b/clients/admin-ui/src/types/api/models/Table.ts index a4fa628ad0b..7f61e91e6cf 100644 --- a/clients/admin-ui/src/types/api/models/Table.ts +++ b/clients/admin-ui/src/types/api/models/Table.ts @@ -1,25 +1,52 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ClassificationWithConfidence } from "./ClassificationWithConfidence"; import type { Constraint } from "./Constraint"; -import type { DiffStatus } from "./DiffStatus"; +import { DiffStatus } from "./DiffStatus"; import type { ResourceError } from "./ResourceError"; -import type { StagedResourceTypeValue } from "./StagedResourceTypeValue"; +import { StagedResourceTypeValue } from "./StagedResourceTypeValue"; +/** + * Table + */ export type Table = { + /** + * Urn + */ urn: string; + /** + * User Assigned Data Categories + */ user_assigned_data_categories?: Array | null; /** + * User Assigned Data Uses + * * User assigned data uses overriding auto assigned data uses */ user_assigned_data_uses?: Array | null; + /** + * User Assigned System Key + */ user_assigned_system_key?: string | null; + /** + * Name + */ name?: string | null; + /** + * System Key + */ system_key?: string | null; + /** + * Description + */ description?: string | null; + /** + * Monitor Config Id + */ monitor_config_id?: string | null; + /** + * Updated At + */ updated_at?: string | null; /** * The diff status of the staged resource @@ -27,19 +54,83 @@ export type Table = { diff_status?: DiffStatus | null; resource_type?: StagedResourceTypeValue | null; /** + * Data Uses + * * The data uses associated with the staged resource */ data_uses?: Array | null; /** + * Errors + * * List of errors encountered during processing */ errors?: Array; + /** + * Source Modified + */ source_modified?: string | null; + /** + * Classifications + */ classifications?: Array; + /** + * Database Name + */ database_name?: string | null; + /** + * Schema Name + */ schema_name: string; + /** + * Parent Schema + */ parent_schema: string; + /** + * Fields + */ fields?: Array; + /** + * Num Rows + */ num_rows?: number | null; + /** + * Constraints + */ constraints?: Array; + [key: string]: + | unknown + | string + | Array + | null + | Array + | null + | string + | null + | string + | null + | string + | null + | string + | null + | string + | null + | string + | null + | DiffStatus + | null + | StagedResourceTypeValue + | null + | Array + | null + | Array + | string + | null + | Array + | string + | null + | Array + | number + | null + | Array + | undefined; }; diff --git a/clients/admin-ui/src/types/api/models/TableContext.ts b/clients/admin-ui/src/types/api/models/TableContext.ts new file mode 100644 index 00000000000..3c48bc45467 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/TableContext.ts @@ -0,0 +1,23 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { ColumnInfo } from "./ColumnInfo"; + +/** + * TableContext + * + * Context information about a database table including its schema, name, and columns. + */ +export type TableContext = { + /** + * Schema Name + */ + schema_name: string; + /** + * Table Name + */ + table_name: string; + /** + * Columns + */ + columns?: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/TaskDetails.ts b/clients/admin-ui/src/types/api/models/TaskDetails.ts index 8c4e33d9063..644b837d3c1 100644 --- a/clients/admin-ui/src/types/api/models/TaskDetails.ts +++ b/clients/admin-ui/src/types/api/models/TaskDetails.ts @@ -1,11 +1,29 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * TaskDetails + */ export type TaskDetails = { + /** + * Task Id + */ task_id: string; + /** + * Task Name + */ task_name: string; - args: Array; - keyword_args?: null; + /** + * Args + */ + args: Array; + /** + * Keyword Args + */ + keyword_args?: { + [key: string]: unknown; + } | null; + /** + * Started At + */ started_at?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/TaskRunType.ts b/clients/admin-ui/src/types/api/models/TaskRunType.ts index acea0cea438..4d2eacebc80 100644 --- a/clients/admin-ui/src/types/api/models/TaskRunType.ts +++ b/clients/admin-ui/src/types/api/models/TaskRunType.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TaskRunType + * * Type of task run. */ export enum TaskRunType { diff --git a/clients/admin-ui/src/types/api/models/TaxonomyCreate.ts b/clients/admin-ui/src/types/api/models/TaxonomyCreate.ts index 7507d248ae9..73b0df911c8 100644 --- a/clients/admin-ui/src/types/api/models/TaxonomyCreate.ts +++ b/clients/admin-ui/src/types/api/models/TaxonomyCreate.ts @@ -1,16 +1,27 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TaxonomyCreate + * * Request schema for creating a taxonomy. */ export type TaxonomyCreate = { /** + * Taxonomy Type + * * Taxonomy type key to create */ taxonomy_type: string; + /** + * Name + */ name?: string | null; + /** + * Description + */ description?: string | null; + /** + * Applies To + */ applies_to?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/TaxonomyElement.ts b/clients/admin-ui/src/types/api/models/TaxonomyElement.ts index 027ec126fb3..232350ebe5b 100644 --- a/clients/admin-ui/src/types/api/models/TaxonomyElement.ts +++ b/clients/admin-ui/src/types/api/models/TaxonomyElement.ts @@ -1,28 +1,38 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TaxonomyElement + * * Response schema for generic taxonomy elements. */ export type TaxonomyElement = { /** + * Fides Key + * * A unique key used to identify this resource */ fides_key: string; /** + * Name + * * Human-readable name for this resource */ - name?: string; + name?: string | null; /** + * Description + * * A detailed description of what this resource is */ description?: string | null; /** + * Parent Key + * * The parent key for hierarchical relationships */ parent_key?: string | null; /** + * Active + * * Whether the resource is active */ active?: boolean; diff --git a/clients/admin-ui/src/types/api/models/TaxonomyElementCreate.ts b/clients/admin-ui/src/types/api/models/TaxonomyElementCreate.ts index 8ae92da04e5..650f4ccd02e 100644 --- a/clients/admin-ui/src/types/api/models/TaxonomyElementCreate.ts +++ b/clients/admin-ui/src/types/api/models/TaxonomyElementCreate.ts @@ -1,28 +1,38 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TaxonomyElementCreate + * * Schema for creating generic taxonomy elements. */ export type TaxonomyElementCreate = { /** + * Fides Key + * * A unique key used to identify this resource */ fides_key?: string | null; /** + * Name + * * Human-readable name for this resource */ name: string; /** + * Description + * * A detailed description of what this resource is */ description?: string | null; /** + * Parent Key + * * The parent key for hierarchical relationships */ parent_key?: string | null; /** + * Active + * * Whether the resource is active */ active?: boolean | null; diff --git a/clients/admin-ui/src/types/api/models/TaxonomyElementUpdate.ts b/clients/admin-ui/src/types/api/models/TaxonomyElementUpdate.ts index 36cd3508092..7bc9234da53 100644 --- a/clients/admin-ui/src/types/api/models/TaxonomyElementUpdate.ts +++ b/clients/admin-ui/src/types/api/models/TaxonomyElementUpdate.ts @@ -1,24 +1,32 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TaxonomyElementUpdate + * * Schema for updating generic taxonomy elements. */ export type TaxonomyElementUpdate = { /** + * Name + * * Human-readable name for this resource */ name?: string | null; /** + * Description + * * A detailed description of what this resource is */ description?: string | null; /** + * Parent Key + * * The parent key for hierarchical relationships */ parent_key?: string | null; /** + * Active + * * Whether the resource is active */ active?: boolean | null; diff --git a/clients/admin-ui/src/types/api/models/TaxonomyResponse.ts b/clients/admin-ui/src/types/api/models/TaxonomyResponse.ts index 7faa224a56c..71de6d12e9d 100644 --- a/clients/admin-ui/src/types/api/models/TaxonomyResponse.ts +++ b/clients/admin-ui/src/types/api/models/TaxonomyResponse.ts @@ -1,24 +1,32 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TaxonomyResponse + * * Response schema for taxonomy resources. */ export type TaxonomyResponse = { /** + * Fides Key + * * Taxonomy type key */ fides_key: string; /** + * Name + * * Display name for the taxonomy */ name?: string | null; /** + * Description + * * Taxonomy description */ description?: string | null; /** + * Applies To + * * List of resource types this taxonomy can be applied to */ applies_to?: Array; diff --git a/clients/admin-ui/src/types/api/models/TaxonomyUpdate.ts b/clients/admin-ui/src/types/api/models/TaxonomyUpdate.ts index 5715cc6782f..1f833a18e5b 100644 --- a/clients/admin-ui/src/types/api/models/TaxonomyUpdate.ts +++ b/clients/admin-ui/src/types/api/models/TaxonomyUpdate.ts @@ -1,12 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TaxonomyUpdate + * * Request schema for updating a taxonomy. */ export type TaxonomyUpdate = { + /** + * Name + */ name?: string | null; + /** + * Description + */ description?: string | null; + /** + * Applies To + */ applies_to?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/TemplateResponse.ts b/clients/admin-ui/src/types/api/models/TemplateResponse.ts index 65aaf0c063e..0a5b04360da 100644 --- a/clients/admin-ui/src/types/api/models/TemplateResponse.ts +++ b/clients/admin-ui/src/types/api/models/TemplateResponse.ts @@ -1,19 +1,49 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TemplateResponse + * * Response schema for assessment templates. */ export type TemplateResponse = { + /** + * Id + */ id: string; + /** + * Key + */ key: string; + /** + * Version + */ version: string; + /** + * Name + */ name: string; + /** + * Assessment Type + */ assessment_type?: string | null; + /** + * Region + */ region?: string | null; + /** + * Authority + */ authority?: string | null; + /** + * Legal Reference + */ legal_reference?: string | null; + /** + * Description + */ description?: string | null; + /** + * Is Active + */ is_active?: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/TemplateVariable.ts b/clients/admin-ui/src/types/api/models/TemplateVariable.ts new file mode 100644 index 00000000000..17f5ce56721 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/TemplateVariable.ts @@ -0,0 +1,30 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * TemplateVariable + * + * Describes an available template variable for the UI template editor. + * + * Returned by :meth:`JiraTemplateService.get_template_variables` so + * the frontend can present a list of insertable variables. + */ +export type TemplateVariable = { + /** + * Name + * + * Variable name as used in templates (e.g., 'request_id') + */ + name: string; + /** + * Description + * + * Human-readable description of the variable + */ + description: string; + /** + * Example Value + * + * Example value for preview rendering + */ + example_value?: string | null; +}; diff --git a/clients/admin-ui/src/types/api/models/TestMessagingStatusMessage.ts b/clients/admin-ui/src/types/api/models/TestMessagingStatusMessage.ts index 85b91a835fc..f217bb174df 100644 --- a/clients/admin-ui/src/types/api/models/TestMessagingStatusMessage.ts +++ b/clients/admin-ui/src/types/api/models/TestMessagingStatusMessage.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { MessagingConnectionTestStatus } from "./MessagingConnectionTestStatus"; +import { MessagingConnectionTestStatus } from "./MessagingConnectionTestStatus"; /** + * TestMessagingStatusMessage + * * A schema for testing functionality of a messaging config. */ export type TestMessagingStatusMessage = { + /** + * Msg + */ msg: string; test_status?: MessagingConnectionTestStatus | null; + /** + * Failure Reason + */ failure_reason?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/TestMonitorParams.ts b/clients/admin-ui/src/types/api/models/TestMonitorParams.ts index 3a68bfdb91d..4cb060cbbf8 100644 --- a/clients/admin-ui/src/types/api/models/TestMonitorParams.ts +++ b/clients/admin-ui/src/types/api/models/TestMonitorParams.ts @@ -1,45 +1,75 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TestMonitorParams + * * Configuration parameters for the test monitor */ export type TestMonitorParams = { /** + * Sharded Table Pattern + * * Regex pattern to identify sharded tables */ sharded_table_pattern?: string | null; /** + * Num Databases + * * Number of databases to generate */ num_databases?: number; /** + * Num Schemas Per Db + * * Number of schemas to generate per database */ num_schemas_per_db?: number; /** + * Num Tables Per Schema + * * Number of tables to generate per schema */ num_tables_per_schema?: number; /** + * Num Fields Per Table + * * Number of fields to generate per table */ num_fields_per_table?: number; /** + * Field Sample Data + * * Sample data to return for field sampling */ field_sample_data?: Array; /** + * Max Nesting Level + * * Maximum depth of nested fields */ max_nesting_level?: number; /** + * Nested Field Percentage + * * Percentage of fields that should be nested (0.0 to 1.0) */ nested_field_percentage?: number; /** + * Num Fields Per Nested + * * Number of fields to generate for each nested field */ num_fields_per_nested?: number; + /** + * Simulate Classification + * + * Whether to simulate classification when calling the /classify endpoint + */ + simulate_classification?: boolean; + /** + * Classification Sleep Seconds + * + * Number of seconds to sleep during classification to simulate processing time + */ + classification_sleep_seconds?: number; }; diff --git a/clients/admin-ui/src/types/api/models/TestPrivacyRequest.ts b/clients/admin-ui/src/types/api/models/TestPrivacyRequest.ts index 93af45ca8d0..beb0a5036aa 100644 --- a/clients/admin-ui/src/types/api/models/TestPrivacyRequest.ts +++ b/clients/admin-ui/src/types/api/models/TestPrivacyRequest.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TestPrivacyRequest + * * Schema containing the data for a test privacy request */ export type TestPrivacyRequest = { + /** + * Privacy Request Id + */ privacy_request_id: string; }; diff --git a/clients/admin-ui/src/types/api/models/TestStatus.ts b/clients/admin-ui/src/types/api/models/TestStatus.ts index 30a7691c32c..551e7f3798c 100644 --- a/clients/admin-ui/src/types/api/models/TestStatus.ts +++ b/clients/admin-ui/src/types/api/models/TestStatus.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * TestStatus + */ export enum TestStatus { PASSED = "passed", FAILED = "failed", diff --git a/clients/admin-ui/src/types/api/models/TestStatusMessage.ts b/clients/admin-ui/src/types/api/models/TestStatusMessage.ts index 1dcf244493e..38da39b697e 100644 --- a/clients/admin-ui/src/types/api/models/TestStatusMessage.ts +++ b/clients/admin-ui/src/types/api/models/TestStatusMessage.ts @@ -1,14 +1,20 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConnectionTestStatus } from "./ConnectionTestStatus"; +import { ConnectionTestStatus } from "./ConnectionTestStatus"; /** + * TestStatusMessage + * * A schema for checking status. */ export type TestStatusMessage = { + /** + * Msg + */ msg: string; test_status?: ConnectionTestStatus | null; + /** + * Failure Reason + */ failure_reason?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/TestWebsiteMonitorParams.ts b/clients/admin-ui/src/types/api/models/TestWebsiteMonitorParams.ts index 4572bad0f0d..1b2193349d5 100644 --- a/clients/admin-ui/src/types/api/models/TestWebsiteMonitorParams.ts +++ b/clients/admin-ui/src/types/api/models/TestWebsiteMonitorParams.ts @@ -1,85 +1,127 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TestWebsiteMonitorParams + * * Configuration parameters for the test website monitor */ export type TestWebsiteMonitorParams = { /** + * Locations + * * The locations from which the website should be monitored */ locations?: Array | null; /** + * Exclude Domains + * * List of domains to exclude from monitoring */ exclude_domains?: Array | null; /** + * Sitemap Url + * * URL to a sitemap.xml file that will be used to discover pages to monitor */ sitemap_url?: string | null; /** + * Num Cookies + * * Number of test cookies to generate */ num_cookies?: number; /** + * Num Javascript Requests + * * Number of test JavaScript requests to generate */ num_javascript_requests?: number; /** + * Num Image Requests + * * Number of test image requests to generate */ num_image_requests?: number; /** + * Num Iframe Requests + * * Number of test iframe requests to generate */ num_iframe_requests?: number; /** + * Num Browser Requests + * * Number of general browser requests to generate */ num_browser_requests?: number; /** + * Test Domains + * * List of test domains to use in generated assets */ test_domains?: Array; /** + * Test Pages + * * List of test pages where assets are discovered */ test_pages?: Array; /** + * Test Locations + * * List of test locations for asset discovery */ test_locations?: Array; /** + * Consent Granted Percentage + * * Percentage of assets that should be generated with granted consent (0.0 to 1.0) */ consent_granted_percentage?: number; /** + * Consent Denied Percentage + * * Percentage of assets that should be generated with denied consent (0.0 to 1.0) */ consent_denied_percentage?: number; /** + * Consent Cmp Error Percentage + * * Percentage of assets that should be generated with cmp_error consent (0.0 to 1.0) */ consent_cmp_error_percentage?: number; /** + * Cookie Names + * * Sample cookie names to use */ cookie_names?: Array; /** + * Cookie Values + * * Sample cookie values to use */ cookie_values?: Array; /** + * Vendor Match Percentage + * * Percentage of assets that should be matched to vendors (0.0 to 1.0) */ vendor_match_percentage?: number; /** + * Test Vendor Ids + * * List of test vendor IDs to assign to matched assets */ test_vendor_ids?: Array; /** + * Experiences Data + * * Experiences data for consent notice mapping. Uses default experiences data if not provided. */ - experiences_data?: Record; + experiences_data?: { + [key: string]: { + [key: string]: unknown; + }; + }; }; diff --git a/clients/admin-ui/src/types/api/models/TimeBasedPartitioning.ts b/clients/admin-ui/src/types/api/models/TimeBasedPartitioning.ts index 012fbca1828..fa756949757 100644 --- a/clients/admin-ui/src/types/api/models/TimeBasedPartitioning.ts +++ b/clients/admin-ui/src/types/api/models/TimeBasedPartitioning.ts @@ -1,25 +1,33 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TimeBasedPartitioning + * * Allows you to partition data based on time ranges using various * time expressions and intervals. */ export type TimeBasedPartitioning = { /** + * Field + * * Column name to partition on (e.g., `created_at`, `updated_at`) */ field: string; /** + * Start + * * Start time expression. Supported formats: `NOW()`, `TODAY()`, `TIMESTAMP(TODAY())`, `YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS`, or arithmetic expressions like `NOW() - 30 DAYS`, `TIMESTAMP(TODAY() - 30 DAYS)`. */ start?: string | null; /** + * End + * * End time expression. Same formats as start field. */ end?: string | null; /** + * Interval + * * Interval expression defining the size of each partition in `DAY(S)`, `WEEK(S)`, `MONTH(S)`, or `YEAR(S)`. */ interval?: string | null; diff --git a/clients/admin-ui/src/types/api/models/TimeInclusivity.ts b/clients/admin-ui/src/types/api/models/TimeInclusivity.ts new file mode 100644 index 00000000000..7c1b2904720 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/TimeInclusivity.ts @@ -0,0 +1,11 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * TimeInclusivity + */ +export enum TimeInclusivity { + START = "start", + END = "end", + BOTH = "both", + NEITHER = "neither", +} diff --git a/clients/admin-ui/src/types/api/models/TimescaleDocsSchema.ts b/clients/admin-ui/src/types/api/models/TimescaleDocsSchema.ts index 19f69cbf29e..ab508dd31da 100644 --- a/clients/admin-ui/src/types/api/models/TimescaleDocsSchema.ts +++ b/clients/admin-ui/src/types/api/models/TimescaleDocsSchema.ts @@ -1,38 +1,55 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TimescaleDocsSchema + * * TimescaleDB Secrets Schema for API Docs */ export type TimescaleDocsSchema = { /** + * Host + * * The hostname or IP address of the server where the database is running. */ host: string; /** + * Port + * * The network port number on which the server is listening for incoming connections (default: 5432). */ port?: number; /** + * Username + * * The user account used to authenticate and access the database. */ username?: string | null; /** + * Password + * * The password used to authenticate and access the database. */ password?: string | null; /** + * SSH required + * * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. */ ssh_required?: boolean; /** + * Database + * * The name of the specific database within the database server that you want to connect to. */ dbname?: string | null; /** + * Schema + * * The default schema to be used for the database connection (defaults to public). */ db_schema?: string | null; + /** + * SSL Mode + */ ssl_mode?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/ToneResponse.ts b/clients/admin-ui/src/types/api/models/ToneResponse.ts new file mode 100644 index 00000000000..6adfdc3246a --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ToneResponse.ts @@ -0,0 +1,13 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * ToneResponse + * + * Response schema returning the active (resolved) tone prompt. + */ +export type ToneResponse = { + /** + * Questionnaire Tone Prompt + */ + questionnaire_tone_prompt: string; +}; diff --git a/clients/admin-ui/src/types/api/models/ToneUpdate.ts b/clients/admin-ui/src/types/api/models/ToneUpdate.ts new file mode 100644 index 00000000000..1936fc67c4a --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ToneUpdate.ts @@ -0,0 +1,13 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * ToneUpdate + * + * Request schema for updating the questionnaire tone prompt. + */ +export type ToneUpdate = { + /** + * Questionnaire Tone Prompt + */ + questionnaire_tone_prompt: string; +}; diff --git a/clients/admin-ui/src/types/api/models/TreeResourceChangeIndicator.ts b/clients/admin-ui/src/types/api/models/TreeResourceChangeIndicator.ts deleted file mode 100644 index a646ff40338..00000000000 --- a/clients/admin-ui/src/types/api/models/TreeResourceChangeIndicator.ts +++ /dev/null @@ -1,9 +0,0 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ - -export enum TreeResourceChangeIndicator { - ADDITION = "addition", - REMOVAL = "removal", - CHANGE = "change", -} diff --git a/clients/admin-ui/src/types/api/models/UnlabeledIdentities.ts b/clients/admin-ui/src/types/api/models/UnlabeledIdentities.ts index 124c3a81a4d..10f0208d5eb 100644 --- a/clients/admin-ui/src/types/api/models/UnlabeledIdentities.ts +++ b/clients/admin-ui/src/types/api/models/UnlabeledIdentities.ts @@ -1,11 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * UnlabeledIdentities + * * A model for validating identity dictionaries where standard fields use Identity's validation * but custom fields just need to be valued. */ export type UnlabeledIdentities = { - data: any; + /** + * Data + */ + data: { + [key: string]: unknown; + }; }; diff --git a/clients/admin-ui/src/types/api/models/UnverifiedIdentity.ts b/clients/admin-ui/src/types/api/models/UnverifiedIdentity.ts index 1c5e7875889..0f8474b44d8 100644 --- a/clients/admin-ui/src/types/api/models/UnverifiedIdentity.ts +++ b/clients/admin-ui/src/types/api/models/UnverifiedIdentity.ts @@ -1,13 +1,36 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * UnverifiedIdentity + * * Exclude email and phone number from the identity */ export type UnverifiedIdentity = { + /** + * GA client ID + */ ga_client_id?: string | null; + /** + * LJT reader ID + */ ljt_readerID?: string | null; + /** + * Fides user device ID + */ fides_user_device_id?: string | null; + /** + * External ID + */ external_id?: string | null; + [key: string]: + | unknown + | string + | null + | string + | null + | string + | null + | string + | null + | undefined; }; diff --git a/clients/admin-ui/src/types/api/models/UnverifiedPrivacyPreferencesRequest.ts b/clients/admin-ui/src/types/api/models/UnverifiedPrivacyPreferencesRequest.ts index e7eb25f91c0..75f1054e75f 100644 --- a/clients/admin-ui/src/types/api/models/UnverifiedPrivacyPreferencesRequest.ts +++ b/clients/admin-ui/src/types/api/models/UnverifiedPrivacyPreferencesRequest.ts @@ -1,10 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConsentMethod } from "./ConsentMethod"; +import { ConsentMethod } from "./ConsentMethod"; import type { ConsentOptionCreate } from "./ConsentOptionCreate"; -import type { PrivacyRequestSource } from "./PrivacyRequestSource"; +import { PrivacyRequestSource } from "./PrivacyRequestSource"; import type { TCFFeatureSave } from "./TCFFeatureSave"; import type { TCFPurposeSave } from "./TCFPurposeSave"; import type { TCFSpecialFeatureSave } from "./TCFSpecialFeatureSave"; @@ -13,6 +11,8 @@ import type { TCFVendorSave } from "./TCFVendorSave"; import type { UnverifiedIdentity } from "./UnverifiedIdentity"; /** + * UnverifiedPrivacyPreferencesRequest + * * Request body for saving PrivacyPreferences using an unverified identities endpoint. * * "preferences" key reserved for saving preferences against a privacy notice. @@ -20,28 +20,81 @@ import type { UnverifiedIdentity } from "./UnverifiedIdentity"; * New *_preferences fields are used for saving preferences against various tcf components. */ export type UnverifiedPrivacyPreferencesRequest = { + /** + * Purpose Consent Preferences + */ purpose_consent_preferences?: Array; + /** + * Purpose Legitimate Interests Preferences + */ purpose_legitimate_interests_preferences?: Array; + /** + * Vendor Consent Preferences + */ vendor_consent_preferences?: Array; + /** + * Vendor Legitimate Interests Preferences + */ vendor_legitimate_interests_preferences?: Array; + /** + * Special Feature Preferences + */ special_feature_preferences?: Array; + /** + * Special Purpose Preferences + */ special_purpose_preferences?: Array; + /** + * Feature Preferences + */ feature_preferences?: Array; + /** + * System Consent Preferences + */ system_consent_preferences?: Array; + /** + * System Legitimate Interests Preferences + */ system_legitimate_interests_preferences?: Array; + /** + * Preferences + */ preferences?: Array; /** + * Fides String + * * If supplied, TC strings and AC strings are decoded and preferences saved for purpose_consent, purpose_legitimate_interests, vendor_consent, vendor_legitimate_interests, and special_features */ fides_string?: string | null; + /** + * Policy Key + */ policy_key?: string | null; + /** + * Privacy Experience Id + */ privacy_experience_id?: string | null; + /** + * Privacy Experience Config History Id + */ privacy_experience_config_history_id?: string | null; + /** + * User Geography + */ user_geography?: string | null; method?: ConsentMethod | null; + /** + * Served Notice History Id + */ served_notice_history_id?: string | null; + /** + * Property Id + */ property_id?: string | null; source?: PrivacyRequestSource | null; browser_identity: UnverifiedIdentity; + /** + * Code + */ code?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/UpdateAnswerRequest.ts b/clients/admin-ui/src/types/api/models/UpdateAnswerRequest.ts index aca0123fb8c..b83fa8c412e 100644 --- a/clients/admin-ui/src/types/api/models/UpdateAnswerRequest.ts +++ b/clients/admin-ui/src/types/api/models/UpdateAnswerRequest.ts @@ -1,12 +1,14 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * UpdateAnswerRequest + * * Request to update an answer. */ export type UpdateAnswerRequest = { /** + * Answer Text + * * The new answer text */ answer_text: string; diff --git a/clients/admin-ui/src/types/api/models/UpdateMonitorStewardsRequest.ts b/clients/admin-ui/src/types/api/models/UpdateMonitorStewardsRequest.ts index 1383e5b822c..c0a70a0255a 100644 --- a/clients/admin-ui/src/types/api/models/UpdateMonitorStewardsRequest.ts +++ b/clients/admin-ui/src/types/api/models/UpdateMonitorStewardsRequest.ts @@ -1,12 +1,14 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * UpdateMonitorStewardsRequest + * * Request schema for updating the stewards on a specific monitor. */ export type UpdateMonitorStewardsRequest = { /** + * User Ids + * * List of user IDs to set as stewards for this monitor */ user_ids: Array; diff --git a/clients/admin-ui/src/types/api/models/UserConsentPreference.ts b/clients/admin-ui/src/types/api/models/UserConsentPreference.ts index 28ce17a716a..9bf7cb4bbf0 100644 --- a/clients/admin-ui/src/types/api/models/UserConsentPreference.ts +++ b/clients/admin-ui/src/types/api/models/UserConsentPreference.ts @@ -1,7 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * UserConsentPreference + */ export enum UserConsentPreference { OPT_IN = "opt_in", OPT_OUT = "opt_out", diff --git a/clients/admin-ui/src/types/api/models/UserCreateExtended.ts b/clients/admin-ui/src/types/api/models/UserCreateExtended.ts index 4deedd91384..794273dae0d 100644 --- a/clients/admin-ui/src/types/api/models/UserCreateExtended.ts +++ b/clients/admin-ui/src/types/api/models/UserCreateExtended.ts @@ -1,18 +1,38 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * UserCreateExtended + * * Extended UserCreate schema to allow specifying if password login is enabled. */ export type UserCreateExtended = { + /** + * Username + */ username: string; + /** + * Password + */ password?: string | null; + /** + * Email Address + */ email_address: string; + /** + * First Name + */ first_name?: string | null; + /** + * Last Name + */ last_name?: string | null; + /** + * Disabled + */ disabled?: boolean; /** + * Password Login Enabled + * * Whether password login is enabled for the user. */ password_login_enabled?: boolean | null; diff --git a/clients/admin-ui/src/types/api/models/UserCreateResponse.ts b/clients/admin-ui/src/types/api/models/UserCreateResponse.ts index 6c2b8dbaebe..9c776026168 100644 --- a/clients/admin-ui/src/types/api/models/UserCreateResponse.ts +++ b/clients/admin-ui/src/types/api/models/UserCreateResponse.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * UserCreateResponse + * * Response after creating a FidesUser */ export type UserCreateResponse = { + /** + * Id + */ id: string; }; diff --git a/clients/admin-ui/src/types/api/models/UserEmailInviteStatus.ts b/clients/admin-ui/src/types/api/models/UserEmailInviteStatus.ts index aa02d8f16d6..938a714da48 100644 --- a/clients/admin-ui/src/types/api/models/UserEmailInviteStatus.ts +++ b/clients/admin-ui/src/types/api/models/UserEmailInviteStatus.ts @@ -1,7 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * UserEmailInviteStatus + */ export type UserEmailInviteStatus = { + /** + * Enabled + */ enabled: boolean; }; diff --git a/clients/admin-ui/src/types/api/models/UserForcePasswordReset.ts b/clients/admin-ui/src/types/api/models/UserForcePasswordReset.ts index cd8130a8f87..d6cbfbca80b 100644 --- a/clients/admin-ui/src/types/api/models/UserForcePasswordReset.ts +++ b/clients/admin-ui/src/types/api/models/UserForcePasswordReset.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * UserForcePasswordReset + * * Only a new password, for the case where the user does not remember their password */ export type UserForcePasswordReset = { + /** + * New Password + */ new_password: string; }; diff --git a/clients/admin-ui/src/types/api/models/UserLogin.ts b/clients/admin-ui/src/types/api/models/UserLogin.ts index 58ad40ff34f..d045a6ff7d1 100644 --- a/clients/admin-ui/src/types/api/models/UserLogin.ts +++ b/clients/admin-ui/src/types/api/models/UserLogin.ts @@ -1,12 +1,18 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * UserLogin + * * Similar to UserCreate except we do not need the extra validation on * username and password. */ export type UserLogin = { + /** + * Username + */ username: string; + /** + * Password + */ password: string; }; diff --git a/clients/admin-ui/src/types/api/models/UserLoginResponse.ts b/clients/admin-ui/src/types/api/models/UserLoginResponse.ts index 25e7a0a7740..929ef80904f 100644 --- a/clients/admin-ui/src/types/api/models/UserLoginResponse.ts +++ b/clients/admin-ui/src/types/api/models/UserLoginResponse.ts @@ -1,11 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { AccessToken } from "./AccessToken"; import type { UserResponse } from "./UserResponse"; /** + * UserLoginResponse + * * Similar to UserResponse except with an access token */ export type UserLoginResponse = { diff --git a/clients/admin-ui/src/types/api/models/UserPasswordReset.ts b/clients/admin-ui/src/types/api/models/UserPasswordReset.ts index 696a93f5b78..1bde9988cb6 100644 --- a/clients/admin-ui/src/types/api/models/UserPasswordReset.ts +++ b/clients/admin-ui/src/types/api/models/UserPasswordReset.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * UserPasswordReset + * * Contains both old and new passwords when resetting a password */ export type UserPasswordReset = { + /** + * Old Password + */ old_password: string; + /** + * New Password + */ new_password: string; }; diff --git a/clients/admin-ui/src/types/api/models/UserPermissionsCreate.ts b/clients/admin-ui/src/types/api/models/UserPermissionsCreate.ts index 3a57f47f4ac..b84664d8e74 100644 --- a/clients/admin-ui/src/types/api/models/UserPermissionsCreate.ts +++ b/clients/admin-ui/src/types/api/models/UserPermissionsCreate.ts @@ -1,15 +1,18 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { RoleRegistryEnum } from "./RoleRegistryEnum"; +import { RoleRegistryEnum } from "./RoleRegistryEnum"; /** + * UserPermissionsCreate + * * Data required to create a FidesUserPermissions record * * Users will be assigned role(s) directly which are associated with a list of scopes. Scopes * cannot be assigned directly to users. */ export type UserPermissionsCreate = { + /** + * Roles + */ roles: Array; }; diff --git a/clients/admin-ui/src/types/api/models/UserPermissionsEdit.ts b/clients/admin-ui/src/types/api/models/UserPermissionsEdit.ts index 0d75ae3c983..e31db22d879 100644 --- a/clients/admin-ui/src/types/api/models/UserPermissionsEdit.ts +++ b/clients/admin-ui/src/types/api/models/UserPermissionsEdit.ts @@ -1,13 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { RoleRegistryEnum } from "./RoleRegistryEnum"; +import { RoleRegistryEnum } from "./RoleRegistryEnum"; /** + * UserPermissionsEdit + * * Data required to edit a FidesUserPermissions record. */ export type UserPermissionsEdit = { + /** + * Roles + */ roles: Array; + /** + * Id + */ id?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/UserPermissionsPlusResponse.ts b/clients/admin-ui/src/types/api/models/UserPermissionsPlusResponse.ts index 416ee672300..4d5bd4a718b 100644 --- a/clients/admin-ui/src/types/api/models/UserPermissionsPlusResponse.ts +++ b/clients/admin-ui/src/types/api/models/UserPermissionsPlusResponse.ts @@ -1,18 +1,30 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { RoleRegistryEnum } from "./RoleRegistryEnum"; -import type { ScopeRegistryEnum } from "./ScopeRegistryEnum"; +import { RoleRegistryEnum } from "./RoleRegistryEnum"; +import { ScopeRegistryEnum } from "./ScopeRegistryEnum"; /** + * UserPermissionsPlusResponse + * * Response after creating, editing, or retrieving a FidesUserPermissions record. * * Overrides in Plus to use the Plus ScopeRegistryEnum so Plus scopes are returned. */ export type UserPermissionsPlusResponse = { + /** + * Roles + */ roles: Array; + /** + * Id + */ id: string; + /** + * User Id + */ user_id: string; + /** + * Total Scopes + */ total_scopes: Array; }; diff --git a/clients/admin-ui/src/types/api/models/UserResponse.ts b/clients/admin-ui/src/types/api/models/UserResponse.ts index d4694acc886..308096a7110 100644 --- a/clients/admin-ui/src/types/api/models/UserResponse.ts +++ b/clients/admin-ui/src/types/api/models/UserResponse.ts @@ -1,17 +1,41 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * UserResponse + * * Response after requesting a User */ export type UserResponse = { + /** + * Id + */ id: string; + /** + * Username + */ username: string; + /** + * Created At + */ created_at: string; + /** + * Email Address + */ email_address: string | null; + /** + * First Name + */ first_name?: string | null; + /** + * Last Name + */ last_name?: string | null; + /** + * Disabled + */ disabled?: boolean | null; + /** + * Disabled Reason + */ disabled_reason?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/UserResponseExtended.ts b/clients/admin-ui/src/types/api/models/UserResponseExtended.ts index 75f23053bc1..06c6db426f4 100644 --- a/clients/admin-ui/src/types/api/models/UserResponseExtended.ts +++ b/clients/admin-ui/src/types/api/models/UserResponseExtended.ts @@ -1,20 +1,46 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * UserResponseExtended + * * Extended UserResponse schema to allow specifying if password login is enabled. */ export type UserResponseExtended = { + /** + * Id + */ id: string; + /** + * Username + */ username: string; + /** + * Created At + */ created_at: string; + /** + * Email Address + */ email_address: string | null; + /** + * First Name + */ first_name?: string | null; + /** + * Last Name + */ last_name?: string | null; + /** + * Disabled + */ disabled?: boolean | null; + /** + * Disabled Reason + */ disabled_reason?: string | null; /** + * Password Login Enabled + * * Whether password login is enabled for the user. */ password_login_enabled?: boolean | null; diff --git a/clients/admin-ui/src/types/api/models/UserUpdate.ts b/clients/admin-ui/src/types/api/models/UserUpdate.ts index 509ff5b423d..199e490ffce 100644 --- a/clients/admin-ui/src/types/api/models/UserUpdate.ts +++ b/clients/admin-ui/src/types/api/models/UserUpdate.ts @@ -1,12 +1,21 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * UserUpdate + * * Data required to update a FidesUser */ export type UserUpdate = { + /** + * Email Address + */ email_address?: string | null; + /** + * First Name + */ first_name?: string | null; + /** + * Last Name + */ last_name?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/ValidTargets.ts b/clients/admin-ui/src/types/api/models/ValidTargets.ts index 7d5a04f8a3d..3db885baeab 100644 --- a/clients/admin-ui/src/types/api/models/ValidTargets.ts +++ b/clients/admin-ui/src/types/api/models/ValidTargets.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ValidTargets + * * Validation of targets attempted to generate resources from */ export enum ValidTargets { diff --git a/clients/admin-ui/src/types/api/models/ValidateDatasetResponse.ts b/clients/admin-ui/src/types/api/models/ValidateDatasetResponse.ts index 02a7f9f46c0..4b93cfe441b 100644 --- a/clients/admin-ui/src/types/api/models/ValidateDatasetResponse.ts +++ b/clients/admin-ui/src/types/api/models/ValidateDatasetResponse.ts @@ -1,11 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { Dataset } from "./Dataset"; import type { DatasetTraversalDetails } from "./DatasetTraversalDetails"; /** + * ValidateDatasetResponse + * * Response model for validating a dataset, which includes both the dataset * itself (if valid) plus a details object describing if the dataset is * traversable or not. diff --git a/clients/admin-ui/src/types/api/models/ValidateRequest.ts b/clients/admin-ui/src/types/api/models/ValidateRequest.ts index d2192f0e337..65536daf750 100644 --- a/clients/admin-ui/src/types/api/models/ValidateRequest.ts +++ b/clients/admin-ui/src/types/api/models/ValidateRequest.ts @@ -1,16 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { AWSConfig } from "./AWSConfig"; import type { BigQueryConfig } from "./BigQueryConfig"; import type { OktaConfig } from "./OktaConfig"; -import type { ValidationTarget } from "./ValidationTarget"; +import { ValidationTarget } from "./ValidationTarget"; /** + * ValidateRequest + * * Validate endpoint request object */ export type ValidateRequest = { + /** + * Config + */ config: AWSConfig | BigQueryConfig | OktaConfig; target: ValidationTarget; }; diff --git a/clients/admin-ui/src/types/api/models/ValidateResponse.ts b/clients/admin-ui/src/types/api/models/ValidateResponse.ts index 73a41f5a34e..df0936a6e2b 100644 --- a/clients/admin-ui/src/types/api/models/ValidateResponse.ts +++ b/clients/admin-ui/src/types/api/models/ValidateResponse.ts @@ -1,13 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ValidationStatus } from "./ValidationStatus"; +import { ValidationStatus } from "./ValidationStatus"; /** + * ValidateResponse + * * Validate endpoint response object */ export type ValidateResponse = { status: ValidationStatus; + /** + * Message + */ message: string; }; diff --git a/clients/admin-ui/src/types/api/models/ValidateSaaSConfigResponse.ts b/clients/admin-ui/src/types/api/models/ValidateSaaSConfigResponse.ts index aaf4320b37d..1a75b2a3198 100644 --- a/clients/admin-ui/src/types/api/models/ValidateSaaSConfigResponse.ts +++ b/clients/admin-ui/src/types/api/models/ValidateSaaSConfigResponse.ts @@ -1,11 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { SaaSConfig } from "./SaaSConfig"; import type { SaaSConfigValidationDetails } from "./SaaSConfigValidationDetails"; /** + * ValidateSaaSConfigResponse + * * Response model for validating a SaaS config, which includes both the SaaS config * itself (if valid) plus a details object describing any validation errors. */ diff --git a/clients/admin-ui/src/types/api/models/ValidationError.ts b/clients/admin-ui/src/types/api/models/ValidationError.ts index b50d0aa4148..f531b66e30f 100644 --- a/clients/admin-ui/src/types/api/models/ValidationError.ts +++ b/clients/admin-ui/src/types/api/models/ValidationError.ts @@ -1,9 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ValidationError + */ export type ValidationError = { + /** + * Location + */ loc: Array; + /** + * Message + */ msg: string; + /** + * Error Type + */ type: string; }; diff --git a/clients/admin-ui/src/types/api/models/ValidationErrorResponse.ts b/clients/admin-ui/src/types/api/models/ValidationErrorResponse.ts new file mode 100644 index 00000000000..3873dc3aecf --- /dev/null +++ b/clients/admin-ui/src/types/api/models/ValidationErrorResponse.ts @@ -0,0 +1,15 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * ValidationErrorResponse + * + * Schema for validation error responses. + */ +export type ValidationErrorResponse = { + /** + * Detail + * + * Detailed error message describing the validation failure + */ + detail: string; +}; diff --git a/clients/admin-ui/src/types/api/models/ValidationStatus.ts b/clients/admin-ui/src/types/api/models/ValidationStatus.ts index 8eb0ec3553d..631287ef4ef 100644 --- a/clients/admin-ui/src/types/api/models/ValidationStatus.ts +++ b/clients/admin-ui/src/types/api/models/ValidationStatus.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ValidationStatus + * * Validate endpoint response status */ export enum ValidationStatus { diff --git a/clients/admin-ui/src/types/api/models/ValidationTarget.ts b/clients/admin-ui/src/types/api/models/ValidationTarget.ts index 41e8230ffa2..6dca75d068f 100644 --- a/clients/admin-ui/src/types/api/models/ValidationTarget.ts +++ b/clients/admin-ui/src/types/api/models/ValidationTarget.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ValidationTarget + * * Allowed targets for the validate endpoint */ export enum ValidationTarget { diff --git a/clients/admin-ui/src/types/api/models/ValuesList.ts b/clients/admin-ui/src/types/api/models/ValuesList.ts index dcc3196375b..3b75a345e63 100644 --- a/clients/admin-ui/src/types/api/models/ValuesList.ts +++ b/clients/admin-ui/src/types/api/models/ValuesList.ts @@ -1,7 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ValuesList + */ export type ValuesList = { + /** + * Values + */ values: Array; }; diff --git a/clients/admin-ui/src/types/api/models/VendorIds.ts b/clients/admin-ui/src/types/api/models/VendorIds.ts index 932b5e05446..4e19a51d3e2 100644 --- a/clients/admin-ui/src/types/api/models/VendorIds.ts +++ b/clients/admin-ui/src/types/api/models/VendorIds.ts @@ -1,7 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * VendorIds + */ export type VendorIds = { + /** + * Vendor Ids + */ vendor_ids: Array; }; diff --git a/clients/admin-ui/src/types/api/models/VendorMatchConfidence.ts b/clients/admin-ui/src/types/api/models/VendorMatchConfidence.ts index 7faf6b8dc31..90476f38e53 100644 --- a/clients/admin-ui/src/types/api/models/VendorMatchConfidence.ts +++ b/clients/admin-ui/src/types/api/models/VendorMatchConfidence.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * VendorMatchConfidence + * * Confidence level for vendor matching from Compass service. */ export enum VendorMatchConfidence { diff --git a/clients/admin-ui/src/types/api/models/VendorMatchStats.ts b/clients/admin-ui/src/types/api/models/VendorMatchStats.ts new file mode 100644 index 00000000000..a28cbdd5b07 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/VendorMatchStats.ts @@ -0,0 +1,39 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * VendorMatchStats + * + * Statistics about vendor matching to Compass. + */ +export type VendorMatchStats = { + /** + * Total With Vendor Name + * + * Resources where LLM identified a vendor name + */ + total_with_vendor_name: number; + /** + * Matched To Compass + * + * Resources successfully matched to Compass vendor_id + */ + matched_to_compass: number; + /** + * Match Rate + * + * Percentage of vendor names matched to Compass + */ + match_rate: number; + /** + * Unregistered Ad Vendors + * + * Resources flagged as potential unregistered ad vendors + */ + unregistered_ad_vendors: number; + /** + * Top Unmatched Vendors + * + * Most common vendor names not found in Compass + */ + top_unmatched_vendors?: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/VerificationCode.ts b/clients/admin-ui/src/types/api/models/VerificationCode.ts index 8170e7738ec..650b839c9b9 100644 --- a/clients/admin-ui/src/types/api/models/VerificationCode.ts +++ b/clients/admin-ui/src/types/api/models/VerificationCode.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * VerificationCode + * * Request Body for the user to supply their identity verification code */ export type VerificationCode = { + /** + * Code + */ code: string; }; diff --git a/clients/admin-ui/src/types/api/models/Violation.ts b/clients/admin-ui/src/types/api/models/Violation.ts index 0207513c18a..7669cf13891 100644 --- a/clients/admin-ui/src/types/api/models/Violation.ts +++ b/clients/admin-ui/src/types/api/models/Violation.ts @@ -1,15 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ViolationAttributes } from "./ViolationAttributes"; /** + * Violation + * * The model for violations within an evaluation. */ export type Violation = { violating_attributes: ViolationAttributes; /** + * Detail + * * A human-readable string detailing the evaluation violation. */ detail: string; diff --git a/clients/admin-ui/src/types/api/models/ViolationAttributes.ts b/clients/admin-ui/src/types/api/models/ViolationAttributes.ts index 6efe5861db3..e18ecf39e20 100644 --- a/clients/admin-ui/src/types/api/models/ViolationAttributes.ts +++ b/clients/admin-ui/src/types/api/models/ViolationAttributes.ts @@ -1,20 +1,26 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * ViolationAttributes + * * The model for attributes which led to an evaluation violation */ export type ViolationAttributes = { /** + * Data Categories + * * A list of data categories which led to an evaluation violation. */ data_categories: Array; /** + * Data Subjects + * * A list of data subjects which led to an evaluation violation. */ data_subjects: Array; /** + * Data Uses + * * A list of data uses which led to an evaluation violation. */ data_uses: Array; diff --git a/clients/admin-ui/src/types/api/models/WebMonitorUpdates.ts b/clients/admin-ui/src/types/api/models/WebMonitorUpdates.ts index f6216749e19..151052dfa58 100644 --- a/clients/admin-ui/src/types/api/models/WebMonitorUpdates.ts +++ b/clients/admin-ui/src/types/api/models/WebMonitorUpdates.ts @@ -1,11 +1,27 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * WebMonitorUpdates + */ export type WebMonitorUpdates = { + /** + * Cookie + */ cookie?: number; + /** + * Browser Request + */ browser_request?: number; + /** + * Image + */ image?: number; + /** + * Iframe + */ iframe?: number; + /** + * Javascript Tag + */ javascript_tag?: number; }; diff --git a/clients/admin-ui/src/types/api/models/WebhookDirection.ts b/clients/admin-ui/src/types/api/models/WebhookDirection.ts index dd72e81f69e..80e8677db50 100644 --- a/clients/admin-ui/src/types/api/models/WebhookDirection.ts +++ b/clients/admin-ui/src/types/api/models/WebhookDirection.ts @@ -1,8 +1,8 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * WebhookDirection + * * The webhook direction */ export enum WebhookDirection { diff --git a/clients/admin-ui/src/types/api/models/WebhookOrder.ts b/clients/admin-ui/src/types/api/models/WebhookOrder.ts index ec006b64c4d..0e6a90f83f2 100644 --- a/clients/admin-ui/src/types/api/models/WebhookOrder.ts +++ b/clients/admin-ui/src/types/api/models/WebhookOrder.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * WebhookOrder + * * Schema for displaying a minimal amount of information about the webhook and its order */ export type WebhookOrder = { + /** + * Key + */ key: string; + /** + * Order + */ order: number; }; diff --git a/clients/admin-ui/src/types/api/models/WebsiteClassificationReport.ts b/clients/admin-ui/src/types/api/models/WebsiteClassificationReport.ts new file mode 100644 index 00000000000..ad8a561fdd4 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/WebsiteClassificationReport.ts @@ -0,0 +1,69 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { CategoryDistribution } from "./CategoryDistribution"; +import type { ClassificationCoverage } from "./ClassificationCoverage"; +import type { ConfidenceDistribution } from "./ConfidenceDistribution"; +import type { LlmClassificationSample } from "./LlmClassificationSample"; +import type { VendorMatchStats } from "./VendorMatchStats"; + +/** + * WebsiteClassificationReport + * + * Comprehensive report on website LLM classification results. + * + * Provides data science insights into classification quality. + */ +export type WebsiteClassificationReport = { + /** + * Monitor Config Key + * + * Monitor configuration key + */ + monitor_config_key: string; + /** + * Generated At + * + * Report generation timestamp + */ + generated_at?: string; + /** + * Classification coverage statistics + */ + coverage: ClassificationCoverage; + /** + * Category Distribution + * + * Distribution by consent category + */ + category_distribution?: Array; + /** + * Confidence Distribution + * + * Distribution of confidence scores + */ + confidence_distribution?: Array; + /** + * Vendor matching statistics + */ + vendor_stats: VendorMatchStats; + /** + * By Resource Type + * + * Count by resource type (cookie, script, request) + */ + by_resource_type?: { + [key: string]: number; + }; + /** + * Sample Classifications + * + * Sample of classifications for manual review + */ + sample_classifications?: Array; + /** + * Flagged Resources + * + * Resources flagged for review (e.g., unregistered ad vendors) + */ + flagged_resources?: Array; +}; diff --git a/clients/admin-ui/src/types/api/models/WebsiteMonitorConfig.ts b/clients/admin-ui/src/types/api/models/WebsiteMonitorConfig.ts new file mode 100644 index 00000000000..48e2efd4548 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/WebsiteMonitorConfig.ts @@ -0,0 +1,36 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * WebsiteMonitorConfig + * + * Website monitor configuration. + * + * Simplified seed input for creating a website discovery monitor. + * See also: EditableMonitorConfig, WebsiteMonitorParams. + */ +export type WebsiteMonitorConfig = { + /** + * Url + * + * Website URL to monitor + */ + url?: string; + /** + * Name + * + * Monitor name + */ + name?: string; + /** + * Locations + * + * Locations for website monitoring + */ + locations?: Array; + /** + * Execute After Creation + * + * Execute the monitor after creation + */ + execute_after_creation?: boolean; +}; diff --git a/clients/admin-ui/src/types/api/models/WebsiteMonitorParams.ts b/clients/admin-ui/src/types/api/models/WebsiteMonitorParams.ts index e8b1f9dd0dd..4add29e9ee0 100644 --- a/clients/admin-ui/src/types/api/models/WebsiteMonitorParams.ts +++ b/clients/admin-ui/src/types/api/models/WebsiteMonitorParams.ts @@ -1,17 +1,24 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * WebsiteMonitorParams + */ export type WebsiteMonitorParams = { /** + * Locations + * * The locations from which the website should be monitored */ locations?: Array | null; /** + * Exclude Domains + * * List of domains to exclude from monitoring */ exclude_domains?: Array | null; /** + * Sitemap Url + * * URL to a sitemap.xml file that will be used to discover pages to monitor */ sitemap_url?: string | null; diff --git a/clients/admin-ui/src/types/api/models/WebsiteMonitorResourcesFilters.ts b/clients/admin-ui/src/types/api/models/WebsiteMonitorResourcesFilters.ts index c1b5a731bab..d847fcec453 100644 --- a/clients/admin-ui/src/types/api/models/WebsiteMonitorResourcesFilters.ts +++ b/clients/admin-ui/src/types/api/models/WebsiteMonitorResourcesFilters.ts @@ -1,12 +1,25 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { ConsentStatus } from "./ConsentStatus"; +import { ConsentStatus } from "./ConsentStatus"; +/** + * WebsiteMonitorResourcesFilters + */ export type WebsiteMonitorResourcesFilters = { + /** + * Resource Type + */ resource_type?: Array | null; + /** + * Locations + */ locations?: Array | null; + /** + * Consent Aggregated + */ consent_aggregated?: Array | null; + /** + * Data Uses + */ data_uses?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/WebsiteSchema.ts b/clients/admin-ui/src/types/api/models/WebsiteSchema.ts index bbc336e9882..428a4e630c0 100644 --- a/clients/admin-ui/src/types/api/models/WebsiteSchema.ts +++ b/clients/admin-ui/src/types/api/models/WebsiteSchema.ts @@ -1,10 +1,13 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * WebsiteSchema + * * Schema to validate the secrets needed for a generic website connector */ export type WebsiteSchema = { + /** + * URL + */ url: string; }; diff --git a/clients/admin-ui/src/types/api/models/WorkerHealthCheck.ts b/clients/admin-ui/src/types/api/models/WorkerHealthCheck.ts index d63d789ebf1..c1970eef2ec 100644 --- a/clients/admin-ui/src/types/api/models/WorkerHealthCheck.ts +++ b/clients/admin-ui/src/types/api/models/WorkerHealthCheck.ts @@ -1,12 +1,23 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * WorkerHealthCheck + * * Worker Healthcheck Schema */ export type WorkerHealthCheck = { + /** + * Workers Enabled + */ workers_enabled: boolean; + /** + * Workers + */ workers: Array; - queue_counts: Record; + /** + * Queue Counts + */ + queue_counts: { + [key: string]: number; + }; }; diff --git a/clients/admin-ui/src/types/api/models/WorkerInfo.ts b/clients/admin-ui/src/types/api/models/WorkerInfo.ts index e66919ec201..582f1c9ff22 100644 --- a/clients/admin-ui/src/types/api/models/WorkerInfo.ts +++ b/clients/admin-ui/src/types/api/models/WorkerInfo.ts @@ -1,11 +1,18 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { TaskDetails } from "./TaskDetails"; +/** + * WorkerInfo + */ export type WorkerInfo = { active_task?: TaskDetails | null; + /** + * Reserved Tasks + */ reserved_tasks?: Array; + /** + * Registered Tasks + */ registered_tasks?: Array; }; diff --git a/clients/admin-ui/src/types/api/models/WorkerStats.ts b/clients/admin-ui/src/types/api/models/WorkerStats.ts index 2f05739dc5d..e78d197abbe 100644 --- a/clients/admin-ui/src/types/api/models/WorkerStats.ts +++ b/clients/admin-ui/src/types/api/models/WorkerStats.ts @@ -1,11 +1,22 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { QueueInfo } from "./QueueInfo"; import type { WorkerInfo } from "./WorkerInfo"; +/** + * WorkerStats + */ export type WorkerStats = { - queues: Record; - workers: Record; + /** + * Queues + */ + queues: { + [key: string]: QueueInfo; + }; + /** + * Workers + */ + workers: { + [key: string]: WorkerInfo; + }; }; diff --git a/clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetData.ts b/clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetData.ts new file mode 100644 index 00000000000..5d147fcb7db --- /dev/null +++ b/clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetData.ts @@ -0,0 +1,8 @@ +// This file is auto-generated by @hey-api/openapi-ts + +export type databaseHealthHealthDatabaseGetData = { + body?: never; + path?: never; + query?: never; + url: "/health/database"; +}; diff --git a/clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetErrors.ts b/clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetErrors.ts new file mode 100644 index 00000000000..70ce6e6ffa9 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetErrors.ts @@ -0,0 +1,8 @@ +// This file is auto-generated by @hey-api/openapi-ts + +export type databaseHealthHealthDatabaseGetErrors = { + /** + * Service Unavailable + */ + 503: unknown; +}; diff --git a/clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetResponse.ts b/clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetResponse.ts new file mode 100644 index 00000000000..5017def3098 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetResponse.ts @@ -0,0 +1,6 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { databaseHealthHealthDatabaseGetResponses } from "./databaseHealthHealthDatabaseGetResponses"; + +export type databaseHealthHealthDatabaseGetResponse = + databaseHealthHealthDatabaseGetResponses[keyof databaseHealthHealthDatabaseGetResponses]; diff --git a/clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetResponses.ts b/clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetResponses.ts new file mode 100644 index 00000000000..050e6ffe342 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/databaseHealthHealthDatabaseGetResponses.ts @@ -0,0 +1,10 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { DatabaseHealthCheck } from "./DatabaseHealthCheck"; + +export type databaseHealthHealthDatabaseGetResponses = { + /** + * Successful Response + */ + 200: DatabaseHealthCheck; +}; diff --git a/clients/admin-ui/src/types/api/models/fides__api__schemas__application_config__ConsentConfig.ts b/clients/admin-ui/src/types/api/models/fides__api__schemas__application_config__ConsentConfig.ts index 7dc400a7163..8eb1ace9516 100644 --- a/clients/admin-ui/src/types/api/models/fides__api__schemas__application_config__ConsentConfig.ts +++ b/clients/admin-ui/src/types/api/models/fides__api__schemas__application_config__ConsentConfig.ts @@ -1,7 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * ConsentConfig + */ export type fides__api__schemas__application_config__ConsentConfig = { + /** + * Override Vendor Purposes + */ override_vendor_purposes: boolean | null; }; diff --git a/clients/admin-ui/src/types/api/models/fides__api__schemas__application_config__PrivacyCenterConfig.ts b/clients/admin-ui/src/types/api/models/fides__api__schemas__application_config__PrivacyCenterConfig.ts index 839a3f34e5f..b37ccf864db 100644 --- a/clients/admin-ui/src/types/api/models/fides__api__schemas__application_config__PrivacyCenterConfig.ts +++ b/clients/admin-ui/src/types/api/models/fides__api__schemas__application_config__PrivacyCenterConfig.ts @@ -1,7 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * PrivacyCenterConfig + */ export type fides__api__schemas__application_config__PrivacyCenterConfig = { + /** + * Url + */ url?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds.ts b/clients/admin-ui/src/types/api/models/fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds.ts index 36b525f2592..20a7d2bd422 100644 --- a/clients/admin-ui/src/types/api/models/fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds.ts +++ b/clients/admin-ui/src/types/api/models/fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds.ts @@ -1,20 +1,50 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * KeyfileCreds + * * Schema that holds BigQuery keyfile key/vals */ export type fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds = { + /** + * Type + */ type?: string | null; + /** + * Project ID + */ project_id: string; + /** + * Private key ID + */ private_key_id?: string | null; + /** + * Private key + */ private_key?: string | null; + /** + * Client email + */ client_email?: string | null; + /** + * Client ID + */ client_id?: string | null; + /** + * Auth URI + */ auth_uri?: string | null; + /** + * Token URI + */ token_uri?: string | null; + /** + * Auth provider X509 cert URL + */ auth_provider_x509_cert_url?: string | null; + /** + * Client X509 cert URL + */ client_x509_cert_url?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds.ts b/clients/admin-ui/src/types/api/models/fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds.ts index d4c4e70d2ec..a9c48fb24a9 100644 --- a/clients/admin-ui/src/types/api/models/fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds.ts +++ b/clients/admin-ui/src/types/api/models/fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds.ts @@ -1,21 +1,54 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * KeyfileCreds + * * Schema that holds Google Cloud SQL for MySQL keyfile key/vals */ export type fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds = { + /** + * Type + */ type?: string | null; + /** + * Project ID + */ project_id: string; + /** + * Private key ID + */ private_key_id?: string | null; + /** + * Private Key + */ private_key?: string | null; + /** + * Client Email + */ client_email?: string | null; + /** + * Client ID + */ client_id?: string | null; + /** + * Auth URI + */ auth_uri?: string | null; + /** + * Token URI + */ token_uri?: string | null; + /** + * Auth provider X509 cert URL + */ auth_provider_x509_cert_url?: string | null; + /** + * Client X509 cert URL + */ client_x509_cert_url?: string | null; + /** + * Universe domain + */ universe_domain: string; }; diff --git a/clients/admin-ui/src/types/api/models/fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds.ts b/clients/admin-ui/src/types/api/models/fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds.ts index 8affb57a12c..fb383ec04b2 100644 --- a/clients/admin-ui/src/types/api/models/fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds.ts +++ b/clients/admin-ui/src/types/api/models/fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds.ts @@ -1,21 +1,54 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * KeyfileCreds + * * Schema that holds Google Cloud SQL for Postgres keyfile key/vals */ export type fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds = { + /** + * Type + */ type?: string | null; + /** + * Project ID + */ project_id: string; + /** + * Private key ID + */ private_key_id?: string | null; + /** + * Private Key + */ private_key?: string | null; + /** + * Client Email + */ client_email?: string | null; + /** + * Client ID + */ client_id?: string | null; + /** + * Auth URI + */ auth_uri?: string | null; + /** + * Token URI + */ token_uri?: string | null; + /** + * Auth provider X509 cert URL + */ auth_provider_x509_cert_url?: string | null; + /** + * Client X509 cert URL + */ client_x509_cert_url?: string | null; + /** + * Universe domain + */ universe_domain: string; }; diff --git a/clients/admin-ui/src/types/api/models/fides__api__schemas__policy__Policy.ts b/clients/admin-ui/src/types/api/models/fides__api__schemas__policy__Policy.ts index 64cdfd41713..2ef9d43c634 100644 --- a/clients/admin-ui/src/types/api/models/fides__api__schemas__policy__Policy.ts +++ b/clients/admin-ui/src/types/api/models/fides__api__schemas__policy__Policy.ts @@ -1,15 +1,31 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts -import type { DrpAction } from "./DrpAction"; +import { ActionType } from "./ActionType"; +import { DrpAction } from "./DrpAction"; +import type { RuleCreateWithTargets } from "./RuleCreateWithTargets"; /** + * Policy + * * An external representation of a Fidesops Policy */ export type fides__api__schemas__policy__Policy = { + /** + * Name + */ name: string; + /** + * Key + */ key?: string | null; + action_type?: ActionType | null; + /** + * Rules + */ + rules?: Array | null; drp_action?: DrpAction | null; + /** + * Execution Timeframe + */ execution_timeframe?: number | null; }; diff --git a/clients/admin-ui/src/types/api/models/fides__api__schemas__privacy_center_config__ConsentConfig.ts b/clients/admin-ui/src/types/api/models/fides__api__schemas__privacy_center_config__ConsentConfig.ts index 704fa77da56..718d5dd3846 100644 --- a/clients/admin-ui/src/types/api/models/fides__api__schemas__privacy_center_config__ConsentConfig.ts +++ b/clients/admin-ui/src/types/api/models/fides__api__schemas__privacy_center_config__ConsentConfig.ts @@ -1,10 +1,11 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { ConsentConfigButton } from "./ConsentConfigButton"; import type { ConsentConfigPage } from "./ConsentConfigPage"; +/** + * ConsentConfig + */ export type fides__api__schemas__privacy_center_config__ConsentConfig = { button: ConsentConfigButton; page: ConsentConfigPage; diff --git a/clients/admin-ui/src/types/api/models/fides__api__schemas__privacy_center_config__CustomPrivacyRequestField.ts b/clients/admin-ui/src/types/api/models/fides__api__schemas__privacy_center_config__CustomPrivacyRequestField.ts index ee7744fe3f5..0926cd02312 100644 --- a/clients/admin-ui/src/types/api/models/fides__api__schemas__privacy_center_config__CustomPrivacyRequestField.ts +++ b/clients/admin-ui/src/types/api/models/fides__api__schemas__privacy_center_config__CustomPrivacyRequestField.ts @@ -1,12 +1,38 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts +/** + * CustomPrivacyRequestField + * + * Regular custom privacy request field supporting text, select, and multiselect types + */ export type fides__api__schemas__privacy_center_config__CustomPrivacyRequestField = { + /** + * Label + */ label: string; + /** + * Required + */ required?: boolean | null; + /** + * Default Value + */ default_value?: string | null; + /** + * Hidden + */ hidden?: boolean | null; + /** + * Query Param Key + */ query_param_key?: string | null; + /** + * Field Type + */ + field_type?: "text" | "select" | "multiselect" | null; + /** + * Options + */ + options?: Array | null; }; diff --git a/clients/admin-ui/src/types/api/models/PrivacyCenterConfig.ts b/clients/admin-ui/src/types/api/models/fides__api__schemas__privacy_center_config__PrivacyCenterConfig.ts similarity index 66% rename from clients/admin-ui/src/types/api/models/PrivacyCenterConfig.ts rename to clients/admin-ui/src/types/api/models/fides__api__schemas__privacy_center_config__PrivacyCenterConfig.ts index 9d6b3adac03..b81f31f22d7 100644 --- a/clients/admin-ui/src/types/api/models/PrivacyCenterConfig.ts +++ b/clients/admin-ui/src/types/api/models/fides__api__schemas__privacy_center_config__PrivacyCenterConfig.ts @@ -1,31 +1,70 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { fides__api__schemas__privacy_center_config__ConsentConfig } from "./fides__api__schemas__privacy_center_config__ConsentConfig"; import type { PolicyUnavailableMessages } from "./PolicyUnavailableMessages"; import type { PrivacyRequestOption } from "./PrivacyRequestOption"; /** + * PrivacyCenterConfig + * * NOTE: Add to this schema with care. Any fields added to * this response schema will be exposed in public-facing * (i.e. unauthenticated) API responses. If a field has * sensitive information, it should NOT be added to this schema! */ -export type PrivacyCenterConfig = { +export type fides__api__schemas__privacy_center_config__PrivacyCenterConfig = { + /** + * Title + */ title: string; + /** + * Description + */ description: string; + /** + * Description Subtext + */ description_subtext?: Array | null; + /** + * Addendum + */ addendum?: Array | null; + /** + * Server Url Development + */ server_url_development?: string | null; + /** + * Server Url Production + */ server_url_production?: string | null; + /** + * Logo Path + */ logo_path?: string | null; + /** + * Logo Url + */ logo_url?: string | null; + /** + * Favicon Path + */ favicon_path?: string | null; + /** + * Actions + */ actions: Array; + /** + * Includeconsent + */ includeConsent?: boolean | null; consent: fides__api__schemas__privacy_center_config__ConsentConfig; + /** + * Privacy Policy Url + */ privacy_policy_url?: string | null; + /** + * Privacy Policy Url Text + */ privacy_policy_url_text?: string | null; policy_unavailable_messages?: PolicyUnavailableMessages | null; }; diff --git a/clients/admin-ui/src/types/api/models/fides__api__schemas__privacy_request__IdentityValue.ts b/clients/admin-ui/src/types/api/models/fides__api__schemas__privacy_request__IdentityValue.ts new file mode 100644 index 00000000000..bc96828853c --- /dev/null +++ b/clients/admin-ui/src/types/api/models/fides__api__schemas__privacy_request__IdentityValue.ts @@ -0,0 +1,25 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * IdentityValue + * + * Represents an identity value with a label in API responses. + * + * The value field accepts MultiValue types which match what LabeledIdentity supports: + * - int + * - str + * - List[Union[int, str]] + * + * This allows the schema to accept list values that were previously causing + * validation errors. + */ +export type fides__api__schemas__privacy_request__IdentityValue = { + /** + * Label + */ + label: string; + /** + * Value + */ + value?: number | string | Array | null; +}; diff --git a/clients/admin-ui/src/types/api/models/fides__api__schemas__redis_cache__CustomPrivacyRequestField.ts b/clients/admin-ui/src/types/api/models/fides__api__schemas__redis_cache__CustomPrivacyRequestField.ts index 1f36409aa81..e9c75dd4ca2 100644 --- a/clients/admin-ui/src/types/api/models/fides__api__schemas__redis_cache__CustomPrivacyRequestField.ts +++ b/clients/admin-ui/src/types/api/models/fides__api__schemas__redis_cache__CustomPrivacyRequestField.ts @@ -1,11 +1,17 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * CustomPrivacyRequestField + * * Schema for custom privacy request fields. */ export type fides__api__schemas__redis_cache__CustomPrivacyRequestField = { + /** + * Label + */ label: string; - value: number | string; + /** + * Value + */ + value: number | string | Array; }; diff --git a/clients/admin-ui/src/types/api/models/fides__api__schemas__redis_cache__Identity.ts b/clients/admin-ui/src/types/api/models/fides__api__schemas__redis_cache__Identity.ts new file mode 100644 index 00000000000..18ada031e21 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/fides__api__schemas__redis_cache__Identity.ts @@ -0,0 +1,48 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * Identity + * + * Some PII grouping pertaining to a human + */ +export type fides__api__schemas__redis_cache__Identity = { + /** + * Phone number + */ + phone_number?: string | null; + /** + * Email + */ + email?: string | null; + /** + * GA client ID + */ + ga_client_id?: string | null; + /** + * LJT reader ID + */ + ljt_readerID?: string | null; + /** + * Fides user device ID + */ + fides_user_device_id?: string | null; + /** + * External ID + */ + external_id?: string | null; + [key: string]: + | unknown + | string + | null + | string + | null + | string + | null + | string + | null + | string + | null + | string + | null + | undefined; +}; diff --git a/clients/admin-ui/src/types/api/models/fides__connectors__models__KeyfileCreds.ts b/clients/admin-ui/src/types/api/models/fides__connectors__models__KeyfileCreds.ts index 980390f5d5f..a333e9ab299 100644 --- a/clients/admin-ui/src/types/api/models/fides__connectors__models__KeyfileCreds.ts +++ b/clients/admin-ui/src/types/api/models/fides__connectors__models__KeyfileCreds.ts @@ -1,19 +1,49 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * KeyfileCreds + * * The model for BigQuery credential keyfiles. */ export type fides__connectors__models__KeyfileCreds = { + /** + * Type + */ type?: string | null; + /** + * Project Id + */ project_id: string; + /** + * Private Key Id + */ private_key_id?: string | null; + /** + * Private Key + */ private_key?: string | null; + /** + * Client Email + */ client_email?: string | null; + /** + * Client Id + */ client_id?: string | null; + /** + * Auth Uri + */ auth_uri?: string | null; + /** + * Token Uri + */ token_uri?: string | null; + /** + * Auth Provider X509 Cert Url + */ auth_provider_x509_cert_url?: string | null; + /** + * Client X509 Cert Url + */ client_x509_cert_url?: string | null; }; diff --git a/clients/admin-ui/src/types/api/models/fideslang__models__Policy.ts b/clients/admin-ui/src/types/api/models/fideslang__models__Policy.ts index 5f2b150acc7..5c423ed043e 100644 --- a/clients/admin-ui/src/types/api/models/fideslang__models__Policy.ts +++ b/clients/admin-ui/src/types/api/models/fideslang__models__Policy.ts @@ -1,33 +1,46 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { PolicyRule } from "./PolicyRule"; /** + * Policy + * * The Policy resource model. * * An object used to organize a list of PolicyRules. */ export type fideslang__models__Policy = { /** + * Fides Key + * * A unique key used to identify this resource. */ fides_key: string; /** + * Organization Fides Key + * * Defines the Organization that this resource belongs to. */ organization_fides_key?: string; + /** + * Tags + */ tags?: Array | null; /** + * Name + * * Human-Readable name for this resource. */ name?: string | null; /** + * Description + * * A detailed description of what this resource is. */ description?: string | null; /** + * Rules + * * * The PolicyRule resource model. * diff --git a/clients/admin-ui/src/types/api/models/fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRestrictionResponse.ts b/clients/admin-ui/src/types/api/models/fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRestrictionResponse.ts index 2eeea5c5cfb..6053b92af0e 100644 --- a/clients/admin-ui/src/types/api/models/fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRestrictionResponse.ts +++ b/clients/admin-ui/src/types/api/models/fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRestrictionResponse.ts @@ -1,17 +1,19 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { RangeEntry } from "./RangeEntry"; -import type { TCFRestrictionType } from "./TCFRestrictionType"; -import type { TCFVendorRestriction } from "./TCFVendorRestriction"; +import { TCFRestrictionType } from "./TCFRestrictionType"; +import { TCFVendorRestriction } from "./TCFVendorRestriction"; /** + * TCFPublisherRestrictionResponse + * * Schema for TCF Publisher Restriction responses */ export type fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRestrictionResponse = { /** + * Purpose Id + * * The ID of the purpose this restriction applies to */ purpose_id: number; @@ -24,14 +26,20 @@ export type fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRes */ vendor_restriction: TCFVendorRestriction; /** + * Range Entries + * * List of vendor ranges this restriction applies to */ range_entries?: Array; /** + * Id + * * The unique identifier of the TCF Publisher Restriction */ id: string; /** + * Tcf Configuration Id + * * The ID of the TCF Configuration this restriction belongs to */ tcf_configuration_id: string; diff --git a/clients/admin-ui/src/types/api/models/fidesplus__cls__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds.ts b/clients/admin-ui/src/types/api/models/fidesplus__cls__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds.ts new file mode 100644 index 00000000000..7bba0a72452 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/fidesplus__cls__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds.ts @@ -0,0 +1,50 @@ +// This file is auto-generated by @hey-api/openapi-ts + +/** + * KeyfileCreds + * + * Schema that holds BigQuery keyfile key/vals + */ +export type fidesplus__cls__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds = + { + /** + * Type + */ + type?: string | null; + /** + * Project Id + */ + project_id: string; + /** + * Private Key Id + */ + private_key_id?: string | null; + /** + * Private Key + */ + private_key?: string | null; + /** + * Client Email + */ + client_email?: string | null; + /** + * Client Id + */ + client_id?: string | null; + /** + * Auth Uri + */ + auth_uri?: string | null; + /** + * Token Uri + */ + token_uri?: string | null; + /** + * Auth Provider X509 Cert Url + */ + auth_provider_x509_cert_url?: string | null; + /** + * Client X509 Cert Url + */ + client_x509_cert_url?: string | null; + }; diff --git a/clients/admin-ui/src/types/api/models/fidesplus__schemas__tcf_experience__TCFPublisherRestrictionResponse.ts b/clients/admin-ui/src/types/api/models/fidesplus__schemas__tcf_experience__TCFPublisherRestrictionResponse.ts index 25c919edc24..df6780871c3 100644 --- a/clients/admin-ui/src/types/api/models/fidesplus__schemas__tcf_experience__TCFPublisherRestrictionResponse.ts +++ b/clients/admin-ui/src/types/api/models/fidesplus__schemas__tcf_experience__TCFPublisherRestrictionResponse.ts @@ -1,13 +1,22 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * TCFPublisherRestrictionResponse + * * Pydantic model for TCF Publisher Restrictions */ export type fidesplus__schemas__tcf_experience__TCFPublisherRestrictionResponse = { + /** + * Purpose Id + */ purpose_id: number; + /** + * Restriction Type + */ restriction_type: number; + /** + * Vendors + */ vendors: Array; }; diff --git a/clients/admin-ui/src/types/api/models/fidesplus__v3__schemas__identity__Identity.ts b/clients/admin-ui/src/types/api/models/fidesplus__v3__schemas__identity__Identity.ts index d5f29ffd588..32f7991fd73 100644 --- a/clients/admin-ui/src/types/api/models/fidesplus__v3__schemas__identity__Identity.ts +++ b/clients/admin-ui/src/types/api/models/fidesplus__v3__schemas__identity__Identity.ts @@ -1,13 +1,12 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts import type { fidesplus__v3__schemas__identity__IdentityValue } from "./fidesplus__v3__schemas__identity__IdentityValue"; /** + * Identity + * * Contains unique identifiers for a subject across multiple systems. Each entry must contain a `value` field and may contain arbitrary key-value pairs for additional metadata. At a minimum, at least one identity must be provided. */ -export type fidesplus__v3__schemas__identity__Identity = Record< - string, - fidesplus__v3__schemas__identity__IdentityValue ->; +export type fidesplus__v3__schemas__identity__Identity = { + [key: string]: fidesplus__v3__schemas__identity__IdentityValue; +}; diff --git a/clients/admin-ui/src/types/api/models/fidesplus__v3__schemas__identity__IdentityValue.ts b/clients/admin-ui/src/types/api/models/fidesplus__v3__schemas__identity__IdentityValue.ts index f51ff43197a..9aa3a7532de 100644 --- a/clients/admin-ui/src/types/api/models/fidesplus__v3__schemas__identity__IdentityValue.ts +++ b/clients/admin-ui/src/types/api/models/fidesplus__v3__schemas__identity__IdentityValue.ts @@ -1,11 +1,16 @@ -/* istanbul ignore file */ -/* tslint:disable */ -/* eslint-disable */ +// This file is auto-generated by @hey-api/openapi-ts /** + * IdentityValue + * * Identity value object with a required `value` field (string or integer) and optional arbitrary key-value pairs for additional metadata */ -export type fidesplus__v3__schemas__identity__IdentityValue = Record< - string, - string | number ->; +export type fidesplus__v3__schemas__identity__IdentityValue = { + /** + * Value + * + * The actual identity value + */ + value: number | string; + [key: string]: string | number | number | string; +}; diff --git a/clients/admin-ui/src/types/api/models/healthHealthGetData.ts b/clients/admin-ui/src/types/api/models/healthHealthGetData.ts new file mode 100644 index 00000000000..9e5b497ebf2 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/healthHealthGetData.ts @@ -0,0 +1,13 @@ +// This file is auto-generated by @hey-api/openapi-ts + +export type healthHealthGetData = { + body?: never; + path?: never; + query?: { + /** + * Include Cache + */ + include_cache?: boolean | null; + }; + url: "/health"; +}; diff --git a/clients/admin-ui/src/types/api/models/healthHealthGetError.ts b/clients/admin-ui/src/types/api/models/healthHealthGetError.ts new file mode 100644 index 00000000000..03038f299d9 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/healthHealthGetError.ts @@ -0,0 +1,6 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { healthHealthGetErrors } from "./healthHealthGetErrors"; + +export type healthHealthGetError = + healthHealthGetErrors[keyof healthHealthGetErrors]; diff --git a/clients/admin-ui/src/types/api/models/healthHealthGetErrors.ts b/clients/admin-ui/src/types/api/models/healthHealthGetErrors.ts new file mode 100644 index 00000000000..af021e2f302 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/healthHealthGetErrors.ts @@ -0,0 +1,14 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { HTTPValidationError } from "./HTTPValidationError"; + +export type healthHealthGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; + /** + * Service Unavailable + */ + 503: unknown; +}; diff --git a/clients/admin-ui/src/types/api/models/healthHealthGetResponse.ts b/clients/admin-ui/src/types/api/models/healthHealthGetResponse.ts new file mode 100644 index 00000000000..2b2caf2f245 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/healthHealthGetResponse.ts @@ -0,0 +1,6 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { healthHealthGetResponses } from "./healthHealthGetResponses"; + +export type healthHealthGetResponse = + healthHealthGetResponses[keyof healthHealthGetResponses]; diff --git a/clients/admin-ui/src/types/api/models/healthHealthGetResponses.ts b/clients/admin-ui/src/types/api/models/healthHealthGetResponses.ts new file mode 100644 index 00000000000..13a65850269 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/healthHealthGetResponses.ts @@ -0,0 +1,10 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { CoreHealthCheck } from "./CoreHealthCheck"; + +export type healthHealthGetResponses = { + /** + * Successful Response + */ + 200: CoreHealthCheck; +}; diff --git a/clients/admin-ui/src/types/api/models/readIndexGetData.ts b/clients/admin-ui/src/types/api/models/readIndexGetData.ts new file mode 100644 index 00000000000..0b79c970ee2 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/readIndexGetData.ts @@ -0,0 +1,8 @@ +// This file is auto-generated by @hey-api/openapi-ts + +export type readIndexGetData = { + body?: never; + path?: never; + query?: never; + url: "/"; +}; diff --git a/clients/admin-ui/src/types/api/models/readIndexGetResponses.ts b/clients/admin-ui/src/types/api/models/readIndexGetResponses.ts new file mode 100644 index 00000000000..80cf8a25c6d --- /dev/null +++ b/clients/admin-ui/src/types/api/models/readIndexGetResponses.ts @@ -0,0 +1,8 @@ +// This file is auto-generated by @hey-api/openapi-ts + +export type readIndexGetResponses = { + /** + * Successful Response + */ + 200: unknown; +}; diff --git a/clients/admin-ui/src/types/api/models/readOtherPathsCatchallGetData.ts b/clients/admin-ui/src/types/api/models/readOtherPathsCatchallGetData.ts new file mode 100644 index 00000000000..7ddce12e447 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/readOtherPathsCatchallGetData.ts @@ -0,0 +1,8 @@ +// This file is auto-generated by @hey-api/openapi-ts + +export type readOtherPathsCatchallGetData = { + body?: never; + path?: never; + query?: never; + url: "/{catchall}"; +}; diff --git a/clients/admin-ui/src/types/api/models/readOtherPathsCatchallGetResponses.ts b/clients/admin-ui/src/types/api/models/readOtherPathsCatchallGetResponses.ts new file mode 100644 index 00000000000..b7e498fb447 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/readOtherPathsCatchallGetResponses.ts @@ -0,0 +1,8 @@ +// This file is auto-generated by @hey-api/openapi-ts + +export type readOtherPathsCatchallGetResponses = { + /** + * Successful Response + */ + 200: unknown; +}; diff --git a/clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetData.ts b/clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetData.ts new file mode 100644 index 00000000000..7726f071a80 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetData.ts @@ -0,0 +1,8 @@ +// This file is auto-generated by @hey-api/openapi-ts + +export type workersHealthHealthWorkersGetData = { + body?: never; + path?: never; + query?: never; + url: "/health/workers"; +}; diff --git a/clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetErrors.ts b/clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetErrors.ts new file mode 100644 index 00000000000..c3a39969660 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetErrors.ts @@ -0,0 +1,8 @@ +// This file is auto-generated by @hey-api/openapi-ts + +export type workersHealthHealthWorkersGetErrors = { + /** + * Service Unavailable + */ + 503: unknown; +}; diff --git a/clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetResponse.ts b/clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetResponse.ts new file mode 100644 index 00000000000..a9842abb1c0 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetResponse.ts @@ -0,0 +1,6 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { workersHealthHealthWorkersGetResponses } from "./workersHealthHealthWorkersGetResponses"; + +export type workersHealthHealthWorkersGetResponse = + workersHealthHealthWorkersGetResponses[keyof workersHealthHealthWorkersGetResponses]; diff --git a/clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetResponses.ts b/clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetResponses.ts new file mode 100644 index 00000000000..4d6bf5335f7 --- /dev/null +++ b/clients/admin-ui/src/types/api/models/workersHealthHealthWorkersGetResponses.ts @@ -0,0 +1,10 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { WorkerHealthCheck } from "./WorkerHealthCheck"; + +export type workersHealthHealthWorkersGetResponses = { + /** + * Successful Response + */ + 200: WorkerHealthCheck; +}; diff --git a/clients/admin-ui/src/types/api/types.ts b/clients/admin-ui/src/types/api/types.ts new file mode 100644 index 00000000000..36fe70d8409 --- /dev/null +++ b/clients/admin-ui/src/types/api/types.ts @@ -0,0 +1,25224 @@ +// This file is auto-generated by @hey-api/openapi-ts + +import type { AccessManualWebhookResponse } from "./models/AccessManualWebhookResponse"; +import type { AccessManualWebhooks } from "./models/AccessManualWebhooks"; +import type { AccessToken } from "./models/AccessToken"; +import { ActionType } from "./models/ActionType"; +import type { ActionValidationErrorResponse } from "./models/ActionValidationErrorResponse"; +import type { AdvancedSettings } from "./models/AdvancedSettings"; +import type { AdvancedSettingsWithExtendedIdentityTypes } from "./models/AdvancedSettingsWithExtendedIdentityTypes"; +import type { AesDecryptionRequest } from "./models/AesDecryptionRequest"; +import type { AesDecryptionResponse } from "./models/AesDecryptionResponse"; +import type { AesEncryptionRequest } from "./models/AesEncryptionRequest"; +import type { AesEncryptionResponse } from "./models/AesEncryptionResponse"; +import type { AllowedActionsResponse } from "./models/AllowedActionsResponse"; +import type { AllowList } from "./models/AllowList"; +import type { AllowListUpdate } from "./models/AllowListUpdate"; +import { APIMonitorType } from "./models/APIMonitorType"; +import type { AssessmentTaskResponse } from "./models/AssessmentTaskResponse"; +import type { Asset } from "./models/Asset"; +import type { AssetCreate } from "./models/AssetCreate"; +import type { AssetReportingFilters } from "./models/AssetReportingFilters"; +import type { AssetUpdate } from "./models/AssetUpdate"; +import type { AssignStewardRequest } from "./models/AssignStewardRequest"; +import type { AttachmentResponse } from "./models/AttachmentResponse"; +import type { AuthenticationMethods } from "./models/AuthenticationMethods"; +import { AWSAuthMethod } from "./models/AWSAuthMethod"; +import type { BackfillRequest } from "./models/BackfillRequest"; +import type { BackfillStatusResponse } from "./models/BackfillStatusResponse"; +import type { BaseStagedResourcesRequest } from "./models/BaseStagedResourcesRequest"; +import type { BasicMessagingTemplateRequest } from "./models/BasicMessagingTemplateRequest"; +import type { BasicMessagingTemplateResponse } from "./models/BasicMessagingTemplateResponse"; +import type { BasicSystemResponseExtended } from "./models/BasicSystemResponseExtended"; +import type { BedrockConnectionTestRequest } from "./models/BedrockConnectionTestRequest"; +import type { BedrockConnectionTestResponse } from "./models/BedrockConnectionTestResponse"; +import { BenchmarkStatus } from "./models/BenchmarkStatus"; +import type { Body_acquire_access_token_api_v1_oauth_token_post } from "./models/Body_acquire_access_token_api_v1_oauth_token_post"; +import type { Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment__comment_id__attachment_post } from "./models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment__comment_id__attachment_post"; +import type { Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__comment__comment_id__attachment_post } from "./models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__comment__comment_id__attachment_post"; +import type { Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment__comment_id__attachment_post } from "./models/Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment__comment_id__attachment_post"; +import type { Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__attachment_post } from "./models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__attachment_post"; +import type { Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__attachment_post } from "./models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__attachment_post"; +import type { Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__attachment_post } from "./models/Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__attachment_post"; +import type { Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment_post } from "./models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment_post"; +import type { Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__comment_post } from "./models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__comment_post"; +import type { Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment_post } from "./models/Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment_post"; +import type { Body_export_minimal_datamap_with_format_api_v1_plus_datamap_minimal__export_format__post } from "./models/Body_export_minimal_datamap_with_format_api_v1_plus_datamap_minimal__export_format__post"; +import type { Body_skip_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__skip_post } from "./models/Body_skip_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__skip_post"; +import type { Body_submit_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__complete_post } from "./models/Body_submit_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__complete_post"; +import type { Body_Update_tagging_instructions_api_v1_data_category__fides_key__tagging_instructions_patch } from "./models/Body_Update_tagging_instructions_api_v1_data_category__fides_key__tagging_instructions_patch"; +import type { Body_upload_data_api_v1_storage__request_id__post } from "./models/Body_upload_data_api_v1_storage__request_id__post"; +import type { BulkConditionAssignment } from "./models/BulkConditionAssignment"; +import type { BulkCustomFieldRequest } from "./models/BulkCustomFieldRequest"; +import type { BulkDatasetPropertyResponse } from "./models/BulkDatasetPropertyResponse"; +import type { BulkPostPrivacyRequests } from "./models/BulkPostPrivacyRequests"; +import type { BulkPropertyAssignment } from "./models/BulkPropertyAssignment"; +import type { BulkPropertyRemoval } from "./models/BulkPropertyRemoval"; +import type { BulkPutBasicMessagingTemplateResponse } from "./models/BulkPutBasicMessagingTemplateResponse"; +import type { BulkPutConnectionConfiguration } from "./models/BulkPutConnectionConfiguration"; +import type { BulkPutDataset } from "./models/BulkPutDataset"; +import type { BulkPutPolicyResponse } from "./models/BulkPutPolicyResponse"; +import type { BulkPutRuleResponse } from "./models/BulkPutRuleResponse"; +import type { BulkPutRuleTargetResponse } from "./models/BulkPutRuleTargetResponse"; +import type { BulkPutStorageConfigResponse } from "./models/BulkPutStorageConfigResponse"; +import type { BulkReviewResponse } from "./models/BulkReviewResponse"; +import type { BulkSoftDeletePrivacyRequests } from "./models/BulkSoftDeletePrivacyRequests"; +import type { BulkUserAssignment } from "./models/BulkUserAssignment"; +import type { CancelPrivacyRequestSelection } from "./models/CancelPrivacyRequestSelection"; +import type { ChatChannelsResponse } from "./models/ChatChannelsResponse"; +import type { ChatConfigCreate } from "./models/ChatConfigCreate"; +import type { ChatConfigListResponse } from "./models/ChatConfigListResponse"; +import type { ChatConfigResponse } from "./models/ChatConfigResponse"; +import type { ChatConfigSecrets } from "./models/ChatConfigSecrets"; +import type { ChatConfigTestResponse } from "./models/ChatConfigTestResponse"; +import type { ChatConfigUpdate } from "./models/ChatConfigUpdate"; +import type { ClassificationBenchmarkRequest } from "./models/ClassificationBenchmarkRequest"; +import type { ClassificationBenchmarkResponse } from "./models/ClassificationBenchmarkResponse"; +import type { ClassificationBenchmarkSummary } from "./models/ClassificationBenchmarkSummary"; +import type { ClassificationResponse } from "./models/ClassificationResponse"; +import type { ClassifyDatasetResponse } from "./models/ClassifyDatasetResponse"; +import type { ClassifyEmpty } from "./models/ClassifyEmpty"; +import type { ClassifyInstanceResponseValues } from "./models/ClassifyInstanceResponseValues"; +import type { ClassifyRequestPayload } from "./models/ClassifyRequestPayload"; +import type { ClassifyResult } from "./models/ClassifyResult"; +import type { ClassifyStatusUpdatePayload } from "./models/ClassifyStatusUpdatePayload"; +import type { ClassifySystem } from "./models/ClassifySystem"; +import type { ClientCreatedResponse } from "./models/ClientCreatedResponse"; +import type { CloudConfig } from "./models/CloudConfig"; +import { ColumnSort } from "./models/ColumnSort"; +import type { CommentResponse } from "./models/CommentResponse"; +import { ComponentType } from "./models/ComponentType"; +import type { ConditionalTotalPage_ConsentReportingSchema_ } from "./models/ConditionalTotalPage_ConsentReportingSchema_"; +import type { ConditionGroup } from "./models/ConditionGroup"; +import type { ConditionLeaf } from "./models/ConditionLeaf"; +import { ConfidenceBucket } from "./models/ConfidenceBucket"; +import type { ConfirmResourcesResponse } from "./models/ConfirmResourcesResponse"; +import type { ConnectionConfigurationResponseWithSystemKey } from "./models/ConnectionConfigurationResponseWithSystemKey"; +import type { ConnectionDatahubSyncPayload } from "./models/ConnectionDatahubSyncPayload"; +import type { ConnectionDatahubSyncResponse } from "./models/ConnectionDatahubSyncResponse"; +import { ConnectionType } from "./models/ConnectionType"; +import type { ConnectorTemplateListResponse } from "./models/ConnectorTemplateListResponse"; +import type { ConsentableItem } from "./models/ConsentableItem"; +import type { ConsentCreate } from "./models/ConsentCreate"; +import type { ConsentPreferenceResponse } from "./models/ConsentPreferenceResponse"; +import type { ConsentPreferences } from "./models/ConsentPreferences"; +import type { ConsentPreferencesWithVerificationCode } from "./models/ConsentPreferencesWithVerificationCode"; +import type { ConsentRequestCreateExtended } from "./models/ConsentRequestCreateExtended"; +import type { ConsentRequestResponse } from "./models/ConsentRequestResponse"; +import type { ConsentResponse } from "./models/ConsentResponse"; +import { ConsentStatus } from "./models/ConsentStatus"; +import type { CreateAssessmentTaskRequest } from "./models/CreateAssessmentTaskRequest"; +import type { CreateAssessmentTaskResponse } from "./models/CreateAssessmentTaskResponse"; +import type { CreateConnectionConfigurationWithSecrets } from "./models/CreateConnectionConfigurationWithSecrets"; +import type { CreateConnectionConfigurationWithSecretsExtended } from "./models/CreateConnectionConfigurationWithSecretsExtended"; +import type { CreateExportPrivacyPreferencesJobRequest } from "./models/CreateExportPrivacyPreferencesJobRequest"; +import type { CreateExportPrivacyPreferencesJobResponse } from "./models/CreateExportPrivacyPreferencesJobResponse"; +import type { CreateIngestionPrivacyPreferencesJobRequest } from "./models/CreateIngestionPrivacyPreferencesJobRequest"; +import type { CreateIngestionPrivacyPreferencesJobResponse } from "./models/CreateIngestionPrivacyPreferencesJobResponse"; +import type { CursorPage_DatastoreStagedResourceTreeAPIResponse_ } from "./models/CursorPage_DatastoreStagedResourceTreeAPIResponse_"; +import { CustomAssetType } from "./models/CustomAssetType"; +import type { CustomField } from "./models/CustomField"; +import type { CustomFieldDefinition } from "./models/CustomFieldDefinition"; +import type { CustomFieldDefinitionResponse } from "./models/CustomFieldDefinitionResponse"; +import type { CustomFieldDefinitionWithId } from "./models/CustomFieldDefinitionWithId"; +import type { CustomFieldWithId } from "./models/CustomFieldWithId"; +import type { CustomReportCreate } from "./models/CustomReportCreate"; +import type { CustomReportResponse } from "./models/CustomReportResponse"; +import type { Database } from "./models/Database"; +import type { DataCategory } from "./models/DataCategory"; +import type { DataCategoryCreateOrUpdate } from "./models/DataCategoryCreateOrUpdate"; +import { DATAMAP_GROUPING } from "./models/DATAMAP_GROUPING"; +import type { Dataset } from "./models/Dataset"; +import type { DatasetConfigCtlDataset } from "./models/DatasetConfigCtlDataset"; +import type { DatasetConfigSchema } from "./models/DatasetConfigSchema"; +import type { DatasetReachability } from "./models/DatasetReachability"; +import type { DatasetResponse } from "./models/DatasetResponse"; +import type { DatasetTestRequest } from "./models/DatasetTestRequest"; +import type { DatastoreMonitorResourcesDynamicFilters } from "./models/DatastoreMonitorResourcesDynamicFilters"; +import type { DatastoreStagedResource } from "./models/DatastoreStagedResource"; +import type { DatastoreStagedResourceTreeAPIResponse } from "./models/DatastoreStagedResourceTreeAPIResponse"; +import type { DataSubject } from "./models/DataSubject"; +import type { DataSubjectCreateOrUpdate } from "./models/DataSubjectCreateOrUpdate"; +import type { DataUpload } from "./models/DataUpload"; +import type { DataUse } from "./models/DataUse"; +import type { DataUseCreateOrUpdate } from "./models/DataUseCreateOrUpdate"; +import { DBActions } from "./models/DBActions"; +import type { DefaultPolicyConfigRequest } from "./models/DefaultPolicyConfigRequest"; +import type { DefaultPolicyConfigResponse } from "./models/DefaultPolicyConfigResponse"; +import type { DeletedResourcesResponse } from "./models/DeletedResourcesResponse"; +import type { DenyPrivacyRequestSelection } from "./models/DenyPrivacyRequestSelection"; +import { DiffStatus } from "./models/DiffStatus"; +import type { DigestConfigRequest } from "./models/DigestConfigRequest"; +import type { DigestConfigResponse } from "./models/DigestConfigResponse"; +import { DigestType } from "./models/DigestType"; +import type { DrpDataRightsResponse } from "./models/DrpDataRightsResponse"; +import type { DrpPrivacyRequestCreate } from "./models/DrpPrivacyRequestCreate"; +import type { DrpRevokeRequest } from "./models/DrpRevokeRequest"; +import type { DryRunDatasetResponse } from "./models/DryRunDatasetResponse"; +import type { EditableMonitorConfig } from "./models/EditableMonitorConfig"; +import type { Evaluation } from "./models/Evaluation"; +import type { ExecutePromptRequest } from "./models/ExecutePromptRequest"; +import type { ExecutePromptResponse } from "./models/ExecutePromptResponse"; +import { ExecutionLogStatus } from "./models/ExecutionLogStatus"; +import type { ExperienceConfigCreate } from "./models/ExperienceConfigCreate"; +import type { ExperienceConfigDisabledResponse } from "./models/ExperienceConfigDisabledResponse"; +import type { ExperienceConfigDisabledUpdate } from "./models/ExperienceConfigDisabledUpdate"; +import type { ExperienceConfigResponse } from "./models/ExperienceConfigResponse"; +import type { ExperienceConfigUpdate } from "./models/ExperienceConfigUpdate"; +import type { ExperienceTranslation } from "./models/ExperienceTranslation"; +import type { ExternalLoginOTPRequest } from "./models/ExternalLoginOTPRequest"; +import type { ExternalLoginOTPResponse } from "./models/ExternalLoginOTPResponse"; +import type { ExternalLoginVerifyRequest } from "./models/ExternalLoginVerifyRequest"; +import type { ExternalUserCreateRequest } from "./models/ExternalUserCreateRequest"; +import type { fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds } from "./models/fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds"; +import type { fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds } from "./models/fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds"; +import type { fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds } from "./models/fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds"; +import type { fides__api__schemas__policy__Policy } from "./models/fides__api__schemas__policy__Policy"; +import type { fides__api__schemas__redis_cache__Identity } from "./models/fides__api__schemas__redis_cache__Identity"; +import type { FidesDatasetReference } from "./models/FidesDatasetReference"; +import type { fideslang__models__Policy } from "./models/fideslang__models__Policy"; +import type { fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRestrictionResponse } from "./models/fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRestrictionResponse"; +import type { Field } from "./models/Field"; +import { FieldActionType } from "./models/FieldActionType"; +import type { FilteredFieldActionRequest } from "./models/FilteredFieldActionRequest"; +import type { FilteredPrivacyRequestResults } from "./models/FilteredPrivacyRequestResults"; +import type { GenerateRequestPayload } from "./models/GenerateRequestPayload"; +import type { GenerateResponse } from "./models/GenerateResponse"; +import type { GenerateTestDataRequest } from "./models/GenerateTestDataRequest"; +import { GenerateTypes } from "./models/GenerateTypes"; +import type { GetRegistrationStatusResponse } from "./models/GetRegistrationStatusResponse"; +import { GoogleCloudSQLIPType } from "./models/GoogleCloudSQLIPType"; +import type { HealthCheck } from "./models/HealthCheck"; +import type { HTTPValidationError } from "./models/HTTPValidationError"; +import type { IdentityDefinitionCreate } from "./models/IdentityDefinitionCreate"; +import type { IdentityDefinitionEntity } from "./models/IdentityDefinitionEntity"; +import type { IdentityProviderMonitorConfig } from "./models/IdentityProviderMonitorConfig"; +import type { IdentityVerificationConfigResponse } from "./models/IdentityVerificationConfigResponse"; +import { IDPActionType } from "./models/IDPActionType"; +import type { IDPActionValidationErrorResponse } from "./models/IDPActionValidationErrorResponse"; +import type { IDPAllowedActionsResponse } from "./models/IDPAllowedActionsResponse"; +import type { IDPBulkActionResponse } from "./models/IDPBulkActionResponse"; +import type { IDPMonitorBulkSelection } from "./models/IDPMonitorBulkSelection"; +import type { IDPMonitorResourcesDynamicFilters } from "./models/IDPMonitorResourcesDynamicFilters"; +import type { JiraIssueType } from "./models/JiraIssueType"; +import type { JiraOAuthInitiateRequest } from "./models/JiraOAuthInitiateRequest"; +import type { JiraOAuthInitiateResponse } from "./models/JiraOAuthInitiateResponse"; +import type { JiraPreviewRequest } from "./models/JiraPreviewRequest"; +import type { JiraProject } from "./models/JiraProject"; +import type { JiraStatusCategory } from "./models/JiraStatusCategory"; +import type { JiraTicketData } from "./models/JiraTicketData"; +import type { LLMChatRequest } from "./models/LLMChatRequest"; +import type { LLMClassifyRequest } from "./models/LLMClassifyRequest"; +import type { LocationRegulationResponse } from "./models/LocationRegulationResponse"; +import type { LocationRegulationSelections } from "./models/LocationRegulationSelections"; +import type { LogEntry } from "./models/LogEntry"; +import type { ManualFieldCreate } from "./models/ManualFieldCreate"; +import { ManualFieldRequestType } from "./models/ManualFieldRequestType"; +import type { ManualFieldResponse } from "./models/ManualFieldResponse"; +import type { ManualFieldSearchResponse } from "./models/ManualFieldSearchResponse"; +import { ManualFieldStatus } from "./models/ManualFieldStatus"; +import type { ManualFieldUpdate } from "./models/ManualFieldUpdate"; +import type { ManualTaskConfigCreate } from "./models/ManualTaskConfigCreate"; +import type { ManualTaskConfigResponse } from "./models/ManualTaskConfigResponse"; +import type { ManualTaskConfigUpdate } from "./models/ManualTaskConfigUpdate"; +import type { ManualTaskExportRequest } from "./models/ManualTaskExportRequest"; +import type { ManualTaskResponse } from "./models/ManualTaskResponse"; +import type { ManualWebhookData } from "./models/ManualWebhookData"; +import type { MaskingAPIRequest } from "./models/MaskingAPIRequest"; +import type { MaskingAPIResponse } from "./models/MaskingAPIResponse"; +import type { MaskingStrategyDescription } from "./models/MaskingStrategyDescription"; +import { MessagingActionType } from "./models/MessagingActionType"; +import type { MessagingConfigRequest } from "./models/MessagingConfigRequest"; +import type { MessagingConfigRequestBase } from "./models/MessagingConfigRequestBase"; +import type { MessagingConfigResponse } from "./models/MessagingConfigResponse"; +import type { MessagingConfigStatusMessage } from "./models/MessagingConfigStatusMessage"; +import { MessagingMethod } from "./models/MessagingMethod"; +import { MessagingServiceType } from "./models/MessagingServiceType"; +import type { MessagingTemplateDefault } from "./models/MessagingTemplateDefault"; +import type { MessagingTemplateWithPropertiesBodyParams } from "./models/MessagingTemplateWithPropertiesBodyParams"; +import type { MessagingTemplateWithPropertiesDetail } from "./models/MessagingTemplateWithPropertiesDetail"; +import type { MessagingTemplateWithPropertiesPatchBodyParams } from "./models/MessagingTemplateWithPropertiesPatchBodyParams"; +import type { MessagingTestBodyParams } from "./models/MessagingTestBodyParams"; +import type { MonitorActionResponse } from "./models/MonitorActionResponse"; +import type { MonitorConfig } from "./models/MonitorConfig"; +import type { MonitorDeletionImpact } from "./models/MonitorDeletionImpact"; +import type { MonitorExecution } from "./models/MonitorExecution"; +import type { MonitorExecutionRequestResponse } from "./models/MonitorExecutionRequestResponse"; +import type { MonitorStatusResponse } from "./models/MonitorStatusResponse"; +import type { MonitorStewardUserResponse } from "./models/MonitorStewardUserResponse"; +import type { MonitorTaskDetailResponse } from "./models/MonitorTaskDetailResponse"; +import type { MonitorTaskResponse } from "./models/MonitorTaskResponse"; +import { MonitorTaskType } from "./models/MonitorTaskType"; +import { MySQLSSLMode } from "./models/MySQLSSLMode"; +import type { NoticeTranslation } from "./models/NoticeTranslation"; +import type { OAuthConfigSchema } from "./models/OAuthConfigSchema"; +import type { OpenIDProvider } from "./models/OpenIDProvider"; +import type { OpenIDProviderCreate } from "./models/OpenIDProviderCreate"; +import type { OpenIDProviderSimple } from "./models/OpenIDProviderSimple"; +import type { OptionalStagedResourcesRequest } from "./models/OptionalStagedResourcesRequest"; +import type { Organization } from "./models/Organization"; +import type { Page_AssessmentResponse_ } from "./models/Page_AssessmentResponse_"; +import type { Page_AssessmentTaskResponse_ } from "./models/Page_AssessmentTaskResponse_"; +import type { Page_Asset_ } from "./models/Page_Asset_"; +import type { Page_AttachmentResponse_ } from "./models/Page_AttachmentResponse_"; +import type { Page_BasicSystemResponseExtended_ } from "./models/Page_BasicSystemResponseExtended_"; +import type { Page_ClassificationBenchmarkSummary_ } from "./models/Page_ClassificationBenchmarkSummary_"; +import type { Page_ClassifyInstanceResponseValues_ } from "./models/Page_ClassifyInstanceResponseValues_"; +import type { Page_CommentResponse_ } from "./models/Page_CommentResponse_"; +import type { Page_ConnectionConfigurationResponse_ } from "./models/Page_ConnectionConfigurationResponse_"; +import type { Page_ConnectionSystemTypeMap_ } from "./models/Page_ConnectionSystemTypeMap_"; +import type { Page_ConsentBreakdown_ } from "./models/Page_ConsentBreakdown_"; +import type { Page_ConsentReport_ } from "./models/Page_ConsentReport_"; +import type { Page_CustomReportResponse_ } from "./models/Page_CustomReportResponse_"; +import type { Page_CustomReportResponseMinimal_ } from "./models/Page_CustomReportResponseMinimal_"; +import type { Page_DatamapReport_ } from "./models/Page_DatamapReport_"; +import type { Page_Dataset_ } from "./models/Page_Dataset_"; +import type { Page_DatasetConfigSchema_ } from "./models/Page_DatasetConfigSchema_"; +import type { Page_DatasetResponse_ } from "./models/Page_DatasetResponse_"; +import type { Page_DatastoreStagedResourceAPIResponse_ } from "./models/Page_DatastoreStagedResourceAPIResponse_"; +import type { Page_DigestConfigResponse_ } from "./models/Page_DigestConfigResponse_"; +import type { Page_EventAuditResponse_ } from "./models/Page_EventAuditResponse_"; +import type { Page_ExecutionLogDetailResponse_ } from "./models/Page_ExecutionLogDetailResponse_"; +import type { Page_ExperienceConfigListViewResponse_ } from "./models/Page_ExperienceConfigListViewResponse_"; +import type { Page_FieldAccuracyDetail_ } from "./models/Page_FieldAccuracyDetail_"; +import type { Page_Language_ } from "./models/Page_Language_"; +import type { Page_LimitedPrivacyNoticeResponseSchema_ } from "./models/Page_LimitedPrivacyNoticeResponseSchema_"; +import type { Page_ManualTaskConfigResponse_ } from "./models/Page_ManualTaskConfigResponse_"; +import type { Page_ManualTaskResponse_ } from "./models/Page_ManualTaskResponse_"; +import type { Page_MessagingConfigResponse_ } from "./models/Page_MessagingConfigResponse_"; +import type { Page_MessagingTemplateWithPropertiesSummary_ } from "./models/Page_MessagingTemplateWithPropertiesSummary_"; +import type { Page_MonitorConfigStagedResourcesAggregateRecord_ } from "./models/Page_MonitorConfigStagedResourcesAggregateRecord_"; +import type { Page_MonitorExecution_ } from "./models/Page_MonitorExecution_"; +import type { Page_MonitorStatusResponse_ } from "./models/Page_MonitorStatusResponse_"; +import type { Page_MonitorTaskResponse_ } from "./models/Page_MonitorTaskResponse_"; +import type { Page_PolicyResponse_ } from "./models/Page_PolicyResponse_"; +import type { Page_PolicyWebhookResponse_ } from "./models/Page_PolicyWebhookResponse_"; +import type { Page_PreApprovalWebhookResponse_ } from "./models/Page_PreApprovalWebhookResponse_"; +import type { Page_PrivacyExperienceMetaResponse_ } from "./models/Page_PrivacyExperienceMetaResponse_"; +import type { Page_Property_ } from "./models/Page_Property_"; +import type { Page_RuleResponseWithTargets_ } from "./models/Page_RuleResponseWithTargets_"; +import type { Page_RuleTarget_ } from "./models/Page_RuleTarget_"; +import type { Page_SharedMonitorConfig_ } from "./models/Page_SharedMonitorConfig_"; +import type { Page_StagedResourceAPIResponse_ } from "./models/Page_StagedResourceAPIResponse_"; +import type { Page_StorageDestinationResponse_ } from "./models/Page_StorageDestinationResponse_"; +import type { Page_str_ } from "./models/Page_str_"; +import type { Page_SystemHistoryResponse_ } from "./models/Page_SystemHistoryResponse_"; +import type { Page_SystemStagedResourcesAggregateRecord_ } from "./models/Page_SystemStagedResourcesAggregateRecord_"; +import type { Page_SystemSummary_ } from "./models/Page_SystemSummary_"; +import type { Page_SystemWithMonitorKeys_ } from "./models/Page_SystemWithMonitorKeys_"; +import type { Page_TCFConfigurationResponse_ } from "./models/Page_TCFConfigurationResponse_"; +import type { Page_TCFPublisherRestrictionResponse_ } from "./models/Page_TCFPublisherRestrictionResponse_"; +import type { Page_TemplateResponse_ } from "./models/Page_TemplateResponse_"; +import type { Page_Union_PrivacyExperienceResponse__TCFBannerExperienceMinimalResponse__ } from "./models/Page_Union_PrivacyExperienceResponse__TCFBannerExperienceMinimalResponse__"; +import type { Page_Union_PrivacyRequestVerboseResponse__PrivacyRequestResponse__ } from "./models/Page_Union_PrivacyRequestVerboseResponse__PrivacyRequestResponse__"; +import type { Page_UserResponse_ } from "./models/Page_UserResponse_"; +import type { PaginatedResponse_ConsentResponse_ } from "./models/PaginatedResponse_ConsentResponse_"; +import type { PaginationFilterParams } from "./models/PaginationFilterParams"; +import type { Params } from "./models/Params"; +import type { PartialPrivacyCenterConfig } from "./models/PartialPrivacyCenterConfig"; +import { PeriodicIntegrationFrequency } from "./models/PeriodicIntegrationFrequency"; +import type { PlusApplicationConfig } from "./models/PlusApplicationConfig"; +import type { PolicyConditionRequest } from "./models/PolicyConditionRequest"; +import type { PolicyConditionResponse } from "./models/PolicyConditionResponse"; +import type { PolicyResponse } from "./models/PolicyResponse"; +import type { PolicyWebhookCreate } from "./models/PolicyWebhookCreate"; +import type { PolicyWebhookDeleteResponse } from "./models/PolicyWebhookDeleteResponse"; +import type { PolicyWebhookResponse } from "./models/PolicyWebhookResponse"; +import type { PolicyWebhookUpdate } from "./models/PolicyWebhookUpdate"; +import type { PolicyWebhookUpdateResponse } from "./models/PolicyWebhookUpdateResponse"; +import type { PreApprovalWebhookCreate } from "./models/PreApprovalWebhookCreate"; +import type { PreApprovalWebhookResponse } from "./models/PreApprovalWebhookResponse"; +import type { PreApprovalWebhookUpdate } from "./models/PreApprovalWebhookUpdate"; +import type { PreferencesSaved } from "./models/PreferencesSaved"; +import type { PreferencesSavedExtended } from "./models/PreferencesSavedExtended"; +import type { PreVerifiedPrivacyPreferencesRequest } from "./models/PreVerifiedPrivacyPreferencesRequest"; +import type { PrivacyAssessmentConfigDefaults } from "./models/PrivacyAssessmentConfigDefaults"; +import type { PrivacyAssessmentConfigResponse } from "./models/PrivacyAssessmentConfigResponse"; +import type { PrivacyAssessmentConfigUpdate } from "./models/PrivacyAssessmentConfigUpdate"; +import type { PrivacyNoticeCreation } from "./models/PrivacyNoticeCreation"; +import type { PrivacyNoticeDisabledResponse } from "./models/PrivacyNoticeDisabledResponse"; +import type { PrivacyNoticeDisabledUpdate } from "./models/PrivacyNoticeDisabledUpdate"; +import { PrivacyNoticeRegion } from "./models/PrivacyNoticeRegion"; +import type { PrivacyNoticeResponse } from "./models/PrivacyNoticeResponse"; +import type { PrivacyNoticeResponseWithRegions } from "./models/PrivacyNoticeResponseWithRegions"; +import type { PrivacyNoticeUpdate } from "./models/PrivacyNoticeUpdate"; +import type { PrivacyPreferencesRequest } from "./models/PrivacyPreferencesRequest"; +import type { PrivacyPreferenceStats } from "./models/PrivacyPreferenceStats"; +import type { PrivacyRequestAccessResults } from "./models/PrivacyRequestAccessResults"; +import type { PrivacyRequestBulkSelection } from "./models/PrivacyRequestBulkSelection"; +import type { PrivacyRequestCreateExtended } from "./models/PrivacyRequestCreateExtended"; +import type { PrivacyRequestDiagnosticsExportResponse } from "./models/PrivacyRequestDiagnosticsExportResponse"; +import type { PrivacyRequestDRPStatusResponse } from "./models/PrivacyRequestDRPStatusResponse"; +import type { PrivacyRequestFieldsResponse } from "./models/PrivacyRequestFieldsResponse"; +import type { PrivacyRequestFilter } from "./models/PrivacyRequestFilter"; +import type { PrivacyRequestNotificationInfo } from "./models/PrivacyRequestNotificationInfo"; +import type { PrivacyRequestRedactionPatternsRequest } from "./models/PrivacyRequestRedactionPatternsRequest"; +import type { PrivacyRequestRedactionPatternsResponse } from "./models/PrivacyRequestRedactionPatternsResponse"; +import type { PrivacyRequestResponse } from "./models/PrivacyRequestResponse"; +import type { PrivacyRequestResumeFormat } from "./models/PrivacyRequestResumeFormat"; +import { PrivacyRequestStatus } from "./models/PrivacyRequestStatus"; +import type { PrivacyRequestTaskSchema } from "./models/PrivacyRequestTaskSchema"; +import type { PromoteResourcesResponse } from "./models/PromoteResourcesResponse"; +import type { PromoteResponse } from "./models/PromoteResponse"; +import { PromptCategory } from "./models/PromptCategory"; +import type { PromptInfo } from "./models/PromptInfo"; +import { PropagationPolicyKey } from "./models/PropagationPolicyKey"; +import type { Property } from "./models/Property"; +import type { PropertyCreate } from "./models/PropertyCreate"; +import type { PropertyNameResolutionRequest } from "./models/PropertyNameResolutionRequest"; +import type { PropertyNameResolutionResponse } from "./models/PropertyNameResolutionResponse"; +import type { PublicPropertyResponse } from "./models/PublicPropertyResponse"; +import type { PurposesResponse } from "./models/PurposesResponse"; +import type { QuestionnaireStatusResponse } from "./models/QuestionnaireStatusResponse"; +import type { RecalculateConsentResponse } from "./models/RecalculateConsentResponse"; +import type { RecordConsentServedRequest } from "./models/RecordConsentServedRequest"; +import type { RecordsServedResponse } from "./models/RecordsServedResponse"; +import type { Registration } from "./models/Registration"; +import type { RenderPromptRequest } from "./models/RenderPromptRequest"; +import type { RenderPromptResponse } from "./models/RenderPromptResponse"; +import { ReportExportFormat } from "./models/ReportExportFormat"; +import type { RequestTaskCallbackRequest } from "./models/RequestTaskCallbackRequest"; +import type { ResponseWithMessage } from "./models/ResponseWithMessage"; +import type { ResultSetStats } from "./models/ResultSetStats"; +import type { RevertAnswerRequest } from "./models/RevertAnswerRequest"; +import type { RuleCreate } from "./models/RuleCreate"; +import type { RuleResponseWithTargets } from "./models/RuleResponseWithTargets"; +import type { RuleTarget } from "./models/RuleTarget"; +import type { SaaSConfig } from "./models/SaaSConfig"; +import type { SaasConnectionTemplateResponse } from "./models/SaasConnectionTemplateResponse"; +import type { SaasConnectionTemplateValues } from "./models/SaasConnectionTemplateValues"; +import type { SaasConnectionTemplateValuesExtended } from "./models/SaasConnectionTemplateValuesExtended"; +import type { SaaSSchema } from "./models/SaaSSchema"; +import type { Schema } from "./models/Schema"; +import { ScopeRegistryEnum } from "./models/ScopeRegistryEnum"; +import type { SeedRequest } from "./models/SeedRequest"; +import type { SeedResponse } from "./models/SeedResponse"; +import type { SeedStatusResponse } from "./models/SeedStatusResponse"; +import type { SendMessageRequest } from "./models/SendMessageRequest"; +import type { SendMessageResponse } from "./models/SendMessageResponse"; +import type { SendQuestionnaireRequest } from "./models/SendQuestionnaireRequest"; +import type { SendQuestionnaireResponse } from "./models/SendQuestionnaireResponse"; +import type { SendReminderRequest } from "./models/SendReminderRequest"; +import type { SendReminderResponse } from "./models/SendReminderResponse"; +import type { SetSystemLinksRequest } from "./models/SetSystemLinksRequest"; +import type { SharedMonitorConfig } from "./models/SharedMonitorConfig"; +import type { SingleFieldSubmissionResponse } from "./models/SingleFieldSubmissionResponse"; +import type { StagedResource } from "./models/StagedResource"; +import type { StagedResourceAPIResponse } from "./models/StagedResourceAPIResponse"; +import type { StagedResourceUpdateRequest } from "./models/StagedResourceUpdateRequest"; +import type { StorageConfigStatusMessage } from "./models/StorageConfigStatusMessage"; +import type { StorageDestination } from "./models/StorageDestination"; +import type { StorageDestinationBase } from "./models/StorageDestinationBase"; +import type { StorageDestinationResponse } from "./models/StorageDestinationResponse"; +import { StorageType } from "./models/StorageType"; +import type { System } from "./models/System"; +import type { SystemGroup } from "./models/SystemGroup"; +import type { SystemGroupCreate } from "./models/SystemGroupCreate"; +import type { SystemGroupUpdate } from "./models/SystemGroupUpdate"; +import type { SystemLinkResponse } from "./models/SystemLinkResponse"; +import type { SystemPurposeSummary } from "./models/SystemPurposeSummary"; +import type { SystemResponse } from "./models/SystemResponse"; +import type { SystemResponseExtended } from "./models/SystemResponseExtended"; +import type { SystemScanHistory } from "./models/SystemScanHistory"; +import type { SystemScanResponse } from "./models/SystemScanResponse"; +import type { SystemSchemaExtended } from "./models/SystemSchemaExtended"; +import type { SystemsDiff } from "./models/SystemsDiff"; +import { SystemType } from "./models/SystemType"; +import type { Table } from "./models/Table"; +import type { TaxonomyCreate } from "./models/TaxonomyCreate"; +import type { TaxonomyElement } from "./models/TaxonomyElement"; +import type { TaxonomyElementCreate } from "./models/TaxonomyElementCreate"; +import type { TaxonomyElementUpdate } from "./models/TaxonomyElementUpdate"; +import type { TaxonomyResponse } from "./models/TaxonomyResponse"; +import type { TaxonomyUpdate } from "./models/TaxonomyUpdate"; +import type { TCDecode } from "./models/TCDecode"; +import type { TCFConfigurationDetail } from "./models/TCFConfigurationDetail"; +import type { TCFConfigurationRequest } from "./models/TCFConfigurationRequest"; +import type { TCFConfigurationResponse } from "./models/TCFConfigurationResponse"; +import type { TCFPublisherRestrictionRequest } from "./models/TCFPublisherRestrictionRequest"; +import type { TCFPublisherRestrictionUpdateRequest } from "./models/TCFPublisherRestrictionUpdateRequest"; +import type { TCFPurposeOverrideSchema } from "./models/TCFPurposeOverrideSchema"; +import type { TemplateVariable } from "./models/TemplateVariable"; +import type { TestMessagingStatusMessage } from "./models/TestMessagingStatusMessage"; +import type { TestPrivacyRequest } from "./models/TestPrivacyRequest"; +import { TestStatus } from "./models/TestStatus"; +import type { TestStatusMessage } from "./models/TestStatusMessage"; +import type { TimeBasedPartitioning } from "./models/TimeBasedPartitioning"; +import { TimeInclusivity } from "./models/TimeInclusivity"; +import type { ToneResponse } from "./models/ToneResponse"; +import type { ToneUpdate } from "./models/ToneUpdate"; +import type { UnverifiedPrivacyPreferencesRequest } from "./models/UnverifiedPrivacyPreferencesRequest"; +import type { UpdateAnswerRequest } from "./models/UpdateAnswerRequest"; +import type { UpdateMonitorStewardsRequest } from "./models/UpdateMonitorStewardsRequest"; +import type { UserCreateExtended } from "./models/UserCreateExtended"; +import type { UserCreateResponse } from "./models/UserCreateResponse"; +import type { UserEmailInviteStatus } from "./models/UserEmailInviteStatus"; +import type { UserForcePasswordReset } from "./models/UserForcePasswordReset"; +import type { UserLogin } from "./models/UserLogin"; +import type { UserLoginResponse } from "./models/UserLoginResponse"; +import type { UserPasswordReset } from "./models/UserPasswordReset"; +import type { UserPermissionsCreate } from "./models/UserPermissionsCreate"; +import type { UserPermissionsEdit } from "./models/UserPermissionsEdit"; +import type { UserPermissionsPlusResponse } from "./models/UserPermissionsPlusResponse"; +import type { UserResponse } from "./models/UserResponse"; +import type { UserResponseExtended } from "./models/UserResponseExtended"; +import type { UserUpdate } from "./models/UserUpdate"; +import type { ValidateDatasetResponse } from "./models/ValidateDatasetResponse"; +import type { ValidateRequest } from "./models/ValidateRequest"; +import type { ValidateResponse } from "./models/ValidateResponse"; +import type { ValidateSaaSConfigResponse } from "./models/ValidateSaaSConfigResponse"; +import type { ValidationErrorResponse } from "./models/ValidationErrorResponse"; +import type { ValuesList } from "./models/ValuesList"; +import type { VendorIds } from "./models/VendorIds"; +import type { VerificationCode } from "./models/VerificationCode"; +import type { WebsiteClassificationReport } from "./models/WebsiteClassificationReport"; +import type { WebsiteMonitorResourcesFilters } from "./models/WebsiteMonitorResourcesFilters"; +import type { WebsiteSchema } from "./models/WebsiteSchema"; +import type { WorkerStats } from "./models/WorkerStats"; + +export type listApiV1DataCategoryGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/data_category"; +}; + +export type listApiV1DataCategoryGetResponses = { + /** + * Response List Api V1 Data Category Get + * + * Successful Response + */ + 200: Array; +}; + +export type listApiV1DataCategoryGetResponse = + listApiV1DataCategoryGetResponses[keyof listApiV1DataCategoryGetResponses]; + +export type createApiV1DataCategoryPostData = { + body: DataCategoryCreateOrUpdate; + path?: never; + query?: never; + url: "/api/v1/data_category"; +}; + +export type createApiV1DataCategoryPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createApiV1DataCategoryPostError = + createApiV1DataCategoryPostErrors[keyof createApiV1DataCategoryPostErrors]; + +export type createApiV1DataCategoryPostResponses = { + /** + * Successful Response + */ + 201: DataCategory; +}; + +export type createApiV1DataCategoryPostResponse = + createApiV1DataCategoryPostResponses[keyof createApiV1DataCategoryPostResponses]; + +export type updateApiV1DataCategoryPutData = { + body: DataCategoryCreateOrUpdate; + path?: never; + query?: never; + url: "/api/v1/data_category"; +}; + +export type updateApiV1DataCategoryPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateApiV1DataCategoryPutError = + updateApiV1DataCategoryPutErrors[keyof updateApiV1DataCategoryPutErrors]; + +export type updateApiV1DataCategoryPutResponses = { + /** + * Successful Response + */ + 200: DataCategory; +}; + +export type updateApiV1DataCategoryPutResponse = + updateApiV1DataCategoryPutResponses[keyof updateApiV1DataCategoryPutResponses]; + +export type deleteApiV1DataCategoryFidesKeyDeleteData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/data_category/{fides_key}"; +}; + +export type deleteApiV1DataCategoryFidesKeyDeleteErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteApiV1DataCategoryFidesKeyDeleteError = + deleteApiV1DataCategoryFidesKeyDeleteErrors[keyof deleteApiV1DataCategoryFidesKeyDeleteErrors]; + +export type deleteApiV1DataCategoryFidesKeyDeleteResponses = { + /** + * Response Delete Api V1 Data Category Fides Key Delete + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type deleteApiV1DataCategoryFidesKeyDeleteResponse = + deleteApiV1DataCategoryFidesKeyDeleteResponses[keyof deleteApiV1DataCategoryFidesKeyDeleteResponses]; + +export type getApiV1DataCategoryFidesKeyGetData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/data_category/{fides_key}"; +}; + +export type getApiV1DataCategoryFidesKeyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getApiV1DataCategoryFidesKeyGetError = + getApiV1DataCategoryFidesKeyGetErrors[keyof getApiV1DataCategoryFidesKeyGetErrors]; + +export type getApiV1DataCategoryFidesKeyGetResponses = { + /** + * Successful Response + */ + 200: DataCategory; +}; + +export type getApiV1DataCategoryFidesKeyGetResponse = + getApiV1DataCategoryFidesKeyGetResponses[keyof getApiV1DataCategoryFidesKeyGetResponses]; + +export type upsertApiV1DataCategoryUpsertPostData = { + /** + * Resources + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/data_category/upsert"; +}; + +export type upsertApiV1DataCategoryUpsertPostErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type upsertApiV1DataCategoryUpsertPostError = + upsertApiV1DataCategoryUpsertPostErrors[keyof upsertApiV1DataCategoryUpsertPostErrors]; + +export type upsertApiV1DataCategoryUpsertPostResponses = { + /** + * Response Upsert Api V1 Data Category Upsert Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; + /** + * Created + */ + 201: unknown; +}; + +export type upsertApiV1DataCategoryUpsertPostResponse = + upsertApiV1DataCategoryUpsertPostResponses[keyof upsertApiV1DataCategoryUpsertPostResponses]; + +export type listApiV1DataSubjectGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/data_subject"; +}; + +export type listApiV1DataSubjectGetResponses = { + /** + * Response List Api V1 Data Subject Get + * + * Successful Response + */ + 200: Array; +}; + +export type listApiV1DataSubjectGetResponse = + listApiV1DataSubjectGetResponses[keyof listApiV1DataSubjectGetResponses]; + +export type createApiV1DataSubjectPostData = { + body: DataSubjectCreateOrUpdate; + path?: never; + query?: never; + url: "/api/v1/data_subject"; +}; + +export type createApiV1DataSubjectPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createApiV1DataSubjectPostError = + createApiV1DataSubjectPostErrors[keyof createApiV1DataSubjectPostErrors]; + +export type createApiV1DataSubjectPostResponses = { + /** + * Successful Response + */ + 201: DataSubject; +}; + +export type createApiV1DataSubjectPostResponse = + createApiV1DataSubjectPostResponses[keyof createApiV1DataSubjectPostResponses]; + +export type updateApiV1DataSubjectPutData = { + body: DataSubject; + path?: never; + query?: never; + url: "/api/v1/data_subject"; +}; + +export type updateApiV1DataSubjectPutErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateApiV1DataSubjectPutError = + updateApiV1DataSubjectPutErrors[keyof updateApiV1DataSubjectPutErrors]; + +export type updateApiV1DataSubjectPutResponses = { + /** + * Successful Response + */ + 200: DataSubject; +}; + +export type updateApiV1DataSubjectPutResponse = + updateApiV1DataSubjectPutResponses[keyof updateApiV1DataSubjectPutResponses]; + +export type deleteApiV1DataSubjectFidesKeyDeleteData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/data_subject/{fides_key}"; +}; + +export type deleteApiV1DataSubjectFidesKeyDeleteErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteApiV1DataSubjectFidesKeyDeleteError = + deleteApiV1DataSubjectFidesKeyDeleteErrors[keyof deleteApiV1DataSubjectFidesKeyDeleteErrors]; + +export type deleteApiV1DataSubjectFidesKeyDeleteResponses = { + /** + * Response Delete Api V1 Data Subject Fides Key Delete + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type deleteApiV1DataSubjectFidesKeyDeleteResponse = + deleteApiV1DataSubjectFidesKeyDeleteResponses[keyof deleteApiV1DataSubjectFidesKeyDeleteResponses]; + +export type getApiV1DataSubjectFidesKeyGetData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/data_subject/{fides_key}"; +}; + +export type getApiV1DataSubjectFidesKeyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getApiV1DataSubjectFidesKeyGetError = + getApiV1DataSubjectFidesKeyGetErrors[keyof getApiV1DataSubjectFidesKeyGetErrors]; + +export type getApiV1DataSubjectFidesKeyGetResponses = { + /** + * Successful Response + */ + 200: DataSubject; +}; + +export type getApiV1DataSubjectFidesKeyGetResponse = + getApiV1DataSubjectFidesKeyGetResponses[keyof getApiV1DataSubjectFidesKeyGetResponses]; + +export type upsertApiV1DataSubjectUpsertPostData = { + /** + * Resources + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/data_subject/upsert"; +}; + +export type upsertApiV1DataSubjectUpsertPostErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type upsertApiV1DataSubjectUpsertPostError = + upsertApiV1DataSubjectUpsertPostErrors[keyof upsertApiV1DataSubjectUpsertPostErrors]; + +export type upsertApiV1DataSubjectUpsertPostResponses = { + /** + * Response Upsert Api V1 Data Subject Upsert Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; + /** + * Created + */ + 201: unknown; +}; + +export type upsertApiV1DataSubjectUpsertPostResponse = + upsertApiV1DataSubjectUpsertPostResponses[keyof upsertApiV1DataSubjectUpsertPostResponses]; + +export type listApiV1DataUseGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/data_use"; +}; + +export type listApiV1DataUseGetResponses = { + /** + * Response List Api V1 Data Use Get + * + * Successful Response + */ + 200: Array; +}; + +export type listApiV1DataUseGetResponse = + listApiV1DataUseGetResponses[keyof listApiV1DataUseGetResponses]; + +export type createApiV1DataUsePostData = { + body: DataUseCreateOrUpdate; + path?: never; + query?: never; + url: "/api/v1/data_use"; +}; + +export type createApiV1DataUsePostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createApiV1DataUsePostError = + createApiV1DataUsePostErrors[keyof createApiV1DataUsePostErrors]; + +export type createApiV1DataUsePostResponses = { + /** + * Successful Response + */ + 201: DataUse; +}; + +export type createApiV1DataUsePostResponse = + createApiV1DataUsePostResponses[keyof createApiV1DataUsePostResponses]; + +export type updateApiV1DataUsePutData = { + body: DataUseCreateOrUpdate; + path?: never; + query?: never; + url: "/api/v1/data_use"; +}; + +export type updateApiV1DataUsePutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateApiV1DataUsePutError = + updateApiV1DataUsePutErrors[keyof updateApiV1DataUsePutErrors]; + +export type updateApiV1DataUsePutResponses = { + /** + * Successful Response + */ + 200: DataUse; +}; + +export type updateApiV1DataUsePutResponse = + updateApiV1DataUsePutResponses[keyof updateApiV1DataUsePutResponses]; + +export type deleteApiV1DataUseFidesKeyDeleteData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/data_use/{fides_key}"; +}; + +export type deleteApiV1DataUseFidesKeyDeleteErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteApiV1DataUseFidesKeyDeleteError = + deleteApiV1DataUseFidesKeyDeleteErrors[keyof deleteApiV1DataUseFidesKeyDeleteErrors]; + +export type deleteApiV1DataUseFidesKeyDeleteResponses = { + /** + * Response Delete Api V1 Data Use Fides Key Delete + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type deleteApiV1DataUseFidesKeyDeleteResponse = + deleteApiV1DataUseFidesKeyDeleteResponses[keyof deleteApiV1DataUseFidesKeyDeleteResponses]; + +export type getApiV1DataUseFidesKeyGetData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/data_use/{fides_key}"; +}; + +export type getApiV1DataUseFidesKeyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getApiV1DataUseFidesKeyGetError = + getApiV1DataUseFidesKeyGetErrors[keyof getApiV1DataUseFidesKeyGetErrors]; + +export type getApiV1DataUseFidesKeyGetResponses = { + /** + * Successful Response + */ + 200: DataUse; +}; + +export type getApiV1DataUseFidesKeyGetResponse = + getApiV1DataUseFidesKeyGetResponses[keyof getApiV1DataUseFidesKeyGetResponses]; + +export type upsertApiV1DataUseUpsertPostData = { + /** + * Resources + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/data_use/upsert"; +}; + +export type upsertApiV1DataUseUpsertPostErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type upsertApiV1DataUseUpsertPostError = + upsertApiV1DataUseUpsertPostErrors[keyof upsertApiV1DataUseUpsertPostErrors]; + +export type upsertApiV1DataUseUpsertPostResponses = { + /** + * Response Upsert Api V1 Data Use Upsert Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; + /** + * Created + */ + 201: unknown; +}; + +export type upsertApiV1DataUseUpsertPostResponse = + upsertApiV1DataUseUpsertPostResponses[keyof upsertApiV1DataUseUpsertPostResponses]; + +export type listApiV1EvaluationGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/evaluation"; +}; + +export type listApiV1EvaluationGetResponses = { + /** + * Response List Api V1 Evaluation Get + * + * Successful Response + */ + 200: Array; +}; + +export type listApiV1EvaluationGetResponse = + listApiV1EvaluationGetResponses[keyof listApiV1EvaluationGetResponses]; + +export type createApiV1EvaluationPostData = { + body: Evaluation; + path?: never; + query?: never; + url: "/api/v1/evaluation"; +}; + +export type createApiV1EvaluationPostErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createApiV1EvaluationPostError = + createApiV1EvaluationPostErrors[keyof createApiV1EvaluationPostErrors]; + +export type createApiV1EvaluationPostResponses = { + /** + * Successful Response + */ + 201: Evaluation; +}; + +export type createApiV1EvaluationPostResponse = + createApiV1EvaluationPostResponses[keyof createApiV1EvaluationPostResponses]; + +export type updateApiV1EvaluationPutData = { + body: Evaluation; + path?: never; + query?: never; + url: "/api/v1/evaluation"; +}; + +export type updateApiV1EvaluationPutErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateApiV1EvaluationPutError = + updateApiV1EvaluationPutErrors[keyof updateApiV1EvaluationPutErrors]; + +export type updateApiV1EvaluationPutResponses = { + /** + * Successful Response + */ + 200: Evaluation; +}; + +export type updateApiV1EvaluationPutResponse = + updateApiV1EvaluationPutResponses[keyof updateApiV1EvaluationPutResponses]; + +export type deleteApiV1EvaluationFidesKeyDeleteData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/evaluation/{fides_key}"; +}; + +export type deleteApiV1EvaluationFidesKeyDeleteErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteApiV1EvaluationFidesKeyDeleteError = + deleteApiV1EvaluationFidesKeyDeleteErrors[keyof deleteApiV1EvaluationFidesKeyDeleteErrors]; + +export type deleteApiV1EvaluationFidesKeyDeleteResponses = { + /** + * Response Delete Api V1 Evaluation Fides Key Delete + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type deleteApiV1EvaluationFidesKeyDeleteResponse = + deleteApiV1EvaluationFidesKeyDeleteResponses[keyof deleteApiV1EvaluationFidesKeyDeleteResponses]; + +export type getApiV1EvaluationFidesKeyGetData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/evaluation/{fides_key}"; +}; + +export type getApiV1EvaluationFidesKeyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getApiV1EvaluationFidesKeyGetError = + getApiV1EvaluationFidesKeyGetErrors[keyof getApiV1EvaluationFidesKeyGetErrors]; + +export type getApiV1EvaluationFidesKeyGetResponses = { + /** + * Successful Response + */ + 200: Evaluation; +}; + +export type getApiV1EvaluationFidesKeyGetResponse = + getApiV1EvaluationFidesKeyGetResponses[keyof getApiV1EvaluationFidesKeyGetResponses]; + +export type upsertApiV1EvaluationUpsertPostData = { + /** + * Resources + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/evaluation/upsert"; +}; + +export type upsertApiV1EvaluationUpsertPostErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type upsertApiV1EvaluationUpsertPostError = + upsertApiV1EvaluationUpsertPostErrors[keyof upsertApiV1EvaluationUpsertPostErrors]; + +export type upsertApiV1EvaluationUpsertPostResponses = { + /** + * Response Upsert Api V1 Evaluation Upsert Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; + /** + * Created + */ + 201: unknown; +}; + +export type upsertApiV1EvaluationUpsertPostResponse = + upsertApiV1EvaluationUpsertPostResponses[keyof upsertApiV1EvaluationUpsertPostResponses]; + +export type generateApiV1GeneratePostData = { + body: GenerateRequestPayload; + path?: never; + query?: never; + url: "/api/v1/generate"; +}; + +export type generateApiV1GeneratePostErrors = { + /** + * Bad Request + */ + 400: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type generateApiV1GeneratePostError = + generateApiV1GeneratePostErrors[keyof generateApiV1GeneratePostErrors]; + +export type generateApiV1GeneratePostResponses = { + /** + * Successful Response + */ + 200: GenerateResponse; +}; + +export type generateApiV1GeneratePostResponse = + generateApiV1GeneratePostResponses[keyof generateApiV1GeneratePostResponses]; + +export type listApiV1OrganizationGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/organization"; +}; + +export type listApiV1OrganizationGetResponses = { + /** + * Response List Api V1 Organization Get + * + * Successful Response + */ + 200: Array; +}; + +export type listApiV1OrganizationGetResponse = + listApiV1OrganizationGetResponses[keyof listApiV1OrganizationGetResponses]; + +export type createApiV1OrganizationPostData = { + body: Organization; + path?: never; + query?: never; + url: "/api/v1/organization"; +}; + +export type createApiV1OrganizationPostErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createApiV1OrganizationPostError = + createApiV1OrganizationPostErrors[keyof createApiV1OrganizationPostErrors]; + +export type createApiV1OrganizationPostResponses = { + /** + * Successful Response + */ + 201: Organization; +}; + +export type createApiV1OrganizationPostResponse = + createApiV1OrganizationPostResponses[keyof createApiV1OrganizationPostResponses]; + +export type updateApiV1OrganizationPutData = { + body: Organization; + path?: never; + query?: never; + url: "/api/v1/organization"; +}; + +export type updateApiV1OrganizationPutErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateApiV1OrganizationPutError = + updateApiV1OrganizationPutErrors[keyof updateApiV1OrganizationPutErrors]; + +export type updateApiV1OrganizationPutResponses = { + /** + * Successful Response + */ + 200: Organization; +}; + +export type updateApiV1OrganizationPutResponse = + updateApiV1OrganizationPutResponses[keyof updateApiV1OrganizationPutResponses]; + +export type deleteApiV1OrganizationFidesKeyDeleteData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/organization/{fides_key}"; +}; + +export type deleteApiV1OrganizationFidesKeyDeleteErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteApiV1OrganizationFidesKeyDeleteError = + deleteApiV1OrganizationFidesKeyDeleteErrors[keyof deleteApiV1OrganizationFidesKeyDeleteErrors]; + +export type deleteApiV1OrganizationFidesKeyDeleteResponses = { + /** + * Response Delete Api V1 Organization Fides Key Delete + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type deleteApiV1OrganizationFidesKeyDeleteResponse = + deleteApiV1OrganizationFidesKeyDeleteResponses[keyof deleteApiV1OrganizationFidesKeyDeleteResponses]; + +export type getApiV1OrganizationFidesKeyGetData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/organization/{fides_key}"; +}; + +export type getApiV1OrganizationFidesKeyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getApiV1OrganizationFidesKeyGetError = + getApiV1OrganizationFidesKeyGetErrors[keyof getApiV1OrganizationFidesKeyGetErrors]; + +export type getApiV1OrganizationFidesKeyGetResponses = { + /** + * Successful Response + */ + 200: Organization; +}; + +export type getApiV1OrganizationFidesKeyGetResponse = + getApiV1OrganizationFidesKeyGetResponses[keyof getApiV1OrganizationFidesKeyGetResponses]; + +export type upsertApiV1OrganizationUpsertPostData = { + /** + * Resources + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/organization/upsert"; +}; + +export type upsertApiV1OrganizationUpsertPostErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type upsertApiV1OrganizationUpsertPostError = + upsertApiV1OrganizationUpsertPostErrors[keyof upsertApiV1OrganizationUpsertPostErrors]; + +export type upsertApiV1OrganizationUpsertPostResponses = { + /** + * Response Upsert Api V1 Organization Upsert Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; + /** + * Created + */ + 201: unknown; +}; + +export type upsertApiV1OrganizationUpsertPostResponse = + upsertApiV1OrganizationUpsertPostResponses[keyof upsertApiV1OrganizationUpsertPostResponses]; + +export type listApiV1PolicyGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/policy"; +}; + +export type listApiV1PolicyGetResponses = { + /** + * Response List Api V1 Policy Get + * + * Successful Response + */ + 200: Array; +}; + +export type listApiV1PolicyGetResponse = + listApiV1PolicyGetResponses[keyof listApiV1PolicyGetResponses]; + +export type createApiV1PolicyPostData = { + body: fideslang__models__Policy; + path?: never; + query?: never; + url: "/api/v1/policy"; +}; + +export type createApiV1PolicyPostErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createApiV1PolicyPostError = + createApiV1PolicyPostErrors[keyof createApiV1PolicyPostErrors]; + +export type createApiV1PolicyPostResponses = { + /** + * Successful Response + */ + 201: fideslang__models__Policy; +}; + +export type createApiV1PolicyPostResponse = + createApiV1PolicyPostResponses[keyof createApiV1PolicyPostResponses]; + +export type updateApiV1PolicyPutData = { + body: fideslang__models__Policy; + path?: never; + query?: never; + url: "/api/v1/policy"; +}; + +export type updateApiV1PolicyPutErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateApiV1PolicyPutError = + updateApiV1PolicyPutErrors[keyof updateApiV1PolicyPutErrors]; + +export type updateApiV1PolicyPutResponses = { + /** + * Successful Response + */ + 200: fideslang__models__Policy; +}; + +export type updateApiV1PolicyPutResponse = + updateApiV1PolicyPutResponses[keyof updateApiV1PolicyPutResponses]; + +export type deleteApiV1PolicyFidesKeyDeleteData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/policy/{fides_key}"; +}; + +export type deleteApiV1PolicyFidesKeyDeleteErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteApiV1PolicyFidesKeyDeleteError = + deleteApiV1PolicyFidesKeyDeleteErrors[keyof deleteApiV1PolicyFidesKeyDeleteErrors]; + +export type deleteApiV1PolicyFidesKeyDeleteResponses = { + /** + * Response Delete Api V1 Policy Fides Key Delete + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type deleteApiV1PolicyFidesKeyDeleteResponse = + deleteApiV1PolicyFidesKeyDeleteResponses[keyof deleteApiV1PolicyFidesKeyDeleteResponses]; + +export type getApiV1PolicyFidesKeyGetData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/policy/{fides_key}"; +}; + +export type getApiV1PolicyFidesKeyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getApiV1PolicyFidesKeyGetError = + getApiV1PolicyFidesKeyGetErrors[keyof getApiV1PolicyFidesKeyGetErrors]; + +export type getApiV1PolicyFidesKeyGetResponses = { + /** + * Successful Response + */ + 200: fideslang__models__Policy; +}; + +export type getApiV1PolicyFidesKeyGetResponse = + getApiV1PolicyFidesKeyGetResponses[keyof getApiV1PolicyFidesKeyGetResponses]; + +export type upsertApiV1PolicyUpsertPostData = { + /** + * Resources + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/policy/upsert"; +}; + +export type upsertApiV1PolicyUpsertPostErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type upsertApiV1PolicyUpsertPostError = + upsertApiV1PolicyUpsertPostErrors[keyof upsertApiV1PolicyUpsertPostErrors]; + +export type upsertApiV1PolicyUpsertPostResponses = { + /** + * Response Upsert Api V1 Policy Upsert Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; + /** + * Created + */ + 201: unknown; +}; + +export type upsertApiV1PolicyUpsertPostResponse = + upsertApiV1PolicyUpsertPostResponses[keyof upsertApiV1PolicyUpsertPostResponses]; + +export type instantiateConnectionFromTemplateApiV1SystemFidesKeyConnectionInstantiateConnectorTemplateTypePostData = + { + body: SaasConnectionTemplateValues; + path: { + /** + * Fides Key + */ + fides_key: string; + /** + * Connector Template Type + */ + connector_template_type: string; + }; + query?: never; + url: "/api/v1/system/{fides_key}/connection/instantiate/{connector_template_type}"; + }; + +export type instantiateConnectionFromTemplateApiV1SystemFidesKeyConnectionInstantiateConnectorTemplateTypePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type instantiateConnectionFromTemplateApiV1SystemFidesKeyConnectionInstantiateConnectorTemplateTypePostError = + instantiateConnectionFromTemplateApiV1SystemFidesKeyConnectionInstantiateConnectorTemplateTypePostErrors[keyof instantiateConnectionFromTemplateApiV1SystemFidesKeyConnectionInstantiateConnectorTemplateTypePostErrors]; + +export type instantiateConnectionFromTemplateApiV1SystemFidesKeyConnectionInstantiateConnectorTemplateTypePostResponses = + { + /** + * Successful Response + */ + 200: SaasConnectionTemplateResponse; + }; + +export type instantiateConnectionFromTemplateApiV1SystemFidesKeyConnectionInstantiateConnectorTemplateTypePostResponse = + instantiateConnectionFromTemplateApiV1SystemFidesKeyConnectionInstantiateConnectorTemplateTypePostResponses[keyof instantiateConnectionFromTemplateApiV1SystemFidesKeyConnectionInstantiateConnectorTemplateTypePostResponses]; + +export type deleteConnectionApiV1SystemFidesKeyConnectionDeleteData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/system/{fides_key}/connection"; +}; + +export type deleteConnectionApiV1SystemFidesKeyConnectionDeleteErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteConnectionApiV1SystemFidesKeyConnectionDeleteError = + deleteConnectionApiV1SystemFidesKeyConnectionDeleteErrors[keyof deleteConnectionApiV1SystemFidesKeyConnectionDeleteErrors]; + +export type deleteConnectionApiV1SystemFidesKeyConnectionDeleteResponses = { + /** + * Successful Response + */ + 204: void; +}; + +export type deleteConnectionApiV1SystemFidesKeyConnectionDeleteResponse = + deleteConnectionApiV1SystemFidesKeyConnectionDeleteResponses[keyof deleteConnectionApiV1SystemFidesKeyConnectionDeleteResponses]; + +export type getSystemConnectionsApiV1SystemFidesKeyConnectionGetData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/system/{fides_key}/connection"; +}; + +export type getSystemConnectionsApiV1SystemFidesKeyConnectionGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getSystemConnectionsApiV1SystemFidesKeyConnectionGetError = + getSystemConnectionsApiV1SystemFidesKeyConnectionGetErrors[keyof getSystemConnectionsApiV1SystemFidesKeyConnectionGetErrors]; + +export type getSystemConnectionsApiV1SystemFidesKeyConnectionGetResponses = { + /** + * Successful Response + */ + 200: Page_ConnectionConfigurationResponse_; +}; + +export type getSystemConnectionsApiV1SystemFidesKeyConnectionGetResponse = + getSystemConnectionsApiV1SystemFidesKeyConnectionGetResponses[keyof getSystemConnectionsApiV1SystemFidesKeyConnectionGetResponses]; + +export type patchConnectionsApiV1SystemFidesKeyConnectionPatchData = { + /** + * Configs + */ + body: Array; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/system/{fides_key}/connection"; +}; + +export type patchConnectionsApiV1SystemFidesKeyConnectionPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type patchConnectionsApiV1SystemFidesKeyConnectionPatchError = + patchConnectionsApiV1SystemFidesKeyConnectionPatchErrors[keyof patchConnectionsApiV1SystemFidesKeyConnectionPatchErrors]; + +export type patchConnectionsApiV1SystemFidesKeyConnectionPatchResponses = { + /** + * Successful Response + */ + 200: BulkPutConnectionConfiguration; +}; + +export type patchConnectionsApiV1SystemFidesKeyConnectionPatchResponse = + patchConnectionsApiV1SystemFidesKeyConnectionPatchResponses[keyof patchConnectionsApiV1SystemFidesKeyConnectionPatchResponses]; + +export type patchConnectionSecretsApiV1SystemFidesKeyConnectionSecretsPatchData = + { + /** + * Unvalidated Secrets + */ + body: + | { + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds; + /** + * Dataset + * + * Only provide a dataset to scope discovery monitors and privacy request automation to a specific BigQuery dataset. In most cases, this can be left blank. + */ + dataset?: string | null; + } + | { + /** + * DataHub server URL + * + * The URL of your DataHub server. + */ + datahub_server_url: string; + /** + * DataHub token + * + * The token used to authenticate with your DataHub server. + */ + datahub_token: string; + /** + * Frequency + * + * The frequency at which the integration should run. Available options are daily, weekly, monthly, and not scheduled. + */ + frequency: PeriodicIntegrationFrequency; + /** + * Glossary node + * + * The glossary node name to use on Datahub for Fides Data Categories. (e.g. FidesDataCategories) + */ + glossary_node: string; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettings; + /** + * Third party vendor name field + * + * Dataset reference to the field containing the third party vendor name. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. + */ + third_party_vendor_name: FidesDatasetReference; + /** + * Recipient email address field + * + * Dataset reference to the field containing the recipient email address. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. + */ + recipient_email_address: FidesDatasetReference; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * Region + * + * The AWS region where your DynamoDB table is located (ex. us-west-2). + */ + region_name: string; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettings; + /** + * Third Party Vendor Name + */ + third_party_vendor_name: string; + /** + * Recipient Email Address + */ + recipient_email_address: string; + } + | { + /** + * Uri + */ + uri: string; + /** + * Username + */ + username: string; + /** + * Password + */ + password: string; + /** + * Polling Timeout + */ + polling_timeout?: number | null; + /** + * Polling Interval + */ + polling_interval?: number | null; + } + | { + /** + * DB IAM user + * + * example: service-account@test.iam.gserviceaccount.com + */ + db_iam_user: string; + /** + * Instance connection name + * + * example: friendly-tower-424214-n8:us-central1:test-ethyca + */ + instance_connection_name: string; + /** + * Database name + */ + dbname: string; + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds; + /** + * IP type + * + * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview + */ + ip_type?: GoogleCloudSQLIPType | null; + } + | { + /** + * DB IAM user + * + * example: service-account@test.iam.gserviceaccount.com + */ + db_iam_user: string; + /** + * Instance connection name + * + * example: friendly-tower-424214-n8:us-central1:test-ethyca + */ + instance_connection_name: string; + /** + * Database name + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds; + /** + * IP type + * + * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview + */ + ip_type?: GoogleCloudSQLIPType | null; + } + | { + /** + * Access Token + */ + access_token?: string | null; + /** + * Refresh Token + */ + refresh_token?: string | null; + /** + * Token Expiry + */ + token_expiry?: string | null; + /** + * Cloud Id + */ + cloud_id?: string | null; + /** + * Site Url + */ + site_url?: string | null; + } + | { + [key: string]: unknown; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 3306). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 27017). Port will be ignored if using SRV. + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Default auth DB + * + * Used to specify the default authentication database. + */ + defaultauthdb: string; + /** + * Use SRV + * + * Enable SRV record lookup for service discovery (mongodb+srv://). Required for MongoDB Atlas. Enables SSL by default. + */ + use_srv?: boolean | null; + /** + * SSL enabled + * + * Enable SSL/TLS encryption. With SRV: defaults to enabled (can override). Without SRV: defaults to disabled. + */ + ssl_enabled?: boolean | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 1433). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Read Only Connection + * + * Whether to connect to the database in read-only mode. + */ + read_only_connection?: boolean | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 3306). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname: string; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your MySQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * SSL Mode + * + * The SSL mode to use for the connection. Accepted values are: 'required', 'preferred', 'disabled', or an empty value. + */ + ssl_mode?: MySQLSSLMode | null; + } + | { + /** + * Organization URL + * + * The URL of your Okta organization (e.g. https://your-org.okta.com) + */ + org_url: string; + /** + * OAuth2 Client ID + * + * The OAuth2 client ID from your Okta service application + */ + client_id: string; + /** + * Private Key + * + * RSA private key in JWK (JSON) format for signing JWT assertions. Download from Okta: Applications > Your App > Sign On > Client Credentials > Edit > Generate new key. + */ + private_key: string; + /** + * OAuth2 Scopes + * + * OAuth2 scopes to request (default: okta.apps.read) + */ + scopes?: Array | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5432). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSL Mode + */ + ssl_mode?: string | null; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * DB Username + * + * The user account used to authenticate and access the databases. + */ + db_username?: string; + /** + * Region + * + * The AWS region where the RDS instances are located. + */ + region: string; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * DB Username + * + * The user account used to authenticate and access the databases. + */ + db_username?: string; + /** + * Region + * + * The AWS region where the RDS instances are located. + */ + region: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5439). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + user: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + database: string; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your Redshift database is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + } + | SaaSSchema + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 9042). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Keyspace + * + * The keyspace used. If not provided, DSRs for this integration will error. If the integration is used for D & D, then setting a keyspace is not required. + */ + keyspace?: string | null; + } + | { + /** + * Account Name + * + * The unique identifier for your Snowflake account. + */ + account_identifier: string; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + user_login_name: string; + /** + * Password + * + * The password used to authenticate and access the database. You can use a password or a private key, but not both. + */ + password?: string | null; + /** + * Private key + * + * The private key used to authenticate and access the database. If a `private_key_passphrase` is also provided, it is assumed to be encrypted; otherwise, it is assumed to be unencrypted. + */ + private_key?: string | null; + /** + * Passphrase + * + * The passphrase used for the encrypted private key. + */ + private_key_passphrase?: string | null; + /** + * Warehouse + * + * The name of the Snowflake warehouse where your queries will be executed. + */ + warehouse_name: string; + /** + * Database + * + * Only provide a database name to scope discovery monitors and privacy request automation to a specific database. In most cases, this can be left blank. + */ + database_name?: string | null; + /** + * Schema + * + * Only provide a schema to scope discovery monitors and privacy request automation to a specific schema. In most cases, this can be left blank. + */ + schema_name?: string | null; + /** + * Role + * + * The Snowflake role to assume for the session, if different than Username. + */ + role_name?: string | null; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettingsWithExtendedIdentityTypes; + /** + * Third Party Vendor Name + */ + third_party_vendor_name?: string; + /** + * Recipient Email Address + */ + recipient_email_address?: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5432). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSL Mode + */ + ssl_mode?: string | null; + } + | WebsiteSchema; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: { + /** + * Verify + */ + verify?: boolean | null; + }; + url: "/api/v1/system/{fides_key}/connection/secrets"; + }; + +export type patchConnectionSecretsApiV1SystemFidesKeyConnectionSecretsPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type patchConnectionSecretsApiV1SystemFidesKeyConnectionSecretsPatchError = + patchConnectionSecretsApiV1SystemFidesKeyConnectionSecretsPatchErrors[keyof patchConnectionSecretsApiV1SystemFidesKeyConnectionSecretsPatchErrors]; + +export type patchConnectionSecretsApiV1SystemFidesKeyConnectionSecretsPatchResponses = + { + /** + * Successful Response + */ + 200: TestStatusMessage; + }; + +export type patchConnectionSecretsApiV1SystemFidesKeyConnectionSecretsPatchResponse = + patchConnectionSecretsApiV1SystemFidesKeyConnectionSecretsPatchResponses[keyof patchConnectionSecretsApiV1SystemFidesKeyConnectionSecretsPatchResponses]; + +export type upsertApiV1SystemUpsertPostData = { + /** + * Resources + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/system/upsert"; +}; + +export type upsertApiV1SystemUpsertPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type upsertApiV1SystemUpsertPostError = + upsertApiV1SystemUpsertPostErrors[keyof upsertApiV1SystemUpsertPostErrors]; + +export type upsertApiV1SystemUpsertPostResponses = { + /** + * Response Upsert Api V1 System Upsert Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type upsertApiV1SystemUpsertPostResponse = + upsertApiV1SystemUpsertPostResponses[keyof upsertApiV1SystemUpsertPostResponses]; + +export type deleteApiV1SystemFidesKeyDeleteData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/system/{fides_key}"; +}; + +export type deleteApiV1SystemFidesKeyDeleteErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteApiV1SystemFidesKeyDeleteError = + deleteApiV1SystemFidesKeyDeleteErrors[keyof deleteApiV1SystemFidesKeyDeleteErrors]; + +export type deleteApiV1SystemFidesKeyDeleteResponses = { + /** + * Response Delete Api V1 System Fides Key Delete + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type deleteApiV1SystemFidesKeyDeleteResponse = + deleteApiV1SystemFidesKeyDeleteResponses[keyof deleteApiV1SystemFidesKeyDeleteResponses]; + +export type getASystemWithSystemGroupsApiV1SystemFidesKeyGetData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/system/{fides_key}"; +}; + +export type getASystemWithSystemGroupsApiV1SystemFidesKeyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getASystemWithSystemGroupsApiV1SystemFidesKeyGetError = + getASystemWithSystemGroupsApiV1SystemFidesKeyGetErrors[keyof getASystemWithSystemGroupsApiV1SystemFidesKeyGetErrors]; + +export type getASystemWithSystemGroupsApiV1SystemFidesKeyGetResponses = { + /** + * Successful Response + */ + 200: SystemResponseExtended; +}; + +export type getASystemWithSystemGroupsApiV1SystemFidesKeyGetResponse = + getASystemWithSystemGroupsApiV1SystemFidesKeyGetResponses[keyof getASystemWithSystemGroupsApiV1SystemFidesKeyGetResponses]; + +export type systemBulkDeleteApiV1SystemBulkDeletePostData = { + /** + * Fides Keys + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/system/bulk-delete"; +}; + +export type systemBulkDeleteApiV1SystemBulkDeletePostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type systemBulkDeleteApiV1SystemBulkDeletePostError = + systemBulkDeleteApiV1SystemBulkDeletePostErrors[keyof systemBulkDeleteApiV1SystemBulkDeletePostErrors]; + +export type systemBulkDeleteApiV1SystemBulkDeletePostResponses = { + /** + * Response System Bulk Delete Api V1 System Bulk Delete Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type systemBulkDeleteApiV1SystemBulkDeletePostResponse = + systemBulkDeleteApiV1SystemBulkDeletePostResponses[keyof systemBulkDeleteApiV1SystemBulkDeletePostResponses]; + +export type bulkAssignStewardApiV1SystemAssignStewardPostData = { + body: AssignStewardRequest; + path?: never; + query?: never; + url: "/api/v1/system/assign-steward"; +}; + +export type bulkAssignStewardApiV1SystemAssignStewardPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type bulkAssignStewardApiV1SystemAssignStewardPostError = + bulkAssignStewardApiV1SystemAssignStewardPostErrors[keyof bulkAssignStewardApiV1SystemAssignStewardPostErrors]; + +export type bulkAssignStewardApiV1SystemAssignStewardPostResponses = { + /** + * Response Bulk Assign Steward Api V1 System Assign Steward Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type bulkAssignStewardApiV1SystemAssignStewardPostResponse = + bulkAssignStewardApiV1SystemAssignStewardPostResponses[keyof bulkAssignStewardApiV1SystemAssignStewardPostResponses]; + +export type listSystemsWithSystemGroupFiltersOptionallyPaginatedApiV1SystemGetData = + { + body?: never; + path?: never; + query?: { + /** + * Size + */ + size?: number | null; + /** + * Page + */ + page?: number | null; + /** + * Search + */ + search?: string | null; + /** + * Data Uses + */ + data_uses?: Array | null; + /** + * Data Categories + */ + data_categories?: Array | null; + /** + * Data Subjects + */ + data_subjects?: Array | null; + /** + * Show Deleted + */ + show_deleted?: boolean; + /** + * System Groups + * + * Filter by system group Fides keys + */ + system_groups?: Array | null; + /** + * Data Stewards + * + * Filter by data steward usernames directly assigned to systems + */ + data_stewards?: Array | null; + /** + * Sort By + */ + sort_by?: Array<"name"> | null; + /** + * Sort Asc + */ + sort_asc?: boolean | null; + }; + url: "/api/v1/system"; + }; + +export type listSystemsWithSystemGroupFiltersOptionallyPaginatedApiV1SystemGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type listSystemsWithSystemGroupFiltersOptionallyPaginatedApiV1SystemGetError = + listSystemsWithSystemGroupFiltersOptionallyPaginatedApiV1SystemGetErrors[keyof listSystemsWithSystemGroupFiltersOptionallyPaginatedApiV1SystemGetErrors]; + +export type listSystemsWithSystemGroupFiltersOptionallyPaginatedApiV1SystemGetResponses = + { + /** + * Response List Systems With System Group Filters Optionally Paginated Api V1 System Get + * + * Successful Response + */ + 200: Array | Page_BasicSystemResponseExtended_; + }; + +export type listSystemsWithSystemGroupFiltersOptionallyPaginatedApiV1SystemGetResponse = + listSystemsWithSystemGroupFiltersOptionallyPaginatedApiV1SystemGetResponses[keyof listSystemsWithSystemGroupFiltersOptionallyPaginatedApiV1SystemGetResponses]; + +export type createApiV1SystemPostData = { + body: System; + path?: never; + query?: never; + url: "/api/v1/system"; +}; + +export type createApiV1SystemPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createApiV1SystemPostError = + createApiV1SystemPostErrors[keyof createApiV1SystemPostErrors]; + +export type createApiV1SystemPostResponses = { + /** + * Successful Response + */ + 201: SystemResponse; +}; + +export type createApiV1SystemPostResponse = + createApiV1SystemPostResponses[keyof createApiV1SystemPostResponses]; + +export type updateSystemExtendedApiV1SystemPutData = { + body: SystemSchemaExtended; + path?: never; + query?: never; + url: "/api/v1/system"; +}; + +export type updateSystemExtendedApiV1SystemPutErrors = { + /** + * Forbidden + */ + 403: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateSystemExtendedApiV1SystemPutError = + updateSystemExtendedApiV1SystemPutErrors[keyof updateSystemExtendedApiV1SystemPutErrors]; + +export type updateSystemExtendedApiV1SystemPutResponses = { + /** + * Successful Response + */ + 200: SystemResponseExtended; +}; + +export type updateSystemExtendedApiV1SystemPutResponse = + updateSystemExtendedApiV1SystemPutResponses[keyof updateSystemExtendedApiV1SystemPutResponses]; + +export type patchHiddenApiV1SystemHiddenPatchData = { + /** + * Fides Keys + */ + body: Array; + path?: never; + query: { + /** + * Hidden + */ + hidden: boolean; + }; + url: "/api/v1/system/hidden"; +}; + +export type patchHiddenApiV1SystemHiddenPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type patchHiddenApiV1SystemHiddenPatchError = + patchHiddenApiV1SystemHiddenPatchErrors[keyof patchHiddenApiV1SystemHiddenPatchErrors]; + +export type patchHiddenApiV1SystemHiddenPatchResponses = { + /** + * Response Patch Hidden Api V1 System Hidden Patch + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type patchHiddenApiV1SystemHiddenPatchResponse = + patchHiddenApiV1SystemHiddenPatchResponses[keyof patchHiddenApiV1SystemHiddenPatchResponses]; + +export type validateApiV1ValidatePostData = { + body: ValidateRequest; + path?: never; + query?: never; + url: "/api/v1/validate"; +}; + +export type validateApiV1ValidatePostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type validateApiV1ValidatePostError = + validateApiV1ValidatePostErrors[keyof validateApiV1ValidatePostErrors]; + +export type validateApiV1ValidatePostResponses = { + /** + * Successful Response + */ + 200: ValidateResponse; +}; + +export type validateApiV1ValidatePostResponse = + validateApiV1ValidatePostResponses[keyof validateApiV1ValidatePostResponses]; + +export type resetSettingsApiV1ConfigDeleteData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/config"; +}; + +export type resetSettingsApiV1ConfigDeleteResponses = { + /** + * Response Reset Settings Api V1 Config Delete + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type resetSettingsApiV1ConfigDeleteResponse = + resetSettingsApiV1ConfigDeleteResponses[keyof resetSettingsApiV1ConfigDeleteResponses]; + +export type plusGetConfigApiV1ConfigGetData = { + body?: never; + path?: never; + query?: { + /** + * Api Set + */ + api_set?: boolean; + }; + url: "/api/v1/config"; +}; + +export type plusGetConfigApiV1ConfigGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type plusGetConfigApiV1ConfigGetError = + plusGetConfigApiV1ConfigGetErrors[keyof plusGetConfigApiV1ConfigGetErrors]; + +export type plusGetConfigApiV1ConfigGetResponses = { + /** + * Response Plus Get Config Api V1 Config Get + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type plusGetConfigApiV1ConfigGetResponse = + plusGetConfigApiV1ConfigGetResponses[keyof plusGetConfigApiV1ConfigGetResponses]; + +export type plusPatchSettingsApiV1ConfigPatchData = { + body: PlusApplicationConfig; + path?: never; + query?: never; + url: "/api/v1/config"; +}; + +export type plusPatchSettingsApiV1ConfigPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type plusPatchSettingsApiV1ConfigPatchError = + plusPatchSettingsApiV1ConfigPatchErrors[keyof plusPatchSettingsApiV1ConfigPatchErrors]; + +export type plusPatchSettingsApiV1ConfigPatchResponses = { + /** + * Successful Response + */ + 200: PlusApplicationConfig; +}; + +export type plusPatchSettingsApiV1ConfigPatchResponse = + plusPatchSettingsApiV1ConfigPatchResponses[keyof plusPatchSettingsApiV1ConfigPatchResponses]; + +export type plusPutSettingsApiV1ConfigPutData = { + body: PlusApplicationConfig; + path?: never; + query?: never; + url: "/api/v1/config"; +}; + +export type plusPutSettingsApiV1ConfigPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type plusPutSettingsApiV1ConfigPutError = + plusPutSettingsApiV1ConfigPutErrors[keyof plusPutSettingsApiV1ConfigPutErrors]; + +export type plusPutSettingsApiV1ConfigPutResponses = { + /** + * Successful Response + */ + 200: PlusApplicationConfig; +}; + +export type plusPutSettingsApiV1ConfigPutResponse = + plusPutSettingsApiV1ConfigPutResponses[keyof plusPutSettingsApiV1ConfigPutResponses]; + +export type getAllConnectionTypesApiV1ConnectionTypeGetData = { + body?: never; + path?: never; + query?: { + /** + * Page + * + * Page number + */ + page?: number; + /** + * Size + * + * Page size + */ + size?: number; + /** + * Search + */ + search?: string | null; + /** + * System Type + */ + system_type?: SystemType | null; + /** + * Consent + */ + consent?: boolean | null; + /** + * Access + */ + access?: boolean | null; + /** + * Erasure + */ + erasure?: boolean | null; + }; + url: "/api/v1/connection_type"; +}; + +export type getAllConnectionTypesApiV1ConnectionTypeGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getAllConnectionTypesApiV1ConnectionTypeGetError = + getAllConnectionTypesApiV1ConnectionTypeGetErrors[keyof getAllConnectionTypesApiV1ConnectionTypeGetErrors]; + +export type getAllConnectionTypesApiV1ConnectionTypeGetResponses = { + /** + * Successful Response + */ + 200: Page_ConnectionSystemTypeMap_; +}; + +export type getAllConnectionTypesApiV1ConnectionTypeGetResponse = + getAllConnectionTypesApiV1ConnectionTypeGetResponses[keyof getAllConnectionTypesApiV1ConnectionTypeGetResponses]; + +export type getConnectionTypeSecretSchemaRouteApiV1ConnectionTypeConnectionTypeSecretGetData = + { + body?: never; + path: { + /** + * Connection Type + */ + connection_type: string; + }; + query?: never; + url: "/api/v1/connection_type/{connection_type}/secret"; + }; + +export type getConnectionTypeSecretSchemaRouteApiV1ConnectionTypeConnectionTypeSecretGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getConnectionTypeSecretSchemaRouteApiV1ConnectionTypeConnectionTypeSecretGetError = + getConnectionTypeSecretSchemaRouteApiV1ConnectionTypeConnectionTypeSecretGetErrors[keyof getConnectionTypeSecretSchemaRouteApiV1ConnectionTypeConnectionTypeSecretGetErrors]; + +export type getConnectionTypeSecretSchemaRouteApiV1ConnectionTypeConnectionTypeSecretGetResponses = + { + /** + * Response Get Connection Type Secret Schema Route Api V1 Connection Type Connection Type Secret Get + * + * Successful Response + */ + 200: { + [key: string]: unknown; + } | null; + }; + +export type getConnectionTypeSecretSchemaRouteApiV1ConnectionTypeConnectionTypeSecretGetResponse = + getConnectionTypeSecretSchemaRouteApiV1ConnectionTypeConnectionTypeSecretGetResponses[keyof getConnectionTypeSecretSchemaRouteApiV1ConnectionTypeConnectionTypeSecretGetResponses]; + +export type getConnectionsApiV1ConnectionGetData = { + body?: never; + path?: never; + query?: { + /** + * Search + */ + search?: string | null; + /** + * Disabled + */ + disabled?: boolean | null; + /** + * Test Status + */ + test_status?: TestStatus | null; + /** + * System Type + */ + system_type?: SystemType | null; + /** + * Orphaned From System + */ + orphaned_from_system?: boolean | null; + /** + * Connection Type + */ + connection_type?: Array | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/connection"; +}; + +export type getConnectionsApiV1ConnectionGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getConnectionsApiV1ConnectionGetError = + getConnectionsApiV1ConnectionGetErrors[keyof getConnectionsApiV1ConnectionGetErrors]; + +export type getConnectionsApiV1ConnectionGetResponses = { + /** + * Successful Response + */ + 200: Page_ConnectionConfigurationResponse_; +}; + +export type getConnectionsApiV1ConnectionGetResponse = + getConnectionsApiV1ConnectionGetResponses[keyof getConnectionsApiV1ConnectionGetResponses]; + +export type patchConnectionsApiV1ConnectionPatchData = { + /** + * Configs + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/connection"; +}; + +export type patchConnectionsApiV1ConnectionPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type patchConnectionsApiV1ConnectionPatchError = + patchConnectionsApiV1ConnectionPatchErrors[keyof patchConnectionsApiV1ConnectionPatchErrors]; + +export type patchConnectionsApiV1ConnectionPatchResponses = { + /** + * Successful Response + */ + 200: BulkPutConnectionConfiguration; +}; + +export type patchConnectionsApiV1ConnectionPatchResponse = + patchConnectionsApiV1ConnectionPatchResponses[keyof patchConnectionsApiV1ConnectionPatchResponses]; + +export type deleteConnectionApiV1ConnectionConnectionKeyDeleteData = { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}"; +}; + +export type deleteConnectionApiV1ConnectionConnectionKeyDeleteErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteConnectionApiV1ConnectionConnectionKeyDeleteError = + deleteConnectionApiV1ConnectionConnectionKeyDeleteErrors[keyof deleteConnectionApiV1ConnectionConnectionKeyDeleteErrors]; + +export type deleteConnectionApiV1ConnectionConnectionKeyDeleteResponses = { + /** + * Successful Response + */ + 204: void; +}; + +export type deleteConnectionApiV1ConnectionConnectionKeyDeleteResponse = + deleteConnectionApiV1ConnectionConnectionKeyDeleteResponses[keyof deleteConnectionApiV1ConnectionConnectionKeyDeleteResponses]; + +export type getConnectionDetailApiV1ConnectionConnectionKeyGetData = { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}"; +}; + +export type getConnectionDetailApiV1ConnectionConnectionKeyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getConnectionDetailApiV1ConnectionConnectionKeyGetError = + getConnectionDetailApiV1ConnectionConnectionKeyGetErrors[keyof getConnectionDetailApiV1ConnectionConnectionKeyGetErrors]; + +export type getConnectionDetailApiV1ConnectionConnectionKeyGetResponses = { + /** + * Successful Response + */ + 200: ConnectionConfigurationResponseWithSystemKey; +}; + +export type getConnectionDetailApiV1ConnectionConnectionKeyGetResponse = + getConnectionDetailApiV1ConnectionConnectionKeyGetResponses[keyof getConnectionDetailApiV1ConnectionConnectionKeyGetResponses]; + +export type patchConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPatchData = + { + /** + * Unvalidated Secrets + */ + body: + | { + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds; + /** + * Dataset + * + * Only provide a dataset to scope discovery monitors and privacy request automation to a specific BigQuery dataset. In most cases, this can be left blank. + */ + dataset?: string | null; + } + | { + /** + * DataHub server URL + * + * The URL of your DataHub server. + */ + datahub_server_url: string; + /** + * DataHub token + * + * The token used to authenticate with your DataHub server. + */ + datahub_token: string; + /** + * Frequency + * + * The frequency at which the integration should run. Available options are daily, weekly, monthly, and not scheduled. + */ + frequency: PeriodicIntegrationFrequency; + /** + * Glossary node + * + * The glossary node name to use on Datahub for Fides Data Categories. (e.g. FidesDataCategories) + */ + glossary_node: string; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettings; + /** + * Third party vendor name field + * + * Dataset reference to the field containing the third party vendor name. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. + */ + third_party_vendor_name: FidesDatasetReference; + /** + * Recipient email address field + * + * Dataset reference to the field containing the recipient email address. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. + */ + recipient_email_address: FidesDatasetReference; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * Region + * + * The AWS region where your DynamoDB table is located (ex. us-west-2). + */ + region_name: string; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettings; + /** + * Third Party Vendor Name + */ + third_party_vendor_name: string; + /** + * Recipient Email Address + */ + recipient_email_address: string; + } + | { + /** + * Uri + */ + uri: string; + /** + * Username + */ + username: string; + /** + * Password + */ + password: string; + /** + * Polling Timeout + */ + polling_timeout?: number | null; + /** + * Polling Interval + */ + polling_interval?: number | null; + } + | { + /** + * DB IAM user + * + * example: service-account@test.iam.gserviceaccount.com + */ + db_iam_user: string; + /** + * Instance connection name + * + * example: friendly-tower-424214-n8:us-central1:test-ethyca + */ + instance_connection_name: string; + /** + * Database name + */ + dbname: string; + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds; + /** + * IP type + * + * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview + */ + ip_type?: GoogleCloudSQLIPType | null; + } + | { + /** + * DB IAM user + * + * example: service-account@test.iam.gserviceaccount.com + */ + db_iam_user: string; + /** + * Instance connection name + * + * example: friendly-tower-424214-n8:us-central1:test-ethyca + */ + instance_connection_name: string; + /** + * Database name + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds; + /** + * IP type + * + * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview + */ + ip_type?: GoogleCloudSQLIPType | null; + } + | { + /** + * Access Token + */ + access_token?: string | null; + /** + * Refresh Token + */ + refresh_token?: string | null; + /** + * Token Expiry + */ + token_expiry?: string | null; + /** + * Cloud Id + */ + cloud_id?: string | null; + /** + * Site Url + */ + site_url?: string | null; + } + | { + [key: string]: unknown; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 3306). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 27017). Port will be ignored if using SRV. + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Default auth DB + * + * Used to specify the default authentication database. + */ + defaultauthdb: string; + /** + * Use SRV + * + * Enable SRV record lookup for service discovery (mongodb+srv://). Required for MongoDB Atlas. Enables SSL by default. + */ + use_srv?: boolean | null; + /** + * SSL enabled + * + * Enable SSL/TLS encryption. With SRV: defaults to enabled (can override). Without SRV: defaults to disabled. + */ + ssl_enabled?: boolean | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 1433). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Read Only Connection + * + * Whether to connect to the database in read-only mode. + */ + read_only_connection?: boolean | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 3306). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname: string; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your MySQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * SSL Mode + * + * The SSL mode to use for the connection. Accepted values are: 'required', 'preferred', 'disabled', or an empty value. + */ + ssl_mode?: MySQLSSLMode | null; + } + | { + /** + * Organization URL + * + * The URL of your Okta organization (e.g. https://your-org.okta.com) + */ + org_url: string; + /** + * OAuth2 Client ID + * + * The OAuth2 client ID from your Okta service application + */ + client_id: string; + /** + * Private Key + * + * RSA private key in JWK (JSON) format for signing JWT assertions. Download from Okta: Applications > Your App > Sign On > Client Credentials > Edit > Generate new key. + */ + private_key: string; + /** + * OAuth2 Scopes + * + * OAuth2 scopes to request (default: okta.apps.read) + */ + scopes?: Array | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5432). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSL Mode + */ + ssl_mode?: string | null; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * DB Username + * + * The user account used to authenticate and access the databases. + */ + db_username?: string; + /** + * Region + * + * The AWS region where the RDS instances are located. + */ + region: string; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * DB Username + * + * The user account used to authenticate and access the databases. + */ + db_username?: string; + /** + * Region + * + * The AWS region where the RDS instances are located. + */ + region: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5439). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + user: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + database: string; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your Redshift database is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + } + | SaaSSchema + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 9042). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Keyspace + * + * The keyspace used. If not provided, DSRs for this integration will error. If the integration is used for D & D, then setting a keyspace is not required. + */ + keyspace?: string | null; + } + | { + /** + * Account Name + * + * The unique identifier for your Snowflake account. + */ + account_identifier: string; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + user_login_name: string; + /** + * Password + * + * The password used to authenticate and access the database. You can use a password or a private key, but not both. + */ + password?: string | null; + /** + * Private key + * + * The private key used to authenticate and access the database. If a `private_key_passphrase` is also provided, it is assumed to be encrypted; otherwise, it is assumed to be unencrypted. + */ + private_key?: string | null; + /** + * Passphrase + * + * The passphrase used for the encrypted private key. + */ + private_key_passphrase?: string | null; + /** + * Warehouse + * + * The name of the Snowflake warehouse where your queries will be executed. + */ + warehouse_name: string; + /** + * Database + * + * Only provide a database name to scope discovery monitors and privacy request automation to a specific database. In most cases, this can be left blank. + */ + database_name?: string | null; + /** + * Schema + * + * Only provide a schema to scope discovery monitors and privacy request automation to a specific schema. In most cases, this can be left blank. + */ + schema_name?: string | null; + /** + * Role + * + * The Snowflake role to assume for the session, if different than Username. + */ + role_name?: string | null; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettingsWithExtendedIdentityTypes; + /** + * Third Party Vendor Name + */ + third_party_vendor_name?: string; + /** + * Recipient Email Address + */ + recipient_email_address?: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5432). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSL Mode + */ + ssl_mode?: string | null; + } + | WebsiteSchema; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: { + /** + * Verify + */ + verify?: boolean | null; + }; + url: "/api/v1/connection/{connection_key}/secret"; + }; + +export type patchConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type patchConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPatchError = + patchConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPatchErrors[keyof patchConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPatchErrors]; + +export type patchConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPatchResponses = + { + /** + * Successful Response + */ + 200: TestStatusMessage; + }; + +export type patchConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPatchResponse = + patchConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPatchResponses[keyof patchConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPatchResponses]; + +export type putConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPutData = + { + /** + * Unvalidated Secrets + */ + body: + | { + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_bigquery__KeyfileCreds; + /** + * Dataset + * + * Only provide a dataset to scope discovery monitors and privacy request automation to a specific BigQuery dataset. In most cases, this can be left blank. + */ + dataset?: string | null; + } + | { + /** + * DataHub server URL + * + * The URL of your DataHub server. + */ + datahub_server_url: string; + /** + * DataHub token + * + * The token used to authenticate with your DataHub server. + */ + datahub_token: string; + /** + * Frequency + * + * The frequency at which the integration should run. Available options are daily, weekly, monthly, and not scheduled. + */ + frequency: PeriodicIntegrationFrequency; + /** + * Glossary node + * + * The glossary node name to use on Datahub for Fides Data Categories. (e.g. FidesDataCategories) + */ + glossary_node: string; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettings; + /** + * Third party vendor name field + * + * Dataset reference to the field containing the third party vendor name. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. + */ + third_party_vendor_name: FidesDatasetReference; + /** + * Recipient email address field + * + * Dataset reference to the field containing the recipient email address. Both third_party_vendor_name and recipient_email_address must reference the same dataset and collection. + */ + recipient_email_address: FidesDatasetReference; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * Region + * + * The AWS region where your DynamoDB table is located (ex. us-west-2). + */ + region_name: string; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettings; + /** + * Third Party Vendor Name + */ + third_party_vendor_name: string; + /** + * Recipient Email Address + */ + recipient_email_address: string; + } + | { + /** + * Uri + */ + uri: string; + /** + * Username + */ + username: string; + /** + * Password + */ + password: string; + /** + * Polling Timeout + */ + polling_timeout?: number | null; + /** + * Polling Interval + */ + polling_interval?: number | null; + } + | { + /** + * DB IAM user + * + * example: service-account@test.iam.gserviceaccount.com + */ + db_iam_user: string; + /** + * Instance connection name + * + * example: friendly-tower-424214-n8:us-central1:test-ethyca + */ + instance_connection_name: string; + /** + * Database name + */ + dbname: string; + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_mysql__KeyfileCreds; + /** + * IP type + * + * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview + */ + ip_type?: GoogleCloudSQLIPType | null; + } + | { + /** + * DB IAM user + * + * example: service-account@test.iam.gserviceaccount.com + */ + db_iam_user: string; + /** + * Instance connection name + * + * example: friendly-tower-424214-n8:us-central1:test-ethyca + */ + instance_connection_name: string; + /** + * Database name + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * Keyfile creds + * + * The contents of the key file that contains authentication credentials for a service account in GCP. + */ + keyfile_creds: fides__api__schemas__connection_configuration__connection_secrets_google_cloud_sql_postgres__KeyfileCreds; + /** + * IP type + * + * Specify the IP Address type required for your database (defaults to public). See the Google Cloud documentation for more information about connection options: https://cloud.google.com/sql/docs/postgres/connect-overview + */ + ip_type?: GoogleCloudSQLIPType | null; + } + | { + /** + * Access Token + */ + access_token?: string | null; + /** + * Refresh Token + */ + refresh_token?: string | null; + /** + * Token Expiry + */ + token_expiry?: string | null; + /** + * Cloud Id + */ + cloud_id?: string | null; + /** + * Site Url + */ + site_url?: string | null; + } + | { + [key: string]: unknown; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 3306). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 27017). Port will be ignored if using SRV. + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Default auth DB + * + * Used to specify the default authentication database. + */ + defaultauthdb: string; + /** + * Use SRV + * + * Enable SRV record lookup for service discovery (mongodb+srv://). Required for MongoDB Atlas. Enables SSL by default. + */ + use_srv?: boolean | null; + /** + * SSL enabled + * + * Enable SSL/TLS encryption. With SRV: defaults to enabled (can override). Without SRV: defaults to disabled. + */ + ssl_enabled?: boolean | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 1433). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Read Only Connection + * + * Whether to connect to the database in read-only mode. + */ + read_only_connection?: boolean | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 3306). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname: string; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your MySQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * SSL Mode + * + * The SSL mode to use for the connection. Accepted values are: 'required', 'preferred', 'disabled', or an empty value. + */ + ssl_mode?: MySQLSSLMode | null; + } + | { + /** + * Organization URL + * + * The URL of your Okta organization (e.g. https://your-org.okta.com) + */ + org_url: string; + /** + * OAuth2 Client ID + * + * The OAuth2 client ID from your Okta service application + */ + client_id: string; + /** + * Private Key + * + * RSA private key in JWK (JSON) format for signing JWT assertions. Download from Okta: Applications > Your App > Sign On > Client Credentials > Edit > Generate new key. + */ + private_key: string; + /** + * OAuth2 Scopes + * + * OAuth2 scopes to request (default: okta.apps.read) + */ + scopes?: Array | null; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5432). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSL Mode + */ + ssl_mode?: string | null; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * DB Username + * + * The user account used to authenticate and access the databases. + */ + db_username?: string; + /** + * Region + * + * The AWS region where the RDS instances are located. + */ + region: string; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + /** + * DB Username + * + * The user account used to authenticate and access the databases. + */ + db_username?: string; + /** + * Region + * + * The AWS region where the RDS instances are located. + */ + region: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5439). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + user: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + database: string; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your Redshift database is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + } + | SaaSSchema + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 9042). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username: string; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password: string; + /** + * Keyspace + * + * The keyspace used. If not provided, DSRs for this integration will error. If the integration is used for D & D, then setting a keyspace is not required. + */ + keyspace?: string | null; + } + | { + /** + * Account Name + * + * The unique identifier for your Snowflake account. + */ + account_identifier: string; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + user_login_name: string; + /** + * Password + * + * The password used to authenticate and access the database. You can use a password or a private key, but not both. + */ + password?: string | null; + /** + * Private key + * + * The private key used to authenticate and access the database. If a `private_key_passphrase` is also provided, it is assumed to be encrypted; otherwise, it is assumed to be unencrypted. + */ + private_key?: string | null; + /** + * Passphrase + * + * The passphrase used for the encrypted private key. + */ + private_key_passphrase?: string | null; + /** + * Warehouse + * + * The name of the Snowflake warehouse where your queries will be executed. + */ + warehouse_name: string; + /** + * Database + * + * Only provide a database name to scope discovery monitors and privacy request automation to a specific database. In most cases, this can be left blank. + */ + database_name?: string | null; + /** + * Schema + * + * Only provide a schema to scope discovery monitors and privacy request automation to a specific schema. In most cases, this can be left blank. + */ + schema_name?: string | null; + /** + * Role + * + * The Snowflake role to assume for the session, if different than Username. + */ + role_name?: string | null; + } + | { + /** + * Test Email Address + */ + test_email_address?: string | null; + advanced_settings?: AdvancedSettingsWithExtendedIdentityTypes; + /** + * Third Party Vendor Name + */ + third_party_vendor_name?: string; + /** + * Recipient Email Address + */ + recipient_email_address?: string; + } + | { + /** + * Host + * + * The hostname or IP address of the server where the database is running. + */ + host: string; + /** + * Port + * + * The network port number on which the server is listening for incoming connections (default: 5432). + */ + port?: number; + /** + * Username + * + * The user account used to authenticate and access the database. + */ + username?: string | null; + /** + * Password + * + * The password used to authenticate and access the database. + */ + password?: string | null; + /** + * SSH required + * + * Indicates whether an SSH tunnel is required for the connection. Enable this option if your PostgreSQL server is behind a firewall and requires SSH tunneling for remote connections. + */ + ssh_required?: boolean; + /** + * Database + * + * The name of the specific database within the database server that you want to connect to. + */ + dbname?: string | null; + /** + * Schema + * + * The default schema to be used for the database connection (defaults to public). + */ + db_schema?: string | null; + /** + * SSL Mode + */ + ssl_mode?: string | null; + } + | WebsiteSchema; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: { + /** + * Verify + */ + verify?: boolean | null; + }; + url: "/api/v1/connection/{connection_key}/secret"; + }; + +export type putConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type putConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPutError = + putConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPutErrors[keyof putConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPutErrors]; + +export type putConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPutResponses = + { + /** + * Successful Response + */ + 200: TestStatusMessage; + }; + +export type putConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPutResponse = + putConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPutResponses[keyof putConnectionConfigSecretsApiV1ConnectionConnectionKeySecretPutResponses]; + +export type testConnectionConfigSecretsApiV1ConnectionConnectionKeyTestGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/test"; + }; + +export type testConnectionConfigSecretsApiV1ConnectionConnectionKeyTestGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type testConnectionConfigSecretsApiV1ConnectionConnectionKeyTestGetError = + testConnectionConfigSecretsApiV1ConnectionConnectionKeyTestGetErrors[keyof testConnectionConfigSecretsApiV1ConnectionConnectionKeyTestGetErrors]; + +export type testConnectionConfigSecretsApiV1ConnectionConnectionKeyTestGetResponses = + { + /** + * Successful Response + */ + 200: TestStatusMessage; + }; + +export type testConnectionConfigSecretsApiV1ConnectionConnectionKeyTestGetResponse = + testConnectionConfigSecretsApiV1ConnectionConnectionKeyTestGetResponses[keyof testConnectionConfigSecretsApiV1ConnectionConnectionKeyTestGetResponses]; + +export type deleteConnectionOauthConfigApiV1ConnectionConnectionKeyOauthDeleteData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/oauth"; + }; + +export type deleteConnectionOauthConfigApiV1ConnectionConnectionKeyOauthDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteConnectionOauthConfigApiV1ConnectionConnectionKeyOauthDeleteError = + deleteConnectionOauthConfigApiV1ConnectionConnectionKeyOauthDeleteErrors[keyof deleteConnectionOauthConfigApiV1ConnectionConnectionKeyOauthDeleteErrors]; + +export type deleteConnectionOauthConfigApiV1ConnectionConnectionKeyOauthDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deleteConnectionOauthConfigApiV1ConnectionConnectionKeyOauthDeleteResponse = + deleteConnectionOauthConfigApiV1ConnectionConnectionKeyOauthDeleteResponses[keyof deleteConnectionOauthConfigApiV1ConnectionConnectionKeyOauthDeleteResponses]; + +export type patchConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPatchData = + { + body: OAuthConfigSchema; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: { + /** + * Verify + */ + verify?: boolean | null; + }; + url: "/api/v1/connection/{connection_key}/oauth"; + }; + +export type patchConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type patchConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPatchError = + patchConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPatchErrors[keyof patchConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPatchErrors]; + +export type patchConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPatchResponses = + { + /** + * Successful Response + */ + 200: TestStatusMessage; + }; + +export type patchConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPatchResponse = + patchConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPatchResponses[keyof patchConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPatchResponses]; + +export type putConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPutData = { + body: OAuthConfigSchema; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: { + /** + * Verify + */ + verify?: boolean | null; + }; + url: "/api/v1/connection/{connection_key}/oauth"; +}; + +export type putConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type putConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPutError = + putConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPutErrors[keyof putConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPutErrors]; + +export type putConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPutResponses = + { + /** + * Successful Response + */ + 200: TestStatusMessage; + }; + +export type putConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPutResponse = + putConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPutResponses[keyof putConnectionOauthConfigApiV1ConnectionConnectionKeyOauthPutResponses]; + +export type getAllConnectorTemplatesApiV1ConnectorTemplatesGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/connector-templates"; +}; + +export type getAllConnectorTemplatesApiV1ConnectorTemplatesGetResponses = { + /** + * Response Get All Connector Templates Api V1 Connector Templates Get + * + * Successful Response + */ + 200: Array; +}; + +export type getAllConnectorTemplatesApiV1ConnectorTemplatesGetResponse = + getAllConnectorTemplatesApiV1ConnectorTemplatesGetResponses[keyof getAllConnectorTemplatesApiV1ConnectorTemplatesGetResponses]; + +export type registerConnectorTemplateApiV1ConnectorTemplatesRegisterPostData = { + /** + * File + */ + body: Blob | File; + path?: never; + query?: never; + url: "/api/v1/connector-templates/register"; +}; + +export type registerConnectorTemplateApiV1ConnectorTemplatesRegisterPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type registerConnectorTemplateApiV1ConnectorTemplatesRegisterPostError = + registerConnectorTemplateApiV1ConnectorTemplatesRegisterPostErrors[keyof registerConnectorTemplateApiV1ConnectorTemplatesRegisterPostErrors]; + +export type registerConnectorTemplateApiV1ConnectorTemplatesRegisterPostResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type registerCustomConnectorTemplateDeprecatedApiV1ConnectorTemplateRegisterPostData = + { + /** + * File + */ + body: Blob | File; + path?: never; + query?: never; + url: "/api/v1/connector_template/register"; + }; + +export type registerCustomConnectorTemplateDeprecatedApiV1ConnectorTemplateRegisterPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type registerCustomConnectorTemplateDeprecatedApiV1ConnectorTemplateRegisterPostError = + registerCustomConnectorTemplateDeprecatedApiV1ConnectorTemplateRegisterPostErrors[keyof registerCustomConnectorTemplateDeprecatedApiV1ConnectorTemplateRegisterPostErrors]; + +export type registerCustomConnectorTemplateDeprecatedApiV1ConnectorTemplateRegisterPostResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getConnectorTemplateConfigApiV1ConnectorTemplatesConnectorTemplateTypeConfigGetData = + { + body?: never; + path: { + /** + * Connector Template Type + */ + connector_template_type: string; + }; + query?: never; + url: "/api/v1/connector-templates/{connector_template_type}/config"; + }; + +export type getConnectorTemplateConfigApiV1ConnectorTemplatesConnectorTemplateTypeConfigGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getConnectorTemplateConfigApiV1ConnectorTemplatesConnectorTemplateTypeConfigGetError = + getConnectorTemplateConfigApiV1ConnectorTemplatesConnectorTemplateTypeConfigGetErrors[keyof getConnectorTemplateConfigApiV1ConnectorTemplatesConnectorTemplateTypeConfigGetErrors]; + +export type getConnectorTemplateConfigApiV1ConnectorTemplatesConnectorTemplateTypeConfigGetResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getConnectorTemplateDatasetApiV1ConnectorTemplatesConnectorTemplateTypeDatasetGetData = + { + body?: never; + path: { + /** + * Connector Template Type + */ + connector_template_type: string; + }; + query?: never; + url: "/api/v1/connector-templates/{connector_template_type}/dataset"; + }; + +export type getConnectorTemplateDatasetApiV1ConnectorTemplatesConnectorTemplateTypeDatasetGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getConnectorTemplateDatasetApiV1ConnectorTemplatesConnectorTemplateTypeDatasetGetError = + getConnectorTemplateDatasetApiV1ConnectorTemplatesConnectorTemplateTypeDatasetGetErrors[keyof getConnectorTemplateDatasetApiV1ConnectorTemplatesConnectorTemplateTypeDatasetGetErrors]; + +export type getConnectorTemplateDatasetApiV1ConnectorTemplatesConnectorTemplateTypeDatasetGetResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type deleteCustomConnectorTemplateApiV1ConnectorTemplatesConnectorTemplateTypeDeleteData = + { + body?: never; + path: { + /** + * Connector Template Type + */ + connector_template_type: string; + }; + query?: never; + url: "/api/v1/connector-templates/{connector_template_type}"; + }; + +export type deleteCustomConnectorTemplateApiV1ConnectorTemplatesConnectorTemplateTypeDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteCustomConnectorTemplateApiV1ConnectorTemplatesConnectorTemplateTypeDeleteError = + deleteCustomConnectorTemplateApiV1ConnectorTemplatesConnectorTemplateTypeDeleteErrors[keyof deleteCustomConnectorTemplateApiV1ConnectorTemplatesConnectorTemplateTypeDeleteErrors]; + +export type deleteCustomConnectorTemplateApiV1ConnectorTemplatesConnectorTemplateTypeDeleteResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type reportConsentRequestsApiV1ConsentRequestPreferencesGetData = { + body?: never; + path?: never; + query?: { + /** + * Data Use + */ + data_use?: string | null; + /** + * Has Gpc Flag + */ + has_gpc_flag?: boolean | null; + /** + * Opt In + */ + opt_in?: boolean | null; + /** + * Created Lt + */ + created_lt?: string | null; + /** + * Created Gt + */ + created_gt?: string | null; + /** + * Updated Lt + */ + updated_lt?: string | null; + /** + * Updated Gt + */ + updated_gt?: string | null; + /** + * Identity + */ + identity?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/consent-request/preferences"; +}; + +export type reportConsentRequestsApiV1ConsentRequestPreferencesGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type reportConsentRequestsApiV1ConsentRequestPreferencesGetError = + reportConsentRequestsApiV1ConsentRequestPreferencesGetErrors[keyof reportConsentRequestsApiV1ConsentRequestPreferencesGetErrors]; + +export type reportConsentRequestsApiV1ConsentRequestPreferencesGetResponses = { + /** + * Successful Response + */ + 200: Page_ConsentReport_; +}; + +export type reportConsentRequestsApiV1ConsentRequestPreferencesGetResponse = + reportConsentRequestsApiV1ConsentRequestPreferencesGetResponses[keyof reportConsentRequestsApiV1ConsentRequestPreferencesGetResponses]; + +export type getConsentPreferencesApiV1ConsentRequestPreferencesPostData = { + body: fides__api__schemas__redis_cache__Identity; + path?: never; + query?: never; + url: "/api/v1/consent-request/preferences"; +}; + +export type getConsentPreferencesApiV1ConsentRequestPreferencesPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getConsentPreferencesApiV1ConsentRequestPreferencesPostError = + getConsentPreferencesApiV1ConsentRequestPreferencesPostErrors[keyof getConsentPreferencesApiV1ConsentRequestPreferencesPostErrors]; + +export type getConsentPreferencesApiV1ConsentRequestPreferencesPostResponses = { + /** + * Successful Response + */ + 200: ConsentPreferences; +}; + +export type getConsentPreferencesApiV1ConsentRequestPreferencesPostResponse = + getConsentPreferencesApiV1ConsentRequestPreferencesPostResponses[keyof getConsentPreferencesApiV1ConsentRequestPreferencesPostResponses]; + +export type consentRequestVerifyApiV1ConsentRequestConsentRequestIdVerifyPostData = + { + body: VerificationCode; + path: { + /** + * Consent Request Id + */ + consent_request_id: string; + }; + query?: never; + url: "/api/v1/consent-request/{consent_request_id}/verify"; + }; + +export type consentRequestVerifyApiV1ConsentRequestConsentRequestIdVerifyPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type consentRequestVerifyApiV1ConsentRequestConsentRequestIdVerifyPostError = + consentRequestVerifyApiV1ConsentRequestConsentRequestIdVerifyPostErrors[keyof consentRequestVerifyApiV1ConsentRequestConsentRequestIdVerifyPostErrors]; + +export type consentRequestVerifyApiV1ConsentRequestConsentRequestIdVerifyPostResponses = + { + /** + * Successful Response + */ + 200: ConsentPreferences; + }; + +export type consentRequestVerifyApiV1ConsentRequestConsentRequestIdVerifyPostResponse = + consentRequestVerifyApiV1ConsentRequestConsentRequestIdVerifyPostResponses[keyof consentRequestVerifyApiV1ConsentRequestConsentRequestIdVerifyPostResponses]; + +export type getConsentPreferencesNoIdApiV1ConsentRequestConsentRequestIdPreferencesGetData = + { + body?: never; + path: { + /** + * Consent Request Id + */ + consent_request_id: string; + }; + query?: never; + url: "/api/v1/consent-request/{consent_request_id}/preferences"; + }; + +export type getConsentPreferencesNoIdApiV1ConsentRequestConsentRequestIdPreferencesGetErrors = + { + /** + * Bad Request + */ + 400: unknown; + /** + * Not Found + */ + 404: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getConsentPreferencesNoIdApiV1ConsentRequestConsentRequestIdPreferencesGetError = + getConsentPreferencesNoIdApiV1ConsentRequestConsentRequestIdPreferencesGetErrors[keyof getConsentPreferencesNoIdApiV1ConsentRequestConsentRequestIdPreferencesGetErrors]; + +export type getConsentPreferencesNoIdApiV1ConsentRequestConsentRequestIdPreferencesGetResponses = + { + /** + * Successful Response + */ + 200: ConsentPreferences; + }; + +export type getConsentPreferencesNoIdApiV1ConsentRequestConsentRequestIdPreferencesGetResponse = + getConsentPreferencesNoIdApiV1ConsentRequestConsentRequestIdPreferencesGetResponses[keyof getConsentPreferencesNoIdApiV1ConsentRequestConsentRequestIdPreferencesGetResponses]; + +export type setConsentPreferencesApiV1ConsentRequestConsentRequestIdPreferencesPatchData = + { + body: ConsentPreferencesWithVerificationCode; + path: { + /** + * Consent Request Id + */ + consent_request_id: string; + }; + query?: never; + url: "/api/v1/consent-request/{consent_request_id}/preferences"; + }; + +export type setConsentPreferencesApiV1ConsentRequestConsentRequestIdPreferencesPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type setConsentPreferencesApiV1ConsentRequestConsentRequestIdPreferencesPatchError = + setConsentPreferencesApiV1ConsentRequestConsentRequestIdPreferencesPatchErrors[keyof setConsentPreferencesApiV1ConsentRequestConsentRequestIdPreferencesPatchErrors]; + +export type setConsentPreferencesApiV1ConsentRequestConsentRequestIdPreferencesPatchResponses = + { + /** + * Successful Response + */ + 200: ConsentPreferences; + }; + +export type setConsentPreferencesApiV1ConsentRequestConsentRequestIdPreferencesPatchResponse = + setConsentPreferencesApiV1ConsentRequestConsentRequestIdPreferencesPatchResponses[keyof setConsentPreferencesApiV1ConsentRequestConsentRequestIdPreferencesPatchResponses]; + +export type validateDatasetApiV1ConnectionConnectionKeyValidateDatasetPutData = + { + body: Dataset; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/validate_dataset"; + }; + +export type validateDatasetApiV1ConnectionConnectionKeyValidateDatasetPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type validateDatasetApiV1ConnectionConnectionKeyValidateDatasetPutError = + validateDatasetApiV1ConnectionConnectionKeyValidateDatasetPutErrors[keyof validateDatasetApiV1ConnectionConnectionKeyValidateDatasetPutErrors]; + +export type validateDatasetApiV1ConnectionConnectionKeyValidateDatasetPutResponses = + { + /** + * Successful Response + */ + 200: ValidateDatasetResponse; + }; + +export type validateDatasetApiV1ConnectionConnectionKeyValidateDatasetPutResponse = + validateDatasetApiV1ConnectionConnectionKeyValidateDatasetPutResponses[keyof validateDatasetApiV1ConnectionConnectionKeyValidateDatasetPutResponses]; + +export type getDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/connection/{connection_key}/datasetconfig"; + }; + +export type getDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigGetError = + getDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigGetErrors[keyof getDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigGetErrors]; + +export type getDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigGetResponses = + { + /** + * Successful Response + */ + 200: Page_DatasetConfigSchema_; + }; + +export type getDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigGetResponse = + getDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigGetResponses[keyof getDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigGetResponses]; + +export type patchDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPatchData = + { + /** + * Dataset Pairs + */ + body: Array; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/datasetconfig"; + }; + +export type patchDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type patchDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPatchError = + patchDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPatchErrors[keyof patchDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPatchErrors]; + +export type patchDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPatchResponses = + { + /** + * Successful Response + */ + 200: BulkPutDataset; + }; + +export type patchDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPatchResponse = + patchDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPatchResponses[keyof patchDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPatchResponses]; + +export type putDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPutData = + { + /** + * Dataset Pairs + */ + body: Array; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/datasetconfig"; + }; + +export type putDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type putDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPutError = + putDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPutErrors[keyof putDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPutErrors]; + +export type putDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPutResponses = + { + /** + * Successful Response + */ + 200: BulkPutDataset; + }; + +export type putDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPutResponse = + putDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPutResponses[keyof putDatasetConfigsApiV1ConnectionConnectionKeyDatasetconfigPutResponses]; + +export type getDatasetsApiV1ConnectionConnectionKeyDatasetGetData = { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/connection/{connection_key}/dataset"; +}; + +export type getDatasetsApiV1ConnectionConnectionKeyDatasetGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getDatasetsApiV1ConnectionConnectionKeyDatasetGetError = + getDatasetsApiV1ConnectionConnectionKeyDatasetGetErrors[keyof getDatasetsApiV1ConnectionConnectionKeyDatasetGetErrors]; + +export type getDatasetsApiV1ConnectionConnectionKeyDatasetGetResponses = { + /** + * Successful Response + */ + 200: Page_Dataset_; +}; + +export type getDatasetsApiV1ConnectionConnectionKeyDatasetGetResponse = + getDatasetsApiV1ConnectionConnectionKeyDatasetGetResponses[keyof getDatasetsApiV1ConnectionConnectionKeyDatasetGetResponses]; + +export type patchDatasetsApiV1ConnectionConnectionKeyDatasetPatchData = { + /** + * Datasets + */ + body: Array; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/dataset"; +}; + +export type patchDatasetsApiV1ConnectionConnectionKeyDatasetPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type patchDatasetsApiV1ConnectionConnectionKeyDatasetPatchError = + patchDatasetsApiV1ConnectionConnectionKeyDatasetPatchErrors[keyof patchDatasetsApiV1ConnectionConnectionKeyDatasetPatchErrors]; + +export type patchDatasetsApiV1ConnectionConnectionKeyDatasetPatchResponses = { + /** + * Successful Response + */ + 200: BulkPutDataset; +}; + +export type patchDatasetsApiV1ConnectionConnectionKeyDatasetPatchResponse = + patchDatasetsApiV1ConnectionConnectionKeyDatasetPatchResponses[keyof patchDatasetsApiV1ConnectionConnectionKeyDatasetPatchResponses]; + +export type patchYamlDatasetsApiV1YmlConnectionConnectionKeyDatasetPatchData = { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/yml/connection/{connection_key}/dataset"; +}; + +export type patchYamlDatasetsApiV1YmlConnectionConnectionKeyDatasetPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type patchYamlDatasetsApiV1YmlConnectionConnectionKeyDatasetPatchError = + patchYamlDatasetsApiV1YmlConnectionConnectionKeyDatasetPatchErrors[keyof patchYamlDatasetsApiV1YmlConnectionConnectionKeyDatasetPatchErrors]; + +export type patchYamlDatasetsApiV1YmlConnectionConnectionKeyDatasetPatchResponses = + { + /** + * Successful Response + */ + 200: BulkPutDataset; + }; + +export type patchYamlDatasetsApiV1YmlConnectionConnectionKeyDatasetPatchResponse = + patchYamlDatasetsApiV1YmlConnectionConnectionKeyDatasetPatchResponses[keyof patchYamlDatasetsApiV1YmlConnectionConnectionKeyDatasetPatchResponses]; + +export type deleteDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyDeleteData = + { + body?: never; + path: { + /** + * Dataset Key + */ + dataset_key: string; + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/dataset/{dataset_key}"; + }; + +export type deleteDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyDeleteError = + deleteDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyDeleteErrors[keyof deleteDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyDeleteErrors]; + +export type deleteDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deleteDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyDeleteResponse = + deleteDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyDeleteResponses[keyof deleteDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyDeleteResponses]; + +export type getDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyGetData = { + body?: never; + path: { + /** + * Dataset Key + */ + dataset_key: string; + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/dataset/{dataset_key}"; +}; + +export type getDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyGetError = + getDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyGetErrors[keyof getDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyGetErrors]; + +export type getDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyGetResponses = + { + /** + * Successful Response + */ + 200: Dataset; + }; + +export type getDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyGetResponse = + getDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyGetResponses[keyof getDatasetApiV1ConnectionConnectionKeyDatasetDatasetKeyGetResponses]; + +export type getDatasetConfigApiV1ConnectionConnectionKeyDatasetconfigDatasetKeyGetData = + { + body?: never; + path: { + /** + * Dataset Key + */ + dataset_key: string; + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/datasetconfig/{dataset_key}"; + }; + +export type getDatasetConfigApiV1ConnectionConnectionKeyDatasetconfigDatasetKeyGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getDatasetConfigApiV1ConnectionConnectionKeyDatasetconfigDatasetKeyGetError = + getDatasetConfigApiV1ConnectionConnectionKeyDatasetconfigDatasetKeyGetErrors[keyof getDatasetConfigApiV1ConnectionConnectionKeyDatasetconfigDatasetKeyGetErrors]; + +export type getDatasetConfigApiV1ConnectionConnectionKeyDatasetconfigDatasetKeyGetResponses = + { + /** + * Successful Response + */ + 200: DatasetConfigSchema; + }; + +export type getDatasetConfigApiV1ConnectionConnectionKeyDatasetconfigDatasetKeyGetResponse = + getDatasetConfigApiV1ConnectionConnectionKeyDatasetconfigDatasetKeyGetResponses[keyof getDatasetConfigApiV1ConnectionConnectionKeyDatasetconfigDatasetKeyGetResponses]; + +export type getCtlDatasetsApiV1FilterDatasetGetData = { + body?: never; + path?: never; + query?: { + /** + * Remove Saas Datasets + */ + remove_saas_datasets?: boolean; + /** + * Only Unlinked Datasets + */ + only_unlinked_datasets?: boolean; + }; + url: "/api/v1/filter/dataset"; +}; + +export type getCtlDatasetsApiV1FilterDatasetGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getCtlDatasetsApiV1FilterDatasetGetError = + getCtlDatasetsApiV1FilterDatasetGetErrors[keyof getCtlDatasetsApiV1FilterDatasetGetErrors]; + +export type getCtlDatasetsApiV1FilterDatasetGetResponses = { + /** + * Response Get Ctl Datasets Api V1 Filter Dataset Get + * + * Successful Response + */ + 200: Array; +}; + +export type getCtlDatasetsApiV1FilterDatasetGetResponse = + getCtlDatasetsApiV1FilterDatasetGetResponses[keyof getCtlDatasetsApiV1FilterDatasetGetResponses]; + +export type datasetIdentitiesAndReferencesApiV1ConnectionConnectionKeyDatasetDatasetKeyInputsGetData = + { + body?: never; + path: { + /** + * Dataset Key + */ + dataset_key: string; + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/dataset/{dataset_key}/inputs"; + }; + +export type datasetIdentitiesAndReferencesApiV1ConnectionConnectionKeyDatasetDatasetKeyInputsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type datasetIdentitiesAndReferencesApiV1ConnectionConnectionKeyDatasetDatasetKeyInputsGetError = + datasetIdentitiesAndReferencesApiV1ConnectionConnectionKeyDatasetDatasetKeyInputsGetErrors[keyof datasetIdentitiesAndReferencesApiV1ConnectionConnectionKeyDatasetDatasetKeyInputsGetErrors]; + +export type datasetIdentitiesAndReferencesApiV1ConnectionConnectionKeyDatasetDatasetKeyInputsGetResponses = + { + /** + * Response Dataset Identities And References Api V1 Connection Connection Key Dataset Dataset Key Inputs Get + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; + }; + +export type datasetIdentitiesAndReferencesApiV1ConnectionConnectionKeyDatasetDatasetKeyInputsGetResponse = + datasetIdentitiesAndReferencesApiV1ConnectionConnectionKeyDatasetDatasetKeyInputsGetResponses[keyof datasetIdentitiesAndReferencesApiV1ConnectionConnectionKeyDatasetDatasetKeyInputsGetResponses]; + +export type datasetReachabilityApiV1ConnectionConnectionKeyDatasetDatasetKeyReachabilityGetData = + { + body?: never; + path: { + /** + * Dataset Key + */ + dataset_key: string; + /** + * Connection Key + */ + connection_key: string; + }; + query?: { + /** + * Policy Key + */ + policy_key?: string | null; + }; + url: "/api/v1/connection/{connection_key}/dataset/{dataset_key}/reachability"; + }; + +export type datasetReachabilityApiV1ConnectionConnectionKeyDatasetDatasetKeyReachabilityGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type datasetReachabilityApiV1ConnectionConnectionKeyDatasetDatasetKeyReachabilityGetError = + datasetReachabilityApiV1ConnectionConnectionKeyDatasetDatasetKeyReachabilityGetErrors[keyof datasetReachabilityApiV1ConnectionConnectionKeyDatasetDatasetKeyReachabilityGetErrors]; + +export type datasetReachabilityApiV1ConnectionConnectionKeyDatasetDatasetKeyReachabilityGetResponses = + { + /** + * Successful Response + */ + 200: DatasetReachability; + }; + +export type datasetReachabilityApiV1ConnectionConnectionKeyDatasetDatasetKeyReachabilityGetResponse = + datasetReachabilityApiV1ConnectionConnectionKeyDatasetDatasetKeyReachabilityGetResponses[keyof datasetReachabilityApiV1ConnectionConnectionKeyDatasetDatasetKeyReachabilityGetResponses]; + +export type testConnectionDatasetsApiV1ConnectionConnectionKeyDatasetDatasetKeyTestPostData = + { + body: DatasetTestRequest; + path: { + /** + * Dataset Key + */ + dataset_key: string; + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/dataset/{dataset_key}/test"; + }; + +export type testConnectionDatasetsApiV1ConnectionConnectionKeyDatasetDatasetKeyTestPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type testConnectionDatasetsApiV1ConnectionConnectionKeyDatasetDatasetKeyTestPostError = + testConnectionDatasetsApiV1ConnectionConnectionKeyDatasetDatasetKeyTestPostErrors[keyof testConnectionDatasetsApiV1ConnectionConnectionKeyDatasetDatasetKeyTestPostErrors]; + +export type testConnectionDatasetsApiV1ConnectionConnectionKeyDatasetDatasetKeyTestPostResponses = + { + /** + * Successful Response + */ + 200: TestPrivacyRequest; + }; + +export type testConnectionDatasetsApiV1ConnectionConnectionKeyDatasetDatasetKeyTestPostResponse = + testConnectionDatasetsApiV1ConnectionConnectionKeyDatasetDatasetKeyTestPostResponses[keyof testConnectionDatasetsApiV1ConnectionConnectionKeyDatasetDatasetKeyTestPostResponses]; + +export type createDrpPrivacyRequestApiV1DrpExercisePostData = { + body: DrpPrivacyRequestCreate; + path?: never; + query?: never; + url: "/api/v1/drp/exercise"; +}; + +export type createDrpPrivacyRequestApiV1DrpExercisePostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createDrpPrivacyRequestApiV1DrpExercisePostError = + createDrpPrivacyRequestApiV1DrpExercisePostErrors[keyof createDrpPrivacyRequestApiV1DrpExercisePostErrors]; + +export type createDrpPrivacyRequestApiV1DrpExercisePostResponses = { + /** + * Successful Response + */ + 200: PrivacyRequestDRPStatusResponse; +}; + +export type createDrpPrivacyRequestApiV1DrpExercisePostResponse = + createDrpPrivacyRequestApiV1DrpExercisePostResponses[keyof createDrpPrivacyRequestApiV1DrpExercisePostResponses]; + +export type getRequestStatusDrpApiV1DrpStatusGetData = { + body?: never; + path?: never; + query: { + /** + * Request Id + */ + request_id: string; + }; + url: "/api/v1/drp/status"; +}; + +export type getRequestStatusDrpApiV1DrpStatusGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getRequestStatusDrpApiV1DrpStatusGetError = + getRequestStatusDrpApiV1DrpStatusGetErrors[keyof getRequestStatusDrpApiV1DrpStatusGetErrors]; + +export type getRequestStatusDrpApiV1DrpStatusGetResponses = { + /** + * Successful Response + */ + 200: PrivacyRequestDRPStatusResponse; +}; + +export type getRequestStatusDrpApiV1DrpStatusGetResponse = + getRequestStatusDrpApiV1DrpStatusGetResponses[keyof getRequestStatusDrpApiV1DrpStatusGetResponses]; + +export type getDrpDataRightsApiV1DrpDataRightsGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/drp/data-rights"; +}; + +export type getDrpDataRightsApiV1DrpDataRightsGetResponses = { + /** + * Successful Response + */ + 200: DrpDataRightsResponse; +}; + +export type getDrpDataRightsApiV1DrpDataRightsGetResponse = + getDrpDataRightsApiV1DrpDataRightsGetResponses[keyof getDrpDataRightsApiV1DrpDataRightsGetResponses]; + +export type revokeRequestApiV1DrpRevokePostData = { + body: DrpRevokeRequest; + path?: never; + query?: never; + url: "/api/v1/drp/revoke"; +}; + +export type revokeRequestApiV1DrpRevokePostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type revokeRequestApiV1DrpRevokePostError = + revokeRequestApiV1DrpRevokePostErrors[keyof revokeRequestApiV1DrpRevokePostErrors]; + +export type revokeRequestApiV1DrpRevokePostResponses = { + /** + * Successful Response + */ + 200: PrivacyRequestDRPStatusResponse; +}; + +export type revokeRequestApiV1DrpRevokePostResponse = + revokeRequestApiV1DrpRevokePostResponses[keyof revokeRequestApiV1DrpRevokePostResponses]; + +export type getAccessResultsUrlsApiV1PrivacyRequestPrivacyRequestIdAccessPackageGetData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query: { + /** + * Token + */ + token: string; + }; + url: "/api/v1/privacy-request/{privacy_request_id}/access-package"; + }; + +export type getAccessResultsUrlsApiV1PrivacyRequestPrivacyRequestIdAccessPackageGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAccessResultsUrlsApiV1PrivacyRequestPrivacyRequestIdAccessPackageGetError = + getAccessResultsUrlsApiV1PrivacyRequestPrivacyRequestIdAccessPackageGetErrors[keyof getAccessResultsUrlsApiV1PrivacyRequestPrivacyRequestIdAccessPackageGetErrors]; + +export type getEncryptionKeyApiV1CryptographyEncryptionKeyGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/cryptography/encryption/key"; +}; + +export type getEncryptionKeyApiV1CryptographyEncryptionKeyGetResponses = { + /** + * Response Get Encryption Key Api V1 Cryptography Encryption Key Get + * + * Successful Response + */ + 200: string; +}; + +export type getEncryptionKeyApiV1CryptographyEncryptionKeyGetResponse = + getEncryptionKeyApiV1CryptographyEncryptionKeyGetResponses[keyof getEncryptionKeyApiV1CryptographyEncryptionKeyGetResponses]; + +export type aesEncryptApiV1CryptographyEncryptionAesEncryptPutData = { + body: AesEncryptionRequest; + path?: never; + query?: never; + url: "/api/v1/cryptography/encryption/aes/encrypt"; +}; + +export type aesEncryptApiV1CryptographyEncryptionAesEncryptPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type aesEncryptApiV1CryptographyEncryptionAesEncryptPutError = + aesEncryptApiV1CryptographyEncryptionAesEncryptPutErrors[keyof aesEncryptApiV1CryptographyEncryptionAesEncryptPutErrors]; + +export type aesEncryptApiV1CryptographyEncryptionAesEncryptPutResponses = { + /** + * Successful Response + */ + 200: AesEncryptionResponse; +}; + +export type aesEncryptApiV1CryptographyEncryptionAesEncryptPutResponse = + aesEncryptApiV1CryptographyEncryptionAesEncryptPutResponses[keyof aesEncryptApiV1CryptographyEncryptionAesEncryptPutResponses]; + +export type aesDecryptApiV1CryptographyEncryptionAesDecryptPutData = { + body: AesDecryptionRequest; + path?: never; + query?: never; + url: "/api/v1/cryptography/encryption/aes/decrypt"; +}; + +export type aesDecryptApiV1CryptographyEncryptionAesDecryptPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type aesDecryptApiV1CryptographyEncryptionAesDecryptPutError = + aesDecryptApiV1CryptographyEncryptionAesDecryptPutErrors[keyof aesDecryptApiV1CryptographyEncryptionAesDecryptPutErrors]; + +export type aesDecryptApiV1CryptographyEncryptionAesDecryptPutResponses = { + /** + * Successful Response + */ + 200: AesDecryptionResponse; +}; + +export type aesDecryptApiV1CryptographyEncryptionAesDecryptPutResponse = + aesDecryptApiV1CryptographyEncryptionAesDecryptPutResponses[keyof aesDecryptApiV1CryptographyEncryptionAesDecryptPutResponses]; + +export type maskValueApiV1MaskingMaskPutData = { + body: MaskingAPIRequest; + path?: never; + query?: never; + url: "/api/v1/masking/mask"; +}; + +export type maskValueApiV1MaskingMaskPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type maskValueApiV1MaskingMaskPutError = + maskValueApiV1MaskingMaskPutErrors[keyof maskValueApiV1MaskingMaskPutErrors]; + +export type maskValueApiV1MaskingMaskPutResponses = { + /** + * Successful Response + */ + 200: MaskingAPIResponse; +}; + +export type maskValueApiV1MaskingMaskPutResponse = + maskValueApiV1MaskingMaskPutResponses[keyof maskValueApiV1MaskingMaskPutResponses]; + +export type listMaskingStrategiesApiV1MaskingStrategyGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/masking/strategy"; +}; + +export type listMaskingStrategiesApiV1MaskingStrategyGetResponses = { + /** + * Response List Masking Strategies Api V1 Masking Strategy Get + * + * Successful Response + */ + 200: Array; +}; + +export type listMaskingStrategiesApiV1MaskingStrategyGetResponse = + listMaskingStrategiesApiV1MaskingStrategyGetResponses[keyof listMaskingStrategiesApiV1MaskingStrategyGetResponses]; + +export type acquireAccessTokenApiV1OauthTokenPostData = { + body?: Body_acquire_access_token_api_v1_oauth_token_post; + path?: never; + query?: never; + url: "/api/v1/oauth/token"; +}; + +export type acquireAccessTokenApiV1OauthTokenPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type acquireAccessTokenApiV1OauthTokenPostError = + acquireAccessTokenApiV1OauthTokenPostErrors[keyof acquireAccessTokenApiV1OauthTokenPostErrors]; + +export type acquireAccessTokenApiV1OauthTokenPostResponses = { + /** + * Successful Response + */ + 200: AccessToken; +}; + +export type acquireAccessTokenApiV1OauthTokenPostResponse = + acquireAccessTokenApiV1OauthTokenPostResponses[keyof acquireAccessTokenApiV1OauthTokenPostResponses]; + +export type createClientApiV1OauthClientPostData = { + /** + * Scopes + */ + body?: Array; + path?: never; + query?: never; + url: "/api/v1/oauth/client"; +}; + +export type createClientApiV1OauthClientPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createClientApiV1OauthClientPostError = + createClientApiV1OauthClientPostErrors[keyof createClientApiV1OauthClientPostErrors]; + +export type createClientApiV1OauthClientPostResponses = { + /** + * Successful Response + */ + 200: ClientCreatedResponse; +}; + +export type createClientApiV1OauthClientPostResponse = + createClientApiV1OauthClientPostResponses[keyof createClientApiV1OauthClientPostResponses]; + +export type deleteClientApiV1OauthClientClientIdDeleteData = { + body?: never; + path: { + /** + * Client Id + */ + client_id: string; + }; + query?: never; + url: "/api/v1/oauth/client/{client_id}"; +}; + +export type deleteClientApiV1OauthClientClientIdDeleteErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteClientApiV1OauthClientClientIdDeleteError = + deleteClientApiV1OauthClientClientIdDeleteErrors[keyof deleteClientApiV1OauthClientClientIdDeleteErrors]; + +export type deleteClientApiV1OauthClientClientIdDeleteResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type getClientScopesApiV1OauthClientClientIdScopeGetData = { + body?: never; + path: { + /** + * Client Id + */ + client_id: string; + }; + query?: never; + url: "/api/v1/oauth/client/{client_id}/scope"; +}; + +export type getClientScopesApiV1OauthClientClientIdScopeGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getClientScopesApiV1OauthClientClientIdScopeGetError = + getClientScopesApiV1OauthClientClientIdScopeGetErrors[keyof getClientScopesApiV1OauthClientClientIdScopeGetErrors]; + +export type getClientScopesApiV1OauthClientClientIdScopeGetResponses = { + /** + * Response Get Client Scopes Api V1 Oauth Client Client Id Scope Get + * + * Successful Response + */ + 200: Array; +}; + +export type getClientScopesApiV1OauthClientClientIdScopeGetResponse = + getClientScopesApiV1OauthClientClientIdScopeGetResponses[keyof getClientScopesApiV1OauthClientClientIdScopeGetResponses]; + +export type setClientScopesApiV1OauthClientClientIdScopePutData = { + /** + * Scopes + */ + body: Array; + path: { + /** + * Client Id + */ + client_id: string; + }; + query?: never; + url: "/api/v1/oauth/client/{client_id}/scope"; +}; + +export type setClientScopesApiV1OauthClientClientIdScopePutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type setClientScopesApiV1OauthClientClientIdScopePutError = + setClientScopesApiV1OauthClientClientIdScopePutErrors[keyof setClientScopesApiV1OauthClientClientIdScopePutErrors]; + +export type setClientScopesApiV1OauthClientClientIdScopePutResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type readRolesToScopesMappingApiV1OauthRoleGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/oauth/role"; +}; + +export type readRolesToScopesMappingApiV1OauthRoleGetResponses = { + /** + * Response Read Roles To Scopes Mapping Api V1 Oauth Role Get + * + * Successful Response + */ + 200: { + [key: string]: Array; + }; +}; + +export type readRolesToScopesMappingApiV1OauthRoleGetResponse = + readRolesToScopesMappingApiV1OauthRoleGetResponses[keyof readRolesToScopesMappingApiV1OauthRoleGetResponses]; + +export type oauthCallbackApiV1OauthCallbackGetData = { + body?: never; + path?: never; + query: { + /** + * Code + */ + code: string; + /** + * State + */ + state: string; + }; + url: "/api/v1/oauth/callback"; +}; + +export type oauthCallbackApiV1OauthCallbackGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type oauthCallbackApiV1OauthCallbackGetError = + oauthCallbackApiV1OauthCallbackGetErrors[keyof oauthCallbackApiV1OauthCallbackGetErrors]; + +export type oauthCallbackApiV1OauthCallbackGetResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type getPolicyListApiV1DsrPolicyGetData = { + body?: never; + path?: never; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/dsr/policy"; +}; + +export type getPolicyListApiV1DsrPolicyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getPolicyListApiV1DsrPolicyGetError = + getPolicyListApiV1DsrPolicyGetErrors[keyof getPolicyListApiV1DsrPolicyGetErrors]; + +export type getPolicyListApiV1DsrPolicyGetResponses = { + /** + * Successful Response + */ + 200: Page_PolicyResponse_; +}; + +export type getPolicyListApiV1DsrPolicyGetResponse = + getPolicyListApiV1DsrPolicyGetResponses[keyof getPolicyListApiV1DsrPolicyGetResponses]; + +export type createOrUpdatePoliciesApiV1DsrPolicyPatchData = { + /** + * Data + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/dsr/policy"; +}; + +export type createOrUpdatePoliciesApiV1DsrPolicyPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createOrUpdatePoliciesApiV1DsrPolicyPatchError = + createOrUpdatePoliciesApiV1DsrPolicyPatchErrors[keyof createOrUpdatePoliciesApiV1DsrPolicyPatchErrors]; + +export type createOrUpdatePoliciesApiV1DsrPolicyPatchResponses = { + /** + * Successful Response + */ + 200: BulkPutPolicyResponse; +}; + +export type createOrUpdatePoliciesApiV1DsrPolicyPatchResponse = + createOrUpdatePoliciesApiV1DsrPolicyPatchResponses[keyof createOrUpdatePoliciesApiV1DsrPolicyPatchResponses]; + +export type deletePolicyApiV1DsrPolicyPolicyKeyDeleteData = { + body?: never; + path: { + /** + * Policy Key + */ + policy_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}"; +}; + +export type deletePolicyApiV1DsrPolicyPolicyKeyDeleteErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deletePolicyApiV1DsrPolicyPolicyKeyDeleteError = + deletePolicyApiV1DsrPolicyPolicyKeyDeleteErrors[keyof deletePolicyApiV1DsrPolicyPolicyKeyDeleteErrors]; + +export type deletePolicyApiV1DsrPolicyPolicyKeyDeleteResponses = { + /** + * Successful Response + */ + 204: void; +}; + +export type deletePolicyApiV1DsrPolicyPolicyKeyDeleteResponse = + deletePolicyApiV1DsrPolicyPolicyKeyDeleteResponses[keyof deletePolicyApiV1DsrPolicyPolicyKeyDeleteResponses]; + +export type getPolicyApiV1DsrPolicyPolicyKeyGetData = { + body?: never; + path: { + /** + * Policy Key + */ + policy_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}"; +}; + +export type getPolicyApiV1DsrPolicyPolicyKeyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getPolicyApiV1DsrPolicyPolicyKeyGetError = + getPolicyApiV1DsrPolicyPolicyKeyGetErrors[keyof getPolicyApiV1DsrPolicyPolicyKeyGetErrors]; + +export type getPolicyApiV1DsrPolicyPolicyKeyGetResponses = { + /** + * Successful Response + */ + 200: PolicyResponse; +}; + +export type getPolicyApiV1DsrPolicyPolicyKeyGetResponse = + getPolicyApiV1DsrPolicyPolicyKeyGetResponses[keyof getPolicyApiV1DsrPolicyPolicyKeyGetResponses]; + +export type getRuleListApiV1DsrPolicyPolicyKeyRuleGetData = { + body?: never; + path: { + /** + * Policy Key + */ + policy_key: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/dsr/policy/{policy_key}/rule"; +}; + +export type getRuleListApiV1DsrPolicyPolicyKeyRuleGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getRuleListApiV1DsrPolicyPolicyKeyRuleGetError = + getRuleListApiV1DsrPolicyPolicyKeyRuleGetErrors[keyof getRuleListApiV1DsrPolicyPolicyKeyRuleGetErrors]; + +export type getRuleListApiV1DsrPolicyPolicyKeyRuleGetResponses = { + /** + * Successful Response + */ + 200: Page_RuleResponseWithTargets_; +}; + +export type getRuleListApiV1DsrPolicyPolicyKeyRuleGetResponse = + getRuleListApiV1DsrPolicyPolicyKeyRuleGetResponses[keyof getRuleListApiV1DsrPolicyPolicyKeyRuleGetResponses]; + +export type createOrUpdateRulesApiV1DsrPolicyPolicyKeyRulePatchData = { + /** + * Input Data + */ + body: Array; + path: { + /** + * Policy Key + */ + policy_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}/rule"; +}; + +export type createOrUpdateRulesApiV1DsrPolicyPolicyKeyRulePatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createOrUpdateRulesApiV1DsrPolicyPolicyKeyRulePatchError = + createOrUpdateRulesApiV1DsrPolicyPolicyKeyRulePatchErrors[keyof createOrUpdateRulesApiV1DsrPolicyPolicyKeyRulePatchErrors]; + +export type createOrUpdateRulesApiV1DsrPolicyPolicyKeyRulePatchResponses = { + /** + * Successful Response + */ + 200: BulkPutRuleResponse; +}; + +export type createOrUpdateRulesApiV1DsrPolicyPolicyKeyRulePatchResponse = + createOrUpdateRulesApiV1DsrPolicyPolicyKeyRulePatchResponses[keyof createOrUpdateRulesApiV1DsrPolicyPolicyKeyRulePatchResponses]; + +export type deleteRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyDeleteData = { + body?: never; + path: { + /** + * Policy Key + */ + policy_key: string; + /** + * Rule Key + */ + rule_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}/rule/{rule_key}"; +}; + +export type deleteRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyDeleteErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyDeleteError = + deleteRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyDeleteErrors[keyof deleteRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyDeleteErrors]; + +export type deleteRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyDeleteResponses = { + /** + * Successful Response + */ + 204: void; +}; + +export type deleteRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyDeleteResponse = + deleteRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyDeleteResponses[keyof deleteRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyDeleteResponses]; + +export type getRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyGetData = { + body?: never; + path: { + /** + * Policy Key + */ + policy_key: string; + /** + * Rule Key + */ + rule_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}/rule/{rule_key}"; +}; + +export type getRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyGetError = + getRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyGetErrors[keyof getRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyGetErrors]; + +export type getRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyGetResponses = { + /** + * Successful Response + */ + 200: RuleResponseWithTargets; +}; + +export type getRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyGetResponse = + getRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyGetResponses[keyof getRuleApiV1DsrPolicyPolicyKeyRuleRuleKeyGetResponses]; + +export type getRuleTargetListApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetGetData = { + body?: never; + path: { + /** + * Policy Key + */ + policy_key: string; + /** + * Rule Key + */ + rule_key: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/dsr/policy/{policy_key}/rule/{rule_key}/target"; +}; + +export type getRuleTargetListApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getRuleTargetListApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetGetError = + getRuleTargetListApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetGetErrors[keyof getRuleTargetListApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetGetErrors]; + +export type getRuleTargetListApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetGetResponses = + { + /** + * Successful Response + */ + 200: Page_RuleTarget_; + }; + +export type getRuleTargetListApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetGetResponse = + getRuleTargetListApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetGetResponses[keyof getRuleTargetListApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetGetResponses]; + +export type createOrUpdateRuleTargetsApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetPatchData = + { + /** + * Input Data + */ + body: Array; + path: { + /** + * Policy Key + */ + policy_key: string; + /** + * Rule Key + */ + rule_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}/rule/{rule_key}/target"; + }; + +export type createOrUpdateRuleTargetsApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createOrUpdateRuleTargetsApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetPatchError = + createOrUpdateRuleTargetsApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetPatchErrors[keyof createOrUpdateRuleTargetsApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetPatchErrors]; + +export type createOrUpdateRuleTargetsApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetPatchResponses = + { + /** + * Successful Response + */ + 200: BulkPutRuleTargetResponse; + }; + +export type createOrUpdateRuleTargetsApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetPatchResponse = + createOrUpdateRuleTargetsApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetPatchResponses[keyof createOrUpdateRuleTargetsApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetPatchResponses]; + +export type deleteRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyDeleteData = + { + body?: never; + path: { + /** + * Policy Key + */ + policy_key: string; + /** + * Rule Key + */ + rule_key: string; + /** + * Rule Target Key + */ + rule_target_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}/rule/{rule_key}/target/{rule_target_key}"; + }; + +export type deleteRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyDeleteError = + deleteRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyDeleteErrors[keyof deleteRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyDeleteErrors]; + +export type deleteRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deleteRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyDeleteResponse = + deleteRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyDeleteResponses[keyof deleteRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyDeleteResponses]; + +export type getRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyGetData = + { + body?: never; + path: { + /** + * Policy Key + */ + policy_key: string; + /** + * Rule Key + */ + rule_key: string; + /** + * Rule Target Key + */ + rule_target_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}/rule/{rule_key}/target/{rule_target_key}"; + }; + +export type getRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyGetError = + getRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyGetErrors[keyof getRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyGetErrors]; + +export type getRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyGetResponses = + { + /** + * Successful Response + */ + 200: RuleTarget; + }; + +export type getRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyGetResponse = + getRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyGetResponses[keyof getRuleTargetApiV1DsrPolicyPolicyKeyRuleRuleKeyTargetRuleTargetKeyGetResponses]; + +export type getPolicyPreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionGetData = + { + body?: never; + path: { + /** + * Policy Key + */ + policy_key: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/dsr/policy/{policy_key}/webhook/pre_execution"; + }; + +export type getPolicyPreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getPolicyPreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionGetError = + getPolicyPreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionGetErrors[keyof getPolicyPreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionGetErrors]; + +export type getPolicyPreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionGetResponses = + { + /** + * Successful Response + */ + 200: Page_PolicyWebhookResponse_; + }; + +export type getPolicyPreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionGetResponse = + getPolicyPreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionGetResponses[keyof getPolicyPreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionGetResponses]; + +export type createOrUpdatePreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionPutData = + { + /** + * Webhooks + */ + body: Array; + path: { + /** + * Policy Key + */ + policy_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}/webhook/pre_execution"; + }; + +export type createOrUpdatePreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createOrUpdatePreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionPutError = + createOrUpdatePreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionPutErrors[keyof createOrUpdatePreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionPutErrors]; + +export type createOrUpdatePreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionPutResponses = + { + /** + * Response Create Or Update Pre Execution Webhooks Api V1 Dsr Policy Policy Key Webhook Pre Execution Put + * + * Successful Response + */ + 200: Array; + }; + +export type createOrUpdatePreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionPutResponse = + createOrUpdatePreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionPutResponses[keyof createOrUpdatePreExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPreExecutionPutResponses]; + +export type getPolicyPostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionGetData = + { + body?: never; + path: { + /** + * Policy Key + */ + policy_key: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/dsr/policy/{policy_key}/webhook/post_execution"; + }; + +export type getPolicyPostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getPolicyPostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionGetError = + getPolicyPostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionGetErrors[keyof getPolicyPostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionGetErrors]; + +export type getPolicyPostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionGetResponses = + { + /** + * Successful Response + */ + 200: Page_PolicyWebhookResponse_; + }; + +export type getPolicyPostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionGetResponse = + getPolicyPostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionGetResponses[keyof getPolicyPostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionGetResponses]; + +export type createOrUpdatePostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionPutData = + { + /** + * Webhooks + */ + body: Array; + path: { + /** + * Policy Key + */ + policy_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}/webhook/post_execution"; + }; + +export type createOrUpdatePostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createOrUpdatePostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionPutError = + createOrUpdatePostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionPutErrors[keyof createOrUpdatePostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionPutErrors]; + +export type createOrUpdatePostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionPutResponses = + { + /** + * Response Create Or Update Post Execution Webhooks Api V1 Dsr Policy Policy Key Webhook Post Execution Put + * + * Successful Response + */ + 200: Array; + }; + +export type createOrUpdatePostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionPutResponse = + createOrUpdatePostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionPutResponses[keyof createOrUpdatePostExecutionWebhooksApiV1DsrPolicyPolicyKeyWebhookPostExecutionPutResponses]; + +export type deletePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyDeleteData = + { + body?: never; + path: { + /** + * Policy Key + */ + policy_key: string; + /** + * Pre Webhook Key + */ + pre_webhook_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}/webhook/pre_execution/{pre_webhook_key}"; + }; + +export type deletePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deletePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyDeleteError = + deletePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyDeleteErrors[keyof deletePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyDeleteErrors]; + +export type deletePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyDeleteResponses = + { + /** + * Successful Response + */ + 200: PolicyWebhookDeleteResponse; + }; + +export type deletePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyDeleteResponse = + deletePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyDeleteResponses[keyof deletePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyDeleteResponses]; + +export type getPolicyPreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyGetData = + { + body?: never; + path: { + /** + * Policy Key + */ + policy_key: string; + /** + * Pre Webhook Key + */ + pre_webhook_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}/webhook/pre_execution/{pre_webhook_key}"; + }; + +export type getPolicyPreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getPolicyPreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyGetError = + getPolicyPreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyGetErrors[keyof getPolicyPreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyGetErrors]; + +export type getPolicyPreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyGetResponses = + { + /** + * Successful Response + */ + 200: PolicyWebhookResponse; + }; + +export type getPolicyPreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyGetResponse = + getPolicyPreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyGetResponses[keyof getPolicyPreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyGetResponses]; + +export type updatePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyPatchData = + { + body: PolicyWebhookUpdate; + path: { + /** + * Policy Key + */ + policy_key: string; + /** + * Pre Webhook Key + */ + pre_webhook_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}/webhook/pre_execution/{pre_webhook_key}"; + }; + +export type updatePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updatePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyPatchError = + updatePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyPatchErrors[keyof updatePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyPatchErrors]; + +export type updatePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyPatchResponses = + { + /** + * Successful Response + */ + 200: PolicyWebhookUpdateResponse; + }; + +export type updatePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyPatchResponse = + updatePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyPatchResponses[keyof updatePreExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPreExecutionPreWebhookKeyPatchResponses]; + +export type deletePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyDeleteData = + { + body?: never; + path: { + /** + * Policy Key + */ + policy_key: string; + /** + * Post Webhook Key + */ + post_webhook_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}/webhook/post_execution/{post_webhook_key}"; + }; + +export type deletePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deletePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyDeleteError = + deletePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyDeleteErrors[keyof deletePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyDeleteErrors]; + +export type deletePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyDeleteResponses = + { + /** + * Successful Response + */ + 200: PolicyWebhookDeleteResponse; + }; + +export type deletePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyDeleteResponse = + deletePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyDeleteResponses[keyof deletePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyDeleteResponses]; + +export type getPolicyPostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyGetData = + { + body?: never; + path: { + /** + * Policy Key + */ + policy_key: string; + /** + * Post Webhook Key + */ + post_webhook_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}/webhook/post_execution/{post_webhook_key}"; + }; + +export type getPolicyPostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getPolicyPostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyGetError = + getPolicyPostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyGetErrors[keyof getPolicyPostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyGetErrors]; + +export type getPolicyPostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyGetResponses = + { + /** + * Successful Response + */ + 200: PolicyWebhookResponse; + }; + +export type getPolicyPostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyGetResponse = + getPolicyPostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyGetResponses[keyof getPolicyPostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyGetResponses]; + +export type updatePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyPatchData = + { + body: PolicyWebhookUpdate; + path: { + /** + * Policy Key + */ + policy_key: string; + /** + * Post Webhook Key + */ + post_webhook_key: string; + }; + query?: never; + url: "/api/v1/dsr/policy/{policy_key}/webhook/post_execution/{post_webhook_key}"; + }; + +export type updatePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updatePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyPatchError = + updatePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyPatchErrors[keyof updatePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyPatchErrors]; + +export type updatePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyPatchResponses = + { + /** + * Successful Response + */ + 200: PolicyWebhookUpdateResponse; + }; + +export type updatePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyPatchResponse = + updatePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyPatchResponses[keyof updatePostExecutionWebhookApiV1DsrPolicyPolicyKeyWebhookPostExecutionPostWebhookKeyPatchResponses]; + +export type getPreApprovalWebhookListApiV1DsrWebhookPreApprovalGetData = { + body?: never; + path?: never; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/dsr/webhook/pre_approval"; +}; + +export type getPreApprovalWebhookListApiV1DsrWebhookPreApprovalGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getPreApprovalWebhookListApiV1DsrWebhookPreApprovalGetError = + getPreApprovalWebhookListApiV1DsrWebhookPreApprovalGetErrors[keyof getPreApprovalWebhookListApiV1DsrWebhookPreApprovalGetErrors]; + +export type getPreApprovalWebhookListApiV1DsrWebhookPreApprovalGetResponses = { + /** + * Successful Response + */ + 200: Page_PreApprovalWebhookResponse_; +}; + +export type getPreApprovalWebhookListApiV1DsrWebhookPreApprovalGetResponse = + getPreApprovalWebhookListApiV1DsrWebhookPreApprovalGetResponses[keyof getPreApprovalWebhookListApiV1DsrWebhookPreApprovalGetResponses]; + +export type createOrUpdatePreApprovalWebhooksApiV1DsrWebhookPreApprovalPutData = + { + /** + * Webhooks + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/dsr/webhook/pre_approval"; + }; + +export type createOrUpdatePreApprovalWebhooksApiV1DsrWebhookPreApprovalPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createOrUpdatePreApprovalWebhooksApiV1DsrWebhookPreApprovalPutError = + createOrUpdatePreApprovalWebhooksApiV1DsrWebhookPreApprovalPutErrors[keyof createOrUpdatePreApprovalWebhooksApiV1DsrWebhookPreApprovalPutErrors]; + +export type createOrUpdatePreApprovalWebhooksApiV1DsrWebhookPreApprovalPutResponses = + { + /** + * Response Create Or Update Pre Approval Webhooks Api V1 Dsr Webhook Pre Approval Put + * + * Successful Response + */ + 200: Array; + }; + +export type createOrUpdatePreApprovalWebhooksApiV1DsrWebhookPreApprovalPutResponse = + createOrUpdatePreApprovalWebhooksApiV1DsrWebhookPreApprovalPutResponses[keyof createOrUpdatePreApprovalWebhooksApiV1DsrWebhookPreApprovalPutResponses]; + +export type deletePreApprovalWebhookApiV1DsrWebhookPreApprovalWebhookKeyDeleteData = + { + body?: never; + path: { + /** + * Webhook Key + */ + webhook_key: string; + }; + query?: never; + url: "/api/v1/dsr/webhook/pre_approval/{webhook_key}"; + }; + +export type deletePreApprovalWebhookApiV1DsrWebhookPreApprovalWebhookKeyDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deletePreApprovalWebhookApiV1DsrWebhookPreApprovalWebhookKeyDeleteError = + deletePreApprovalWebhookApiV1DsrWebhookPreApprovalWebhookKeyDeleteErrors[keyof deletePreApprovalWebhookApiV1DsrWebhookPreApprovalWebhookKeyDeleteErrors]; + +export type deletePreApprovalWebhookApiV1DsrWebhookPreApprovalWebhookKeyDeleteResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getPreApprovalWebhookDetailApiV1DsrWebhookPreApprovalWebhookKeyGetData = + { + body?: never; + path: { + /** + * Webhook Key + */ + webhook_key: string; + }; + query?: never; + url: "/api/v1/dsr/webhook/pre_approval/{webhook_key}"; + }; + +export type getPreApprovalWebhookDetailApiV1DsrWebhookPreApprovalWebhookKeyGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getPreApprovalWebhookDetailApiV1DsrWebhookPreApprovalWebhookKeyGetError = + getPreApprovalWebhookDetailApiV1DsrWebhookPreApprovalWebhookKeyGetErrors[keyof getPreApprovalWebhookDetailApiV1DsrWebhookPreApprovalWebhookKeyGetErrors]; + +export type getPreApprovalWebhookDetailApiV1DsrWebhookPreApprovalWebhookKeyGetResponses = + { + /** + * Successful Response + */ + 200: PreApprovalWebhookResponse; + }; + +export type getPreApprovalWebhookDetailApiV1DsrWebhookPreApprovalWebhookKeyGetResponse = + getPreApprovalWebhookDetailApiV1DsrWebhookPreApprovalWebhookKeyGetResponses[keyof getPreApprovalWebhookDetailApiV1DsrWebhookPreApprovalWebhookKeyGetResponses]; + +export type updatePreApprovalWebhookApiV1DsrWebhookPreApprovalWebhookKeyPatchData = + { + body: PreApprovalWebhookUpdate; + path: { + /** + * Webhook Key + */ + webhook_key: string; + }; + query?: never; + url: "/api/v1/dsr/webhook/pre_approval/{webhook_key}"; + }; + +export type updatePreApprovalWebhookApiV1DsrWebhookPreApprovalWebhookKeyPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updatePreApprovalWebhookApiV1DsrWebhookPreApprovalWebhookKeyPatchError = + updatePreApprovalWebhookApiV1DsrWebhookPreApprovalWebhookKeyPatchErrors[keyof updatePreApprovalWebhookApiV1DsrWebhookPreApprovalWebhookKeyPatchErrors]; + +export type updatePreApprovalWebhookApiV1DsrWebhookPreApprovalWebhookKeyPatchResponses = + { + /** + * Successful Response + */ + 200: PreApprovalWebhookResponse; + }; + +export type updatePreApprovalWebhookApiV1DsrWebhookPreApprovalWebhookKeyPatchResponse = + updatePreApprovalWebhookApiV1DsrWebhookPreApprovalWebhookKeyPatchResponses[keyof updatePreApprovalWebhookApiV1DsrWebhookPreApprovalWebhookKeyPatchResponses]; + +export type getRequestStatusApiV1PrivacyRequestGetData = { + body?: never; + path?: never; + query?: { + /** + * Request Id + */ + request_id?: string | null; + /** + * Identity + */ + identity?: string | null; + /** + * Status + */ + status?: Array | null; + /** + * Fuzzy Search Str + */ + fuzzy_search_str?: string | null; + /** + * Created Lt + */ + created_lt?: string | null; + /** + * Created Gt + */ + created_gt?: string | null; + /** + * Started Lt + */ + started_lt?: string | null; + /** + * Started Gt + */ + started_gt?: string | null; + /** + * Completed Lt + */ + completed_lt?: string | null; + /** + * Completed Gt + */ + completed_gt?: string | null; + /** + * Errored Lt + */ + errored_lt?: string | null; + /** + * Errored Gt + */ + errored_gt?: string | null; + /** + * External Id + */ + external_id?: string | null; + /** + * Location + */ + location?: string | null; + /** + * Action Type + */ + action_type?: ActionType | null; + /** + * Verbose + */ + verbose?: boolean | null; + /** + * Include Identities + */ + include_identities?: boolean | null; + /** + * Include Custom Privacy Request Fields + */ + include_custom_privacy_request_fields?: boolean | null; + /** + * Download Csv + */ + download_csv?: boolean | null; + /** + * Include Deleted Requests + */ + include_deleted_requests?: boolean | null; + /** + * Sort Field + */ + sort_field?: string; + sort_direction?: ColumnSort; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/privacy-request"; +}; + +export type getRequestStatusApiV1PrivacyRequestGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getRequestStatusApiV1PrivacyRequestGetError = + getRequestStatusApiV1PrivacyRequestGetErrors[keyof getRequestStatusApiV1PrivacyRequestGetErrors]; + +export type getRequestStatusApiV1PrivacyRequestGetResponses = { + /** + * Successful Response + */ + 200: Page_Union_PrivacyRequestVerboseResponse__PrivacyRequestResponse__; +}; + +export type getRequestStatusApiV1PrivacyRequestGetResponse = + getRequestStatusApiV1PrivacyRequestGetResponses[keyof getRequestStatusApiV1PrivacyRequestGetResponses]; + +export type createPrivacyRequestApiV1PrivacyRequestPostData = { + /** + * Data + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/privacy-request"; +}; + +export type createPrivacyRequestApiV1PrivacyRequestPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createPrivacyRequestApiV1PrivacyRequestPostError = + createPrivacyRequestApiV1PrivacyRequestPostErrors[keyof createPrivacyRequestApiV1PrivacyRequestPostErrors]; + +export type createPrivacyRequestApiV1PrivacyRequestPostResponses = { + /** + * Successful Response + */ + 200: BulkPostPrivacyRequests; +}; + +export type createPrivacyRequestApiV1PrivacyRequestPostResponse = + createPrivacyRequestApiV1PrivacyRequestPostResponses[keyof createPrivacyRequestApiV1PrivacyRequestPostResponses]; + +export type privacyRequestSearchApiV1PrivacyRequestSearchPostData = { + /** + * Privacy Request Filter + */ + body?: PrivacyRequestFilter | null; + path?: never; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/privacy-request/search"; +}; + +export type privacyRequestSearchApiV1PrivacyRequestSearchPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type privacyRequestSearchApiV1PrivacyRequestSearchPostError = + privacyRequestSearchApiV1PrivacyRequestSearchPostErrors[keyof privacyRequestSearchApiV1PrivacyRequestSearchPostErrors]; + +export type privacyRequestSearchApiV1PrivacyRequestSearchPostResponses = { + /** + * Successful Response + */ + 200: Page_Union_PrivacyRequestVerboseResponse__PrivacyRequestResponse__; +}; + +export type privacyRequestSearchApiV1PrivacyRequestSearchPostResponse = + privacyRequestSearchApiV1PrivacyRequestSearchPostResponses[keyof privacyRequestSearchApiV1PrivacyRequestSearchPostResponses]; + +export type getRequestStatusLogsApiV1PrivacyRequestPrivacyRequestIdLogGetData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/privacy-request/{privacy_request_id}/log"; + }; + +export type getRequestStatusLogsApiV1PrivacyRequestPrivacyRequestIdLogGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getRequestStatusLogsApiV1PrivacyRequestPrivacyRequestIdLogGetError = + getRequestStatusLogsApiV1PrivacyRequestPrivacyRequestIdLogGetErrors[keyof getRequestStatusLogsApiV1PrivacyRequestPrivacyRequestIdLogGetErrors]; + +export type getRequestStatusLogsApiV1PrivacyRequestPrivacyRequestIdLogGetResponses = + { + /** + * Successful Response + */ + 200: Page_ExecutionLogDetailResponse_; + }; + +export type getRequestStatusLogsApiV1PrivacyRequestPrivacyRequestIdLogGetResponse = + getRequestStatusLogsApiV1PrivacyRequestPrivacyRequestIdLogGetResponses[keyof getRequestStatusLogsApiV1PrivacyRequestPrivacyRequestIdLogGetResponses]; + +export type getPrivacyRequestDiagnosticsReportApiV1PrivacyRequestPrivacyRequestIdDiagnosticsGetData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/diagnostics"; + }; + +export type getPrivacyRequestDiagnosticsReportApiV1PrivacyRequestPrivacyRequestIdDiagnosticsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getPrivacyRequestDiagnosticsReportApiV1PrivacyRequestPrivacyRequestIdDiagnosticsGetError = + getPrivacyRequestDiagnosticsReportApiV1PrivacyRequestPrivacyRequestIdDiagnosticsGetErrors[keyof getPrivacyRequestDiagnosticsReportApiV1PrivacyRequestPrivacyRequestIdDiagnosticsGetErrors]; + +export type getPrivacyRequestDiagnosticsReportApiV1PrivacyRequestPrivacyRequestIdDiagnosticsGetResponses = + { + /** + * Successful Response + */ + 200: PrivacyRequestDiagnosticsExportResponse; + }; + +export type getPrivacyRequestDiagnosticsReportApiV1PrivacyRequestPrivacyRequestIdDiagnosticsGetResponse = + getPrivacyRequestDiagnosticsReportApiV1PrivacyRequestPrivacyRequestIdDiagnosticsGetResponses[keyof getPrivacyRequestDiagnosticsReportApiV1PrivacyRequestPrivacyRequestIdDiagnosticsGetResponses]; + +export type getPrivacyRequestNotificationInfoApiV1PrivacyRequestNotificationGetData = + { + body?: never; + path?: never; + query?: never; + url: "/api/v1/privacy-request/notification"; + }; + +export type getPrivacyRequestNotificationInfoApiV1PrivacyRequestNotificationGetResponses = + { + /** + * Successful Response + */ + 200: PrivacyRequestNotificationInfo; + }; + +export type getPrivacyRequestNotificationInfoApiV1PrivacyRequestNotificationGetResponse = + getPrivacyRequestNotificationInfoApiV1PrivacyRequestNotificationGetResponses[keyof getPrivacyRequestNotificationInfoApiV1PrivacyRequestNotificationGetResponses]; + +export type createOrUpdatePrivacyRequestNotificationsApiV1PrivacyRequestNotificationPutData = + { + body: PrivacyRequestNotificationInfo; + path?: never; + query?: never; + url: "/api/v1/privacy-request/notification"; + }; + +export type createOrUpdatePrivacyRequestNotificationsApiV1PrivacyRequestNotificationPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createOrUpdatePrivacyRequestNotificationsApiV1PrivacyRequestNotificationPutError = + createOrUpdatePrivacyRequestNotificationsApiV1PrivacyRequestNotificationPutErrors[keyof createOrUpdatePrivacyRequestNotificationsApiV1PrivacyRequestNotificationPutErrors]; + +export type createOrUpdatePrivacyRequestNotificationsApiV1PrivacyRequestNotificationPutResponses = + { + /** + * Successful Response + */ + 200: PrivacyRequestNotificationInfo; + }; + +export type createOrUpdatePrivacyRequestNotificationsApiV1PrivacyRequestNotificationPutResponse = + createOrUpdatePrivacyRequestNotificationsApiV1PrivacyRequestNotificationPutResponses[keyof createOrUpdatePrivacyRequestNotificationsApiV1PrivacyRequestNotificationPutResponses]; + +export type getRequestPreviewQueriesApiV1PrivacyRequestPreviewPutData = { + /** + * Dataset Keys + */ + body?: Array | null; + path?: never; + query?: never; + url: "/api/v1/privacy-request/preview"; +}; + +export type getRequestPreviewQueriesApiV1PrivacyRequestPreviewPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getRequestPreviewQueriesApiV1PrivacyRequestPreviewPutError = + getRequestPreviewQueriesApiV1PrivacyRequestPreviewPutErrors[keyof getRequestPreviewQueriesApiV1PrivacyRequestPreviewPutErrors]; + +export type getRequestPreviewQueriesApiV1PrivacyRequestPreviewPutResponses = { + /** + * Response Get Request Preview Queries Api V1 Privacy Request Preview Put + * + * Successful Response + */ + 200: Array; +}; + +export type getRequestPreviewQueriesApiV1PrivacyRequestPreviewPutResponse = + getRequestPreviewQueriesApiV1PrivacyRequestPreviewPutResponses[keyof getRequestPreviewQueriesApiV1PrivacyRequestPreviewPutResponses]; + +export type resumePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResumePostData = + { + body: PrivacyRequestResumeFormat; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/resume"; + }; + +export type resumePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResumePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type resumePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResumePostError = + resumePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResumePostErrors[keyof resumePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResumePostErrors]; + +export type resumePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResumePostResponses = + { + /** + * Successful Response + */ + 200: PrivacyRequestResponse; + }; + +export type resumePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResumePostResponse = + resumePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResumePostResponses[keyof resumePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResumePostResponses]; + +export type bulkRestartPrivacyRequestFromFailureApiV1PrivacyRequestBulkRetryPostData = + { + body: PrivacyRequestBulkSelection; + path?: never; + query?: never; + url: "/api/v1/privacy-request/bulk/retry"; + }; + +export type bulkRestartPrivacyRequestFromFailureApiV1PrivacyRequestBulkRetryPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type bulkRestartPrivacyRequestFromFailureApiV1PrivacyRequestBulkRetryPostError = + bulkRestartPrivacyRequestFromFailureApiV1PrivacyRequestBulkRetryPostErrors[keyof bulkRestartPrivacyRequestFromFailureApiV1PrivacyRequestBulkRetryPostErrors]; + +export type bulkRestartPrivacyRequestFromFailureApiV1PrivacyRequestBulkRetryPostResponses = + { + /** + * Successful Response + */ + 200: BulkPostPrivacyRequests; + }; + +export type bulkRestartPrivacyRequestFromFailureApiV1PrivacyRequestBulkRetryPostResponse = + bulkRestartPrivacyRequestFromFailureApiV1PrivacyRequestBulkRetryPostResponses[keyof bulkRestartPrivacyRequestFromFailureApiV1PrivacyRequestBulkRetryPostResponses]; + +export type restartPrivacyRequestFromFailureApiV1PrivacyRequestPrivacyRequestIdRetryPostData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/retry"; + }; + +export type restartPrivacyRequestFromFailureApiV1PrivacyRequestPrivacyRequestIdRetryPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type restartPrivacyRequestFromFailureApiV1PrivacyRequestPrivacyRequestIdRetryPostError = + restartPrivacyRequestFromFailureApiV1PrivacyRequestPrivacyRequestIdRetryPostErrors[keyof restartPrivacyRequestFromFailureApiV1PrivacyRequestPrivacyRequestIdRetryPostErrors]; + +export type restartPrivacyRequestFromFailureApiV1PrivacyRequestPrivacyRequestIdRetryPostResponses = + { + /** + * Successful Response + */ + 200: PrivacyRequestResponse; + }; + +export type restartPrivacyRequestFromFailureApiV1PrivacyRequestPrivacyRequestIdRetryPostResponse = + restartPrivacyRequestFromFailureApiV1PrivacyRequestPrivacyRequestIdRetryPostResponses[keyof restartPrivacyRequestFromFailureApiV1PrivacyRequestPrivacyRequestIdRetryPostResponses]; + +export type verifyIdentificationCodeApiV1PrivacyRequestPrivacyRequestIdVerifyPostData = + { + body: VerificationCode; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/verify"; + }; + +export type verifyIdentificationCodeApiV1PrivacyRequestPrivacyRequestIdVerifyPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type verifyIdentificationCodeApiV1PrivacyRequestPrivacyRequestIdVerifyPostError = + verifyIdentificationCodeApiV1PrivacyRequestPrivacyRequestIdVerifyPostErrors[keyof verifyIdentificationCodeApiV1PrivacyRequestPrivacyRequestIdVerifyPostErrors]; + +export type verifyIdentificationCodeApiV1PrivacyRequestPrivacyRequestIdVerifyPostResponses = + { + /** + * Successful Response + */ + 200: PrivacyRequestResponse; + }; + +export type verifyIdentificationCodeApiV1PrivacyRequestPrivacyRequestIdVerifyPostResponse = + verifyIdentificationCodeApiV1PrivacyRequestPrivacyRequestIdVerifyPostResponses[keyof verifyIdentificationCodeApiV1PrivacyRequestPrivacyRequestIdVerifyPostResponses]; + +export type approvePrivacyRequestApiV1PrivacyRequestAdministrateApprovePatchData = + { + body: PrivacyRequestBulkSelection; + path?: never; + query?: never; + url: "/api/v1/privacy-request/administrate/approve"; + }; + +export type approvePrivacyRequestApiV1PrivacyRequestAdministrateApprovePatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type approvePrivacyRequestApiV1PrivacyRequestAdministrateApprovePatchError = + approvePrivacyRequestApiV1PrivacyRequestAdministrateApprovePatchErrors[keyof approvePrivacyRequestApiV1PrivacyRequestAdministrateApprovePatchErrors]; + +export type approvePrivacyRequestApiV1PrivacyRequestAdministrateApprovePatchResponses = + { + /** + * Successful Response + */ + 200: BulkReviewResponse; + }; + +export type approvePrivacyRequestApiV1PrivacyRequestAdministrateApprovePatchResponse = + approvePrivacyRequestApiV1PrivacyRequestAdministrateApprovePatchResponses[keyof approvePrivacyRequestApiV1PrivacyRequestAdministrateApprovePatchResponses]; + +export type denyPrivacyRequestApiV1PrivacyRequestAdministrateDenyPatchData = { + body: DenyPrivacyRequestSelection; + path?: never; + query?: never; + url: "/api/v1/privacy-request/administrate/deny"; +}; + +export type denyPrivacyRequestApiV1PrivacyRequestAdministrateDenyPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type denyPrivacyRequestApiV1PrivacyRequestAdministrateDenyPatchError = + denyPrivacyRequestApiV1PrivacyRequestAdministrateDenyPatchErrors[keyof denyPrivacyRequestApiV1PrivacyRequestAdministrateDenyPatchErrors]; + +export type denyPrivacyRequestApiV1PrivacyRequestAdministrateDenyPatchResponses = + { + /** + * Successful Response + */ + 200: BulkReviewResponse; + }; + +export type denyPrivacyRequestApiV1PrivacyRequestAdministrateDenyPatchResponse = + denyPrivacyRequestApiV1PrivacyRequestAdministrateDenyPatchResponses[keyof denyPrivacyRequestApiV1PrivacyRequestAdministrateDenyPatchResponses]; + +export type cancelPrivacyRequestApiV1PrivacyRequestAdministrateCancelPatchData = + { + body: CancelPrivacyRequestSelection; + path?: never; + query?: never; + url: "/api/v1/privacy-request/administrate/cancel"; + }; + +export type cancelPrivacyRequestApiV1PrivacyRequestAdministrateCancelPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type cancelPrivacyRequestApiV1PrivacyRequestAdministrateCancelPatchError = + cancelPrivacyRequestApiV1PrivacyRequestAdministrateCancelPatchErrors[keyof cancelPrivacyRequestApiV1PrivacyRequestAdministrateCancelPatchErrors]; + +export type cancelPrivacyRequestApiV1PrivacyRequestAdministrateCancelPatchResponses = + { + /** + * Successful Response + */ + 200: BulkReviewResponse; + }; + +export type cancelPrivacyRequestApiV1PrivacyRequestAdministrateCancelPatchResponse = + cancelPrivacyRequestApiV1PrivacyRequestAdministrateCancelPatchResponses[keyof cancelPrivacyRequestApiV1PrivacyRequestAdministrateCancelPatchResponses]; + +export type markPrivacyRequestPreApproveEligibleApiV1PrivacyRequestPrivacyRequestIdPreApproveEligiblePostData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/pre-approve/eligible"; + }; + +export type markPrivacyRequestPreApproveEligibleApiV1PrivacyRequestPrivacyRequestIdPreApproveEligiblePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type markPrivacyRequestPreApproveEligibleApiV1PrivacyRequestPrivacyRequestIdPreApproveEligiblePostError = + markPrivacyRequestPreApproveEligibleApiV1PrivacyRequestPrivacyRequestIdPreApproveEligiblePostErrors[keyof markPrivacyRequestPreApproveEligibleApiV1PrivacyRequestPrivacyRequestIdPreApproveEligiblePostErrors]; + +export type markPrivacyRequestPreApproveEligibleApiV1PrivacyRequestPrivacyRequestIdPreApproveEligiblePostResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type markPrivacyRequestPreApproveNotEligibleApiV1PrivacyRequestPrivacyRequestIdPreApproveNotEligiblePostData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/pre-approve/not-eligible"; + }; + +export type markPrivacyRequestPreApproveNotEligibleApiV1PrivacyRequestPrivacyRequestIdPreApproveNotEligiblePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type markPrivacyRequestPreApproveNotEligibleApiV1PrivacyRequestPrivacyRequestIdPreApproveNotEligiblePostError = + markPrivacyRequestPreApproveNotEligibleApiV1PrivacyRequestPrivacyRequestIdPreApproveNotEligiblePostErrors[keyof markPrivacyRequestPreApproveNotEligibleApiV1PrivacyRequestPrivacyRequestIdPreApproveNotEligiblePostErrors]; + +export type markPrivacyRequestPreApproveNotEligibleApiV1PrivacyRequestPrivacyRequestIdPreApproveNotEligiblePostResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type viewUploadedManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyGetData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/access_manual_webhook/{connection_key}"; + }; + +export type viewUploadedManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type viewUploadedManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyGetError = + viewUploadedManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyGetErrors[keyof viewUploadedManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyGetErrors]; + +export type viewUploadedManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyGetResponses = + { + /** + * Response View Uploaded Manual Webhook Data Api V1 Privacy Request Privacy Request Id Access Manual Webhook Connection Key Get + * + * Successful Response + */ + 200: ManualWebhookData | null; + }; + +export type viewUploadedManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyGetResponse = + viewUploadedManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyGetResponses[keyof viewUploadedManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyGetResponses]; + +export type uploadManualWebhookAccessDataApiV1PrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyPatchData = + { + /** + * Input Data + */ + body: { + [key: string]: unknown; + }; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/access_manual_webhook/{connection_key}"; + }; + +export type uploadManualWebhookAccessDataApiV1PrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type uploadManualWebhookAccessDataApiV1PrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyPatchError = + uploadManualWebhookAccessDataApiV1PrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyPatchErrors[keyof uploadManualWebhookAccessDataApiV1PrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyPatchErrors]; + +export type uploadManualWebhookAccessDataApiV1PrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyPatchResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type viewUploadedErasureManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyGetData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/erasure_manual_webhook/{connection_key}"; + }; + +export type viewUploadedErasureManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type viewUploadedErasureManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyGetError = + viewUploadedErasureManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyGetErrors[keyof viewUploadedErasureManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyGetErrors]; + +export type viewUploadedErasureManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyGetResponses = + { + /** + * Response View Uploaded Erasure Manual Webhook Data Api V1 Privacy Request Privacy Request Id Erasure Manual Webhook Connection Key Get + * + * Successful Response + */ + 200: ManualWebhookData | null; + }; + +export type viewUploadedErasureManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyGetResponse = + viewUploadedErasureManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyGetResponses[keyof viewUploadedErasureManualWebhookDataApiV1PrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyGetResponses]; + +export type uploadManualWebhookErasureDataApiV1PrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyPatchData = + { + /** + * Input Data + */ + body: { + [key: string]: unknown; + }; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/erasure_manual_webhook/{connection_key}"; + }; + +export type uploadManualWebhookErasureDataApiV1PrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type uploadManualWebhookErasureDataApiV1PrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyPatchError = + uploadManualWebhookErasureDataApiV1PrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyPatchErrors[keyof uploadManualWebhookErasureDataApiV1PrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyPatchErrors]; + +export type uploadManualWebhookErasureDataApiV1PrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyPatchResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type privacyRequestDataTransferApiV1PrivacyRequestTransferPrivacyRequestIdRuleKeyGetData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + /** + * Rule Key + */ + rule_key: string; + }; + query?: never; + url: "/api/v1/privacy-request/transfer/{privacy_request_id}/{rule_key}"; + }; + +export type privacyRequestDataTransferApiV1PrivacyRequestTransferPrivacyRequestIdRuleKeyGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type privacyRequestDataTransferApiV1PrivacyRequestTransferPrivacyRequestIdRuleKeyGetError = + privacyRequestDataTransferApiV1PrivacyRequestTransferPrivacyRequestIdRuleKeyGetErrors[keyof privacyRequestDataTransferApiV1PrivacyRequestTransferPrivacyRequestIdRuleKeyGetErrors]; + +export type privacyRequestDataTransferApiV1PrivacyRequestTransferPrivacyRequestIdRuleKeyGetResponses = + { + /** + * Response Privacy Request Data Transfer Api V1 Privacy Request Transfer Privacy Request Id Rule Key Get + * + * Successful Response + */ + 200: { + [key: string]: Array<{ + [key: string]: unknown; + }> | null; + }; + }; + +export type privacyRequestDataTransferApiV1PrivacyRequestTransferPrivacyRequestIdRuleKeyGetResponse = + privacyRequestDataTransferApiV1PrivacyRequestTransferPrivacyRequestIdRuleKeyGetResponses[keyof privacyRequestDataTransferApiV1PrivacyRequestTransferPrivacyRequestIdRuleKeyGetResponses]; + +export type resumePrivacyRequestFromRequiresInputApiV1PrivacyRequestPrivacyRequestIdResumeFromRequiresInputPostData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/resume_from_requires_input"; + }; + +export type resumePrivacyRequestFromRequiresInputApiV1PrivacyRequestPrivacyRequestIdResumeFromRequiresInputPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type resumePrivacyRequestFromRequiresInputApiV1PrivacyRequestPrivacyRequestIdResumeFromRequiresInputPostError = + resumePrivacyRequestFromRequiresInputApiV1PrivacyRequestPrivacyRequestIdResumeFromRequiresInputPostErrors[keyof resumePrivacyRequestFromRequiresInputApiV1PrivacyRequestPrivacyRequestIdResumeFromRequiresInputPostErrors]; + +export type resumePrivacyRequestFromRequiresInputApiV1PrivacyRequestPrivacyRequestIdResumeFromRequiresInputPostResponses = + { + /** + * Successful Response + */ + 200: PrivacyRequestResponse; + }; + +export type resumePrivacyRequestFromRequiresInputApiV1PrivacyRequestPrivacyRequestIdResumeFromRequiresInputPostResponse = + resumePrivacyRequestFromRequiresInputApiV1PrivacyRequestPrivacyRequestIdResumeFromRequiresInputPostResponses[keyof resumePrivacyRequestFromRequiresInputApiV1PrivacyRequestPrivacyRequestIdResumeFromRequiresInputPostResponses]; + +export type bulkFinalizePrivacyRequestsApiV1PrivacyRequestBulkFinalizePostData = + { + body: PrivacyRequestBulkSelection; + path?: never; + query?: never; + url: "/api/v1/privacy-request/bulk/finalize"; + }; + +export type bulkFinalizePrivacyRequestsApiV1PrivacyRequestBulkFinalizePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type bulkFinalizePrivacyRequestsApiV1PrivacyRequestBulkFinalizePostError = + bulkFinalizePrivacyRequestsApiV1PrivacyRequestBulkFinalizePostErrors[keyof bulkFinalizePrivacyRequestsApiV1PrivacyRequestBulkFinalizePostErrors]; + +export type bulkFinalizePrivacyRequestsApiV1PrivacyRequestBulkFinalizePostResponses = + { + /** + * Successful Response + */ + 200: BulkReviewResponse; + }; + +export type bulkFinalizePrivacyRequestsApiV1PrivacyRequestBulkFinalizePostResponse = + bulkFinalizePrivacyRequestsApiV1PrivacyRequestBulkFinalizePostResponses[keyof bulkFinalizePrivacyRequestsApiV1PrivacyRequestBulkFinalizePostResponses]; + +export type finalizePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdFinalizePostData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/finalize"; + }; + +export type finalizePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdFinalizePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type finalizePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdFinalizePostError = + finalizePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdFinalizePostErrors[keyof finalizePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdFinalizePostErrors]; + +export type finalizePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdFinalizePostResponses = + { + /** + * Successful Response + */ + 200: PrivacyRequestResponse; + }; + +export type finalizePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdFinalizePostResponse = + finalizePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdFinalizePostResponses[keyof finalizePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdFinalizePostResponses]; + +export type getIndividualPrivacyRequestTasksApiV1PrivacyRequestPrivacyRequestIdTasksGetData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/tasks"; + }; + +export type getIndividualPrivacyRequestTasksApiV1PrivacyRequestPrivacyRequestIdTasksGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getIndividualPrivacyRequestTasksApiV1PrivacyRequestPrivacyRequestIdTasksGetError = + getIndividualPrivacyRequestTasksApiV1PrivacyRequestPrivacyRequestIdTasksGetErrors[keyof getIndividualPrivacyRequestTasksApiV1PrivacyRequestPrivacyRequestIdTasksGetErrors]; + +export type getIndividualPrivacyRequestTasksApiV1PrivacyRequestPrivacyRequestIdTasksGetResponses = + { + /** + * Response Get Individual Privacy Request Tasks Api V1 Privacy Request Privacy Request Id Tasks Get + * + * Successful Response + */ + 200: Array; + }; + +export type getIndividualPrivacyRequestTasksApiV1PrivacyRequestPrivacyRequestIdTasksGetResponse = + getIndividualPrivacyRequestTasksApiV1PrivacyRequestPrivacyRequestIdTasksGetResponses[keyof getIndividualPrivacyRequestTasksApiV1PrivacyRequestPrivacyRequestIdTasksGetResponses]; + +export type requeuePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdRequeuePostData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/requeue"; + }; + +export type requeuePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdRequeuePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type requeuePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdRequeuePostError = + requeuePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdRequeuePostErrors[keyof requeuePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdRequeuePostErrors]; + +export type requeuePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdRequeuePostResponses = + { + /** + * Successful Response + */ + 200: PrivacyRequestResponse; + }; + +export type requeuePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdRequeuePostResponse = + requeuePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdRequeuePostResponses[keyof requeuePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdRequeuePostResponses]; + +export type requestTaskAsyncCallbackApiV1RequestTaskCallbackPostData = { + body: RequestTaskCallbackRequest; + path?: never; + query?: never; + url: "/api/v1/request-task/callback"; +}; + +export type requestTaskAsyncCallbackApiV1RequestTaskCallbackPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type requestTaskAsyncCallbackApiV1RequestTaskCallbackPostError = + requestTaskAsyncCallbackApiV1RequestTaskCallbackPostErrors[keyof requestTaskAsyncCallbackApiV1RequestTaskCallbackPostErrors]; + +export type requestTaskAsyncCallbackApiV1RequestTaskCallbackPostResponses = { + /** + * Response Request Task Async Callback Api V1 Request Task Callback Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type requestTaskAsyncCallbackApiV1RequestTaskCallbackPostResponse = + requestTaskAsyncCallbackApiV1RequestTaskCallbackPostResponses[keyof requestTaskAsyncCallbackApiV1RequestTaskCallbackPostResponses]; + +export type bulkSoftDeletePrivacyRequestsApiV1PrivacyRequestBulkSoftDeletePostData = + { + body: PrivacyRequestBulkSelection; + path?: never; + query?: never; + url: "/api/v1/privacy-request/bulk/soft-delete"; + }; + +export type bulkSoftDeletePrivacyRequestsApiV1PrivacyRequestBulkSoftDeletePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type bulkSoftDeletePrivacyRequestsApiV1PrivacyRequestBulkSoftDeletePostError = + bulkSoftDeletePrivacyRequestsApiV1PrivacyRequestBulkSoftDeletePostErrors[keyof bulkSoftDeletePrivacyRequestsApiV1PrivacyRequestBulkSoftDeletePostErrors]; + +export type bulkSoftDeletePrivacyRequestsApiV1PrivacyRequestBulkSoftDeletePostResponses = + { + /** + * Successful Response + */ + 200: BulkSoftDeletePrivacyRequests; + }; + +export type bulkSoftDeletePrivacyRequestsApiV1PrivacyRequestBulkSoftDeletePostResponse = + bulkSoftDeletePrivacyRequestsApiV1PrivacyRequestBulkSoftDeletePostResponses[keyof bulkSoftDeletePrivacyRequestsApiV1PrivacyRequestBulkSoftDeletePostResponses]; + +export type softDeletePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdSoftDeletePostData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/soft-delete"; + }; + +export type softDeletePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdSoftDeletePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type softDeletePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdSoftDeletePostError = + softDeletePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdSoftDeletePostErrors[keyof softDeletePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdSoftDeletePostErrors]; + +export type softDeletePrivacyRequestApiV1PrivacyRequestPrivacyRequestIdSoftDeletePostResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getAccessResultsUrlsApiV1PrivacyRequestPrivacyRequestIdAccessResultsGetData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/access-results"; + }; + +export type getAccessResultsUrlsApiV1PrivacyRequestPrivacyRequestIdAccessResultsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAccessResultsUrlsApiV1PrivacyRequestPrivacyRequestIdAccessResultsGetError = + getAccessResultsUrlsApiV1PrivacyRequestPrivacyRequestIdAccessResultsGetErrors[keyof getAccessResultsUrlsApiV1PrivacyRequestPrivacyRequestIdAccessResultsGetErrors]; + +export type getAccessResultsUrlsApiV1PrivacyRequestPrivacyRequestIdAccessResultsGetResponses = + { + /** + * Successful Response + */ + 200: PrivacyRequestAccessResults; + }; + +export type getAccessResultsUrlsApiV1PrivacyRequestPrivacyRequestIdAccessResultsGetResponse = + getAccessResultsUrlsApiV1PrivacyRequestPrivacyRequestIdAccessResultsGetResponses[keyof getAccessResultsUrlsApiV1PrivacyRequestPrivacyRequestIdAccessResultsGetResponses]; + +export type getTestPrivacyRequestResultsApiV1PrivacyRequestPrivacyRequestIdFilteredResultsGetData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/filtered-results"; + }; + +export type getTestPrivacyRequestResultsApiV1PrivacyRequestPrivacyRequestIdFilteredResultsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getTestPrivacyRequestResultsApiV1PrivacyRequestPrivacyRequestIdFilteredResultsGetError = + getTestPrivacyRequestResultsApiV1PrivacyRequestPrivacyRequestIdFilteredResultsGetErrors[keyof getTestPrivacyRequestResultsApiV1PrivacyRequestPrivacyRequestIdFilteredResultsGetErrors]; + +export type getTestPrivacyRequestResultsApiV1PrivacyRequestPrivacyRequestIdFilteredResultsGetResponses = + { + /** + * Successful Response + */ + 200: FilteredPrivacyRequestResults; + }; + +export type getTestPrivacyRequestResultsApiV1PrivacyRequestPrivacyRequestIdFilteredResultsGetResponse = + getTestPrivacyRequestResultsApiV1PrivacyRequestPrivacyRequestIdFilteredResultsGetResponses[keyof getTestPrivacyRequestResultsApiV1PrivacyRequestPrivacyRequestIdFilteredResultsGetResponses]; + +export type resubmitPrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResubmitPostData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/resubmit"; + }; + +export type resubmitPrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResubmitPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type resubmitPrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResubmitPostError = + resubmitPrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResubmitPostErrors[keyof resubmitPrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResubmitPostErrors]; + +export type resubmitPrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResubmitPostResponses = + { + /** + * Successful Response + */ + 200: PrivacyRequestResponse; + }; + +export type resubmitPrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResubmitPostResponse = + resubmitPrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResubmitPostResponses[keyof resubmitPrivacyRequestApiV1PrivacyRequestPrivacyRequestIdResubmitPostResponses]; + +export type getTestPrivacyRequestLogsApiV1PrivacyRequestPrivacyRequestIdLogsGetData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/logs"; + }; + +export type getTestPrivacyRequestLogsApiV1PrivacyRequestPrivacyRequestIdLogsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getTestPrivacyRequestLogsApiV1PrivacyRequestPrivacyRequestIdLogsGetError = + getTestPrivacyRequestLogsApiV1PrivacyRequestPrivacyRequestIdLogsGetErrors[keyof getTestPrivacyRequestLogsApiV1PrivacyRequestPrivacyRequestIdLogsGetErrors]; + +export type getTestPrivacyRequestLogsApiV1PrivacyRequestPrivacyRequestIdLogsGetResponses = + { + /** + * Response Get Test Privacy Request Logs Api V1 Privacy Request Privacy Request Id Logs Get + * + * Successful Response + */ + 200: Array; + }; + +export type getTestPrivacyRequestLogsApiV1PrivacyRequestPrivacyRequestIdLogsGetResponse = + getTestPrivacyRequestLogsApiV1PrivacyRequestPrivacyRequestIdLogsGetResponses[keyof getTestPrivacyRequestLogsApiV1PrivacyRequestPrivacyRequestIdLogsGetResponses]; + +export type sendBatchEmailIntegrationsApiV1PrivacyRequestAdministrateProcessAwaitingEmailSendPostData = + { + body?: never; + path?: never; + query?: never; + url: "/api/v1/privacy-request/administrate/process-awaiting-email-send"; + }; + +export type sendBatchEmailIntegrationsApiV1PrivacyRequestAdministrateProcessAwaitingEmailSendPostResponses = + { + /** + * Successful Response + */ + 200: ResponseWithMessage; + }; + +export type sendBatchEmailIntegrationsApiV1PrivacyRequestAdministrateProcessAwaitingEmailSendPostResponse = + sendBatchEmailIntegrationsApiV1PrivacyRequestAdministrateProcessAwaitingEmailSendPostResponses[keyof sendBatchEmailIntegrationsApiV1PrivacyRequestAdministrateProcessAwaitingEmailSendPostResponses]; + +export type getPrivacyRequestRedactionPatternsApiV1PrivacyRequestRedactionPatternsGetData = + { + body?: never; + path?: never; + query?: never; + url: "/api/v1/privacy-request/redaction-patterns"; + }; + +export type getPrivacyRequestRedactionPatternsApiV1PrivacyRequestRedactionPatternsGetResponses = + { + /** + * Successful Response + */ + 200: PrivacyRequestRedactionPatternsResponse; + }; + +export type getPrivacyRequestRedactionPatternsApiV1PrivacyRequestRedactionPatternsGetResponse = + getPrivacyRequestRedactionPatternsApiV1PrivacyRequestRedactionPatternsGetResponses[keyof getPrivacyRequestRedactionPatternsApiV1PrivacyRequestRedactionPatternsGetResponses]; + +export type updatePrivacyRequestRedactionPatternsApiV1PrivacyRequestRedactionPatternsPutData = + { + body: PrivacyRequestRedactionPatternsRequest; + path?: never; + query?: never; + url: "/api/v1/privacy-request/redaction-patterns"; + }; + +export type updatePrivacyRequestRedactionPatternsApiV1PrivacyRequestRedactionPatternsPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updatePrivacyRequestRedactionPatternsApiV1PrivacyRequestRedactionPatternsPutError = + updatePrivacyRequestRedactionPatternsApiV1PrivacyRequestRedactionPatternsPutErrors[keyof updatePrivacyRequestRedactionPatternsApiV1PrivacyRequestRedactionPatternsPutErrors]; + +export type updatePrivacyRequestRedactionPatternsApiV1PrivacyRequestRedactionPatternsPutResponses = + { + /** + * Successful Response + */ + 200: PrivacyRequestRedactionPatternsResponse; + }; + +export type updatePrivacyRequestRedactionPatternsApiV1PrivacyRequestRedactionPatternsPutResponse = + updatePrivacyRequestRedactionPatternsApiV1PrivacyRequestRedactionPatternsPutResponses[keyof updatePrivacyRequestRedactionPatternsApiV1PrivacyRequestRedactionPatternsPutResponses]; + +export type getIdVerificationConfigApiV1IdVerificationConfigGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/id-verification/config"; +}; + +export type getIdVerificationConfigApiV1IdVerificationConfigGetResponses = { + /** + * Successful Response + */ + 200: IdentityVerificationConfigResponse; +}; + +export type getIdVerificationConfigApiV1IdVerificationConfigGetResponse = + getIdVerificationConfigApiV1IdVerificationConfigGetResponses[keyof getIdVerificationConfigApiV1IdVerificationConfigGetResponses]; + +export type uploadDataApiV1StorageRequestIdPostData = { + body: Body_upload_data_api_v1_storage__request_id__post; + path: { + /** + * Request Id + */ + request_id: string; + }; + query?: never; + url: "/api/v1/storage/{request_id}"; +}; + +export type uploadDataApiV1StorageRequestIdPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type uploadDataApiV1StorageRequestIdPostError = + uploadDataApiV1StorageRequestIdPostErrors[keyof uploadDataApiV1StorageRequestIdPostErrors]; + +export type uploadDataApiV1StorageRequestIdPostResponses = { + /** + * Successful Response + */ + 201: DataUpload; +}; + +export type uploadDataApiV1StorageRequestIdPostResponse = + uploadDataApiV1StorageRequestIdPostResponses[keyof uploadDataApiV1StorageRequestIdPostResponses]; + +export type getConfigsApiV1StorageConfigGetData = { + body?: never; + path?: never; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/storage/config"; +}; + +export type getConfigsApiV1StorageConfigGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getConfigsApiV1StorageConfigGetError = + getConfigsApiV1StorageConfigGetErrors[keyof getConfigsApiV1StorageConfigGetErrors]; + +export type getConfigsApiV1StorageConfigGetResponses = { + /** + * Successful Response + */ + 200: Page_StorageDestinationResponse_; +}; + +export type getConfigsApiV1StorageConfigGetResponse = + getConfigsApiV1StorageConfigGetResponses[keyof getConfigsApiV1StorageConfigGetResponses]; + +export type patchConfigApiV1StorageConfigPatchData = { + /** + * Storage Configs + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/storage/config"; +}; + +export type patchConfigApiV1StorageConfigPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type patchConfigApiV1StorageConfigPatchError = + patchConfigApiV1StorageConfigPatchErrors[keyof patchConfigApiV1StorageConfigPatchErrors]; + +export type patchConfigApiV1StorageConfigPatchResponses = { + /** + * Successful Response + */ + 200: BulkPutStorageConfigResponse; +}; + +export type patchConfigApiV1StorageConfigPatchResponse = + patchConfigApiV1StorageConfigPatchResponses[keyof patchConfigApiV1StorageConfigPatchResponses]; + +export type putConfigSecretsApiV1StorageConfigConfigKeySecretPutData = { + /** + * Unvalidated Storage Secrets + */ + body: + | { + /** + * Aws Access Key Id + */ + aws_access_key_id?: string | null; + /** + * Aws Secret Access Key + */ + aws_secret_access_key?: string | null; + /** + * Region Name + */ + region_name?: string | null; + /** + * Assume Role Arn + */ + assume_role_arn?: string | null; + } + | { + /** + * Type + */ + type?: string; + /** + * Project Id + */ + project_id: string; + /** + * Private Key Id + */ + private_key_id: string; + /** + * Private Key + */ + private_key: string; + /** + * Client Email + */ + client_email: string; + /** + * Client Id + */ + client_id: string; + /** + * Auth Uri + */ + auth_uri: string; + /** + * Token Uri + */ + token_uri: string; + /** + * Auth Provider X509 Cert Url + */ + auth_provider_x509_cert_url: string; + /** + * Client X509 Cert Url + */ + client_x509_cert_url: string; + /** + * Universe Domain + */ + universe_domain: string; + }; + path: { + /** + * Config Key + */ + config_key: string; + }; + query?: { + /** + * Verify + */ + verify?: boolean | null; + }; + url: "/api/v1/storage/config/{config_key}/secret"; +}; + +export type putConfigSecretsApiV1StorageConfigConfigKeySecretPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type putConfigSecretsApiV1StorageConfigConfigKeySecretPutError = + putConfigSecretsApiV1StorageConfigConfigKeySecretPutErrors[keyof putConfigSecretsApiV1StorageConfigConfigKeySecretPutErrors]; + +export type putConfigSecretsApiV1StorageConfigConfigKeySecretPutResponses = { + /** + * Successful Response + */ + 200: TestStatusMessage; +}; + +export type putConfigSecretsApiV1StorageConfigConfigKeySecretPutResponse = + putConfigSecretsApiV1StorageConfigConfigKeySecretPutResponses[keyof putConfigSecretsApiV1StorageConfigConfigKeySecretPutResponses]; + +export type deleteConfigByKeyApiV1StorageConfigConfigKeyDeleteData = { + body?: never; + path: { + /** + * Config Key + */ + config_key: string; + }; + query?: never; + url: "/api/v1/storage/config/{config_key}"; +}; + +export type deleteConfigByKeyApiV1StorageConfigConfigKeyDeleteErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteConfigByKeyApiV1StorageConfigConfigKeyDeleteError = + deleteConfigByKeyApiV1StorageConfigConfigKeyDeleteErrors[keyof deleteConfigByKeyApiV1StorageConfigConfigKeyDeleteErrors]; + +export type deleteConfigByKeyApiV1StorageConfigConfigKeyDeleteResponses = { + /** + * Successful Response + */ + 204: void; +}; + +export type deleteConfigByKeyApiV1StorageConfigConfigKeyDeleteResponse = + deleteConfigByKeyApiV1StorageConfigConfigKeyDeleteResponses[keyof deleteConfigByKeyApiV1StorageConfigConfigKeyDeleteResponses]; + +export type getConfigByKeyApiV1StorageConfigConfigKeyGetData = { + body?: never; + path: { + /** + * Config Key + */ + config_key: string; + }; + query?: never; + url: "/api/v1/storage/config/{config_key}"; +}; + +export type getConfigByKeyApiV1StorageConfigConfigKeyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getConfigByKeyApiV1StorageConfigConfigKeyGetError = + getConfigByKeyApiV1StorageConfigConfigKeyGetErrors[keyof getConfigByKeyApiV1StorageConfigConfigKeyGetErrors]; + +export type getConfigByKeyApiV1StorageConfigConfigKeyGetResponses = { + /** + * Successful Response + */ + 200: StorageDestinationResponse; +}; + +export type getConfigByKeyApiV1StorageConfigConfigKeyGetResponse = + getConfigByKeyApiV1StorageConfigConfigKeyGetResponses[keyof getConfigByKeyApiV1StorageConfigConfigKeyGetResponses]; + +export type getActiveDefaultConfigApiV1StorageDefaultActiveGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/storage/default/active"; +}; + +export type getActiveDefaultConfigApiV1StorageDefaultActiveGetResponses = { + /** + * Successful Response + */ + 200: StorageDestinationResponse; +}; + +export type getActiveDefaultConfigApiV1StorageDefaultActiveGetResponse = + getActiveDefaultConfigApiV1StorageDefaultActiveGetResponses[keyof getActiveDefaultConfigApiV1StorageDefaultActiveGetResponses]; + +export type getStorageStatusApiV1StorageDefaultStatusGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/storage/default/status"; +}; + +export type getStorageStatusApiV1StorageDefaultStatusGetResponses = { + /** + * Successful Response + */ + 200: StorageConfigStatusMessage; +}; + +export type getStorageStatusApiV1StorageDefaultStatusGetResponse = + getStorageStatusApiV1StorageDefaultStatusGetResponses[keyof getStorageStatusApiV1StorageDefaultStatusGetResponses]; + +export type getDefaultConfigsApiV1StorageDefaultGetData = { + body?: never; + path?: never; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/storage/default"; +}; + +export type getDefaultConfigsApiV1StorageDefaultGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getDefaultConfigsApiV1StorageDefaultGetError = + getDefaultConfigsApiV1StorageDefaultGetErrors[keyof getDefaultConfigsApiV1StorageDefaultGetErrors]; + +export type getDefaultConfigsApiV1StorageDefaultGetResponses = { + /** + * Successful Response + */ + 200: Page_StorageDestinationResponse_; +}; + +export type getDefaultConfigsApiV1StorageDefaultGetResponse = + getDefaultConfigsApiV1StorageDefaultGetResponses[keyof getDefaultConfigsApiV1StorageDefaultGetResponses]; + +export type putDefaultConfigApiV1StorageDefaultPutData = { + body: StorageDestinationBase; + path?: never; + query?: never; + url: "/api/v1/storage/default"; +}; + +export type putDefaultConfigApiV1StorageDefaultPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type putDefaultConfigApiV1StorageDefaultPutError = + putDefaultConfigApiV1StorageDefaultPutErrors[keyof putDefaultConfigApiV1StorageDefaultPutErrors]; + +export type putDefaultConfigApiV1StorageDefaultPutResponses = { + /** + * Successful Response + */ + 200: StorageDestinationResponse; +}; + +export type putDefaultConfigApiV1StorageDefaultPutResponse = + putDefaultConfigApiV1StorageDefaultPutResponses[keyof putDefaultConfigApiV1StorageDefaultPutResponses]; + +export type putDefaultConfigSecretsApiV1StorageDefaultStorageTypeSecretPutData = + { + /** + * Unvalidated Storage Secrets + */ + body: + | { + /** + * Aws Access Key Id + */ + aws_access_key_id?: string | null; + /** + * Aws Secret Access Key + */ + aws_secret_access_key?: string | null; + /** + * Region Name + */ + region_name?: string | null; + /** + * Assume Role Arn + */ + assume_role_arn?: string | null; + } + | { + /** + * Type + */ + type?: string; + /** + * Project Id + */ + project_id: string; + /** + * Private Key Id + */ + private_key_id: string; + /** + * Private Key + */ + private_key: string; + /** + * Client Email + */ + client_email: string; + /** + * Client Id + */ + client_id: string; + /** + * Auth Uri + */ + auth_uri: string; + /** + * Token Uri + */ + token_uri: string; + /** + * Auth Provider X509 Cert Url + */ + auth_provider_x509_cert_url: string; + /** + * Client X509 Cert Url + */ + client_x509_cert_url: string; + /** + * Universe Domain + */ + universe_domain: string; + }; + path: { + storage_type: StorageType; + }; + query?: { + /** + * Verify + */ + verify?: boolean | null; + }; + url: "/api/v1/storage/default/{storage_type}/secret"; + }; + +export type putDefaultConfigSecretsApiV1StorageDefaultStorageTypeSecretPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type putDefaultConfigSecretsApiV1StorageDefaultStorageTypeSecretPutError = + putDefaultConfigSecretsApiV1StorageDefaultStorageTypeSecretPutErrors[keyof putDefaultConfigSecretsApiV1StorageDefaultStorageTypeSecretPutErrors]; + +export type putDefaultConfigSecretsApiV1StorageDefaultStorageTypeSecretPutResponses = + { + /** + * Successful Response + */ + 200: TestStatusMessage; + }; + +export type putDefaultConfigSecretsApiV1StorageDefaultStorageTypeSecretPutResponse = + putDefaultConfigSecretsApiV1StorageDefaultStorageTypeSecretPutResponses[keyof putDefaultConfigSecretsApiV1StorageDefaultStorageTypeSecretPutResponses]; + +export type getDefaultConfigByTypeApiV1StorageDefaultStorageTypeGetData = { + body?: never; + path: { + storage_type: StorageType; + }; + query?: never; + url: "/api/v1/storage/default/{storage_type}"; +}; + +export type getDefaultConfigByTypeApiV1StorageDefaultStorageTypeGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getDefaultConfigByTypeApiV1StorageDefaultStorageTypeGetError = + getDefaultConfigByTypeApiV1StorageDefaultStorageTypeGetErrors[keyof getDefaultConfigByTypeApiV1StorageDefaultStorageTypeGetErrors]; + +export type getDefaultConfigByTypeApiV1StorageDefaultStorageTypeGetResponses = { + /** + * Successful Response + */ + 200: StorageDestinationResponse; +}; + +export type getDefaultConfigByTypeApiV1StorageDefaultStorageTypeGetResponse = + getDefaultConfigByTypeApiV1StorageDefaultStorageTypeGetResponses[keyof getDefaultConfigByTypeApiV1StorageDefaultStorageTypeGetResponses]; + +export type getConfigsApiV1MessagingConfigGetData = { + body?: never; + path?: never; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/messaging/config"; +}; + +export type getConfigsApiV1MessagingConfigGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getConfigsApiV1MessagingConfigGetError = + getConfigsApiV1MessagingConfigGetErrors[keyof getConfigsApiV1MessagingConfigGetErrors]; + +export type getConfigsApiV1MessagingConfigGetResponses = { + /** + * Successful Response + */ + 200: Page_MessagingConfigResponse_; +}; + +export type getConfigsApiV1MessagingConfigGetResponse = + getConfigsApiV1MessagingConfigGetResponses[keyof getConfigsApiV1MessagingConfigGetResponses]; + +export type postConfigApiV1MessagingConfigPostData = { + body: MessagingConfigRequest; + path?: never; + query?: never; + url: "/api/v1/messaging/config"; +}; + +export type postConfigApiV1MessagingConfigPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type postConfigApiV1MessagingConfigPostError = + postConfigApiV1MessagingConfigPostErrors[keyof postConfigApiV1MessagingConfigPostErrors]; + +export type postConfigApiV1MessagingConfigPostResponses = { + /** + * Successful Response + */ + 200: MessagingConfigResponse; +}; + +export type postConfigApiV1MessagingConfigPostResponse = + postConfigApiV1MessagingConfigPostResponses[keyof postConfigApiV1MessagingConfigPostResponses]; + +export type deleteConfigByKeyApiV1MessagingConfigConfigKeyDeleteData = { + body?: never; + path: { + /** + * Config Key + */ + config_key: string; + }; + query?: never; + url: "/api/v1/messaging/config/{config_key}"; +}; + +export type deleteConfigByKeyApiV1MessagingConfigConfigKeyDeleteErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteConfigByKeyApiV1MessagingConfigConfigKeyDeleteError = + deleteConfigByKeyApiV1MessagingConfigConfigKeyDeleteErrors[keyof deleteConfigByKeyApiV1MessagingConfigConfigKeyDeleteErrors]; + +export type deleteConfigByKeyApiV1MessagingConfigConfigKeyDeleteResponses = { + /** + * Successful Response + */ + 204: void; +}; + +export type deleteConfigByKeyApiV1MessagingConfigConfigKeyDeleteResponse = + deleteConfigByKeyApiV1MessagingConfigConfigKeyDeleteResponses[keyof deleteConfigByKeyApiV1MessagingConfigConfigKeyDeleteResponses]; + +export type getConfigByKeyApiV1MessagingConfigConfigKeyGetData = { + body?: never; + path: { + /** + * Config Key + */ + config_key: string; + }; + query?: never; + url: "/api/v1/messaging/config/{config_key}"; +}; + +export type getConfigByKeyApiV1MessagingConfigConfigKeyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getConfigByKeyApiV1MessagingConfigConfigKeyGetError = + getConfigByKeyApiV1MessagingConfigConfigKeyGetErrors[keyof getConfigByKeyApiV1MessagingConfigConfigKeyGetErrors]; + +export type getConfigByKeyApiV1MessagingConfigConfigKeyGetResponses = { + /** + * Successful Response + */ + 200: MessagingConfigResponse; +}; + +export type getConfigByKeyApiV1MessagingConfigConfigKeyGetResponse = + getConfigByKeyApiV1MessagingConfigConfigKeyGetResponses[keyof getConfigByKeyApiV1MessagingConfigConfigKeyGetResponses]; + +export type patchConfigByKeyApiV1MessagingConfigConfigKeyPatchData = { + body: MessagingConfigRequest; + path: { + /** + * Config Key + */ + config_key: string; + }; + query?: never; + url: "/api/v1/messaging/config/{config_key}"; +}; + +export type patchConfigByKeyApiV1MessagingConfigConfigKeyPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type patchConfigByKeyApiV1MessagingConfigConfigKeyPatchError = + patchConfigByKeyApiV1MessagingConfigConfigKeyPatchErrors[keyof patchConfigByKeyApiV1MessagingConfigConfigKeyPatchErrors]; + +export type patchConfigByKeyApiV1MessagingConfigConfigKeyPatchResponses = { + /** + * Successful Response + */ + 200: MessagingConfigResponse; +}; + +export type patchConfigByKeyApiV1MessagingConfigConfigKeyPatchResponse = + patchConfigByKeyApiV1MessagingConfigConfigKeyPatchResponses[keyof patchConfigByKeyApiV1MessagingConfigConfigKeyPatchResponses]; + +export type getActiveDefaultConfigApiV1MessagingDefaultActiveGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/messaging/default/active"; +}; + +export type getActiveDefaultConfigApiV1MessagingDefaultActiveGetResponses = { + /** + * Successful Response + */ + 200: MessagingConfigResponse; +}; + +export type getActiveDefaultConfigApiV1MessagingDefaultActiveGetResponse = + getActiveDefaultConfigApiV1MessagingDefaultActiveGetResponses[keyof getActiveDefaultConfigApiV1MessagingDefaultActiveGetResponses]; + +export type getMessagingStatusApiV1MessagingDefaultStatusGetData = { + body?: never; + path?: never; + query?: { + /** + * Messaging Method + */ + messaging_method?: MessagingMethod | null; + }; + url: "/api/v1/messaging/default/status"; +}; + +export type getMessagingStatusApiV1MessagingDefaultStatusGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getMessagingStatusApiV1MessagingDefaultStatusGetError = + getMessagingStatusApiV1MessagingDefaultStatusGetErrors[keyof getMessagingStatusApiV1MessagingDefaultStatusGetErrors]; + +export type getMessagingStatusApiV1MessagingDefaultStatusGetResponses = { + /** + * Successful Response + */ + 200: MessagingConfigStatusMessage; +}; + +export type getMessagingStatusApiV1MessagingDefaultStatusGetResponse = + getMessagingStatusApiV1MessagingDefaultStatusGetResponses[keyof getMessagingStatusApiV1MessagingDefaultStatusGetResponses]; + +export type putDefaultConfigApiV1MessagingDefaultPutData = { + body: MessagingConfigRequestBase; + path?: never; + query?: never; + url: "/api/v1/messaging/default"; +}; + +export type putDefaultConfigApiV1MessagingDefaultPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type putDefaultConfigApiV1MessagingDefaultPutError = + putDefaultConfigApiV1MessagingDefaultPutErrors[keyof putDefaultConfigApiV1MessagingDefaultPutErrors]; + +export type putDefaultConfigApiV1MessagingDefaultPutResponses = { + /** + * Successful Response + */ + 200: MessagingConfigResponse; +}; + +export type putDefaultConfigApiV1MessagingDefaultPutResponse = + putDefaultConfigApiV1MessagingDefaultPutResponses[keyof putDefaultConfigApiV1MessagingDefaultPutResponses]; + +export type putDefaultConfigSecretsApiV1MessagingDefaultServiceTypeSecretPutData = + { + /** + * Unvalidated Messaging Secrets + */ + body: + | { + /** + * Mailgun Api Key + */ + mailgun_api_key: string; + } + | { + /** + * Twilio Account Sid + */ + twilio_account_sid: string; + /** + * Twilio Auth Token + */ + twilio_auth_token: string; + /** + * Twilio Messaging Service Sid + */ + twilio_messaging_service_sid?: string | null; + /** + * Twilio Sender Phone Number + */ + twilio_sender_phone_number?: string | null; + } + | { + /** + * Twilio Api Key + */ + twilio_api_key: string; + } + | { + /** + * Mailchimp Transactional Api Key + */ + mailchimp_transactional_api_key: string; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + }; + path: { + service_type: MessagingServiceType; + }; + query?: never; + url: "/api/v1/messaging/default/{service_type}/secret"; + }; + +export type putDefaultConfigSecretsApiV1MessagingDefaultServiceTypeSecretPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type putDefaultConfigSecretsApiV1MessagingDefaultServiceTypeSecretPutError = + putDefaultConfigSecretsApiV1MessagingDefaultServiceTypeSecretPutErrors[keyof putDefaultConfigSecretsApiV1MessagingDefaultServiceTypeSecretPutErrors]; + +export type putDefaultConfigSecretsApiV1MessagingDefaultServiceTypeSecretPutResponses = + { + /** + * Successful Response + */ + 200: TestMessagingStatusMessage; + }; + +export type putDefaultConfigSecretsApiV1MessagingDefaultServiceTypeSecretPutResponse = + putDefaultConfigSecretsApiV1MessagingDefaultServiceTypeSecretPutResponses[keyof putDefaultConfigSecretsApiV1MessagingDefaultServiceTypeSecretPutResponses]; + +export type putConfigSecretsApiV1MessagingConfigConfigKeySecretPutData = { + /** + * Unvalidated Messaging Secrets + */ + body: + | { + /** + * Mailgun Api Key + */ + mailgun_api_key: string; + } + | { + /** + * Twilio Account Sid + */ + twilio_account_sid: string; + /** + * Twilio Auth Token + */ + twilio_auth_token: string; + /** + * Twilio Messaging Service Sid + */ + twilio_messaging_service_sid?: string | null; + /** + * Twilio Sender Phone Number + */ + twilio_sender_phone_number?: string | null; + } + | { + /** + * Twilio Api Key + */ + twilio_api_key: string; + } + | { + /** + * Mailchimp Transactional Api Key + */ + mailchimp_transactional_api_key: string; + } + | { + /** + * Authentication Method + * + * Determines which type of authentication method to use for connecting to Amazon Web Services. Currently accepted values are: `secret_keys` or `automatic`. + */ + auth_method: AWSAuthMethod; + /** + * Access Key ID + * + * Part of the credentials that provide access to your AWS account. + */ + aws_access_key_id?: string | null; + /** + * Secret Access Key + * + * Part of the credentials that provide access to your AWS account. + */ + aws_secret_access_key?: string | null; + /** + * Assume Role ARN + * + * If provided, the ARN of the role that should be assumed to connect to AWS. + */ + aws_assume_role_arn?: string | null; + }; + path: { + /** + * Config Key + */ + config_key: string; + }; + query?: never; + url: "/api/v1/messaging/config/{config_key}/secret"; +}; + +export type putConfigSecretsApiV1MessagingConfigConfigKeySecretPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type putConfigSecretsApiV1MessagingConfigConfigKeySecretPutError = + putConfigSecretsApiV1MessagingConfigConfigKeySecretPutErrors[keyof putConfigSecretsApiV1MessagingConfigConfigKeySecretPutErrors]; + +export type putConfigSecretsApiV1MessagingConfigConfigKeySecretPutResponses = { + /** + * Successful Response + */ + 200: TestMessagingStatusMessage; +}; + +export type putConfigSecretsApiV1MessagingConfigConfigKeySecretPutResponse = + putConfigSecretsApiV1MessagingConfigConfigKeySecretPutResponses[keyof putConfigSecretsApiV1MessagingConfigConfigKeySecretPutResponses]; + +export type getDefaultConfigByTypeApiV1MessagingDefaultServiceTypeGetData = { + body?: never; + path: { + service_type: MessagingServiceType; + }; + query?: never; + url: "/api/v1/messaging/default/{service_type}"; +}; + +export type getDefaultConfigByTypeApiV1MessagingDefaultServiceTypeGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getDefaultConfigByTypeApiV1MessagingDefaultServiceTypeGetError = + getDefaultConfigByTypeApiV1MessagingDefaultServiceTypeGetErrors[keyof getDefaultConfigByTypeApiV1MessagingDefaultServiceTypeGetErrors]; + +export type getDefaultConfigByTypeApiV1MessagingDefaultServiceTypeGetResponses = + { + /** + * Successful Response + */ + 200: MessagingConfigResponse; + }; + +export type getDefaultConfigByTypeApiV1MessagingDefaultServiceTypeGetResponse = + getDefaultConfigByTypeApiV1MessagingDefaultServiceTypeGetResponses[keyof getDefaultConfigByTypeApiV1MessagingDefaultServiceTypeGetResponses]; + +export type sendTestMessageApiV1MessagingTestServiceTypePostData = { + body: MessagingTestBodyParams; + path: { + service_type: MessagingServiceType; + }; + query?: never; + url: "/api/v1/messaging/test/{service_type}"; +}; + +export type sendTestMessageApiV1MessagingTestServiceTypePostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type sendTestMessageApiV1MessagingTestServiceTypePostError = + sendTestMessageApiV1MessagingTestServiceTypePostErrors[keyof sendTestMessageApiV1MessagingTestServiceTypePostErrors]; + +export type sendTestMessageApiV1MessagingTestServiceTypePostResponses = { + /** + * Response Send Test Message Api V1 Messaging Test Service Type Post + * + * Successful Response + */ + 200: { + [key: string]: string; + }; +}; + +export type sendTestMessageApiV1MessagingTestServiceTypePostResponse = + sendTestMessageApiV1MessagingTestServiceTypePostResponses[keyof sendTestMessageApiV1MessagingTestServiceTypePostResponses]; + +export type sendTestMessageDeprecatedApiV1MessagingConfigTestPostData = { + body: fides__api__schemas__redis_cache__Identity; + path?: never; + query?: never; + url: "/api/v1/messaging/config/test"; +}; + +export type sendTestMessageDeprecatedApiV1MessagingConfigTestPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type sendTestMessageDeprecatedApiV1MessagingConfigTestPostError = + sendTestMessageDeprecatedApiV1MessagingConfigTestPostErrors[keyof sendTestMessageDeprecatedApiV1MessagingConfigTestPostErrors]; + +export type sendTestMessageDeprecatedApiV1MessagingConfigTestPostResponses = { + /** + * Response Send Test Message Deprecated Api V1 Messaging Config Test Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type sendTestMessageDeprecatedApiV1MessagingConfigTestPostResponse = + sendTestMessageDeprecatedApiV1MessagingConfigTestPostResponses[keyof sendTestMessageDeprecatedApiV1MessagingConfigTestPostResponses]; + +export type getBasicMessagingTemplatesApiV1MessagingTemplatesGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/messaging/templates"; +}; + +export type getBasicMessagingTemplatesApiV1MessagingTemplatesGetResponses = { + /** + * Response Get Basic Messaging Templates Api V1 Messaging Templates Get + * + * Successful Response + */ + 200: Array; +}; + +export type getBasicMessagingTemplatesApiV1MessagingTemplatesGetResponse = + getBasicMessagingTemplatesApiV1MessagingTemplatesGetResponses[keyof getBasicMessagingTemplatesApiV1MessagingTemplatesGetResponses]; + +export type updateBasicMessagingTemplatesApiV1MessagingTemplatesPutData = { + /** + * Templates + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/messaging/templates"; +}; + +export type updateBasicMessagingTemplatesApiV1MessagingTemplatesPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateBasicMessagingTemplatesApiV1MessagingTemplatesPutError = + updateBasicMessagingTemplatesApiV1MessagingTemplatesPutErrors[keyof updateBasicMessagingTemplatesApiV1MessagingTemplatesPutErrors]; + +export type updateBasicMessagingTemplatesApiV1MessagingTemplatesPutResponses = { + /** + * Successful Response + */ + 200: BulkPutBasicMessagingTemplateResponse; +}; + +export type updateBasicMessagingTemplatesApiV1MessagingTemplatesPutResponse = + updateBasicMessagingTemplatesApiV1MessagingTemplatesPutResponses[keyof updateBasicMessagingTemplatesApiV1MessagingTemplatesPutResponses]; + +export type getDefaultMessagingTemplateApiV1MessagingTemplatesDefaultTemplateTypeGetData = + { + body?: never; + path: { + template_type: MessagingActionType; + }; + query?: never; + url: "/api/v1/messaging/templates/default/{template_type}"; + }; + +export type getDefaultMessagingTemplateApiV1MessagingTemplatesDefaultTemplateTypeGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getDefaultMessagingTemplateApiV1MessagingTemplatesDefaultTemplateTypeGetError = + getDefaultMessagingTemplateApiV1MessagingTemplatesDefaultTemplateTypeGetErrors[keyof getDefaultMessagingTemplateApiV1MessagingTemplatesDefaultTemplateTypeGetErrors]; + +export type getDefaultMessagingTemplateApiV1MessagingTemplatesDefaultTemplateTypeGetResponses = + { + /** + * Successful Response + */ + 200: MessagingTemplateDefault; + }; + +export type getDefaultMessagingTemplateApiV1MessagingTemplatesDefaultTemplateTypeGetResponse = + getDefaultMessagingTemplateApiV1MessagingTemplatesDefaultTemplateTypeGetResponses[keyof getDefaultMessagingTemplateApiV1MessagingTemplatesDefaultTemplateTypeGetResponses]; + +export type deleteMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdDeleteData = + { + body?: never; + path: { + /** + * Template Id + */ + template_id: string; + }; + query?: never; + url: "/api/v1/messaging/templates/{template_id}"; + }; + +export type deleteMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdDeleteError = + deleteMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdDeleteErrors[keyof deleteMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdDeleteErrors]; + +export type deleteMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deleteMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdDeleteResponse = + deleteMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdDeleteResponses[keyof deleteMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdDeleteResponses]; + +export type getMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdGetData = { + body?: never; + path: { + /** + * Template Id + */ + template_id: string; + }; + query?: never; + url: "/api/v1/messaging/templates/{template_id}"; +}; + +export type getMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdGetError = + getMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdGetErrors[keyof getMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdGetErrors]; + +export type getMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdGetResponses = + { + /** + * Successful Response + */ + 200: MessagingTemplateWithPropertiesDetail; + }; + +export type getMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdGetResponse = + getMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdGetResponses[keyof getMessagingTemplateByIdApiV1MessagingTemplatesTemplateIdGetResponses]; + +export type userEmailInviteStatusApiV1MessagingEmailInviteStatusGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/messaging/email-invite/status"; +}; + +export type userEmailInviteStatusApiV1MessagingEmailInviteStatusGetResponses = { + /** + * Successful Response + */ + 200: UserEmailInviteStatus; +}; + +export type userEmailInviteStatusApiV1MessagingEmailInviteStatusGetResponse = + userEmailInviteStatusApiV1MessagingEmailInviteStatusGetResponses[keyof userEmailInviteStatusApiV1MessagingEmailInviteStatusGetResponses]; + +export type validateSaasConfigApiV1ConnectionConnectionKeyValidateSaasConfigPutData = + { + body: SaaSConfig; + path?: never; + query?: never; + url: "/api/v1/connection/{connection_key}/validate_saas_config"; + }; + +export type validateSaasConfigApiV1ConnectionConnectionKeyValidateSaasConfigPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type validateSaasConfigApiV1ConnectionConnectionKeyValidateSaasConfigPutError = + validateSaasConfigApiV1ConnectionConnectionKeyValidateSaasConfigPutErrors[keyof validateSaasConfigApiV1ConnectionConnectionKeyValidateSaasConfigPutErrors]; + +export type validateSaasConfigApiV1ConnectionConnectionKeyValidateSaasConfigPutResponses = + { + /** + * Successful Response + */ + 200: ValidateSaaSConfigResponse; + }; + +export type validateSaasConfigApiV1ConnectionConnectionKeyValidateSaasConfigPutResponse = + validateSaasConfigApiV1ConnectionConnectionKeyValidateSaasConfigPutResponses[keyof validateSaasConfigApiV1ConnectionConnectionKeyValidateSaasConfigPutResponses]; + +export type deleteSaasConfigApiV1ConnectionConnectionKeySaasConfigDeleteData = { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/saas_config"; +}; + +export type deleteSaasConfigApiV1ConnectionConnectionKeySaasConfigDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteSaasConfigApiV1ConnectionConnectionKeySaasConfigDeleteError = + deleteSaasConfigApiV1ConnectionConnectionKeySaasConfigDeleteErrors[keyof deleteSaasConfigApiV1ConnectionConnectionKeySaasConfigDeleteErrors]; + +export type deleteSaasConfigApiV1ConnectionConnectionKeySaasConfigDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deleteSaasConfigApiV1ConnectionConnectionKeySaasConfigDeleteResponse = + deleteSaasConfigApiV1ConnectionConnectionKeySaasConfigDeleteResponses[keyof deleteSaasConfigApiV1ConnectionConnectionKeySaasConfigDeleteResponses]; + +export type getSaasConfigApiV1ConnectionConnectionKeySaasConfigGetData = { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/saas_config"; +}; + +export type getSaasConfigApiV1ConnectionConnectionKeySaasConfigGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getSaasConfigApiV1ConnectionConnectionKeySaasConfigGetError = + getSaasConfigApiV1ConnectionConnectionKeySaasConfigGetErrors[keyof getSaasConfigApiV1ConnectionConnectionKeySaasConfigGetErrors]; + +export type getSaasConfigApiV1ConnectionConnectionKeySaasConfigGetResponses = { + /** + * Successful Response + */ + 200: SaaSConfig; +}; + +export type getSaasConfigApiV1ConnectionConnectionKeySaasConfigGetResponse = + getSaasConfigApiV1ConnectionConnectionKeySaasConfigGetResponses[keyof getSaasConfigApiV1ConnectionConnectionKeySaasConfigGetResponses]; + +export type patchSaasConfigApiV1ConnectionConnectionKeySaasConfigPatchData = { + body: SaaSConfig; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/saas_config"; +}; + +export type patchSaasConfigApiV1ConnectionConnectionKeySaasConfigPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type patchSaasConfigApiV1ConnectionConnectionKeySaasConfigPatchError = + patchSaasConfigApiV1ConnectionConnectionKeySaasConfigPatchErrors[keyof patchSaasConfigApiV1ConnectionConnectionKeySaasConfigPatchErrors]; + +export type patchSaasConfigApiV1ConnectionConnectionKeySaasConfigPatchResponses = + { + /** + * Successful Response + */ + 200: SaaSConfig; + }; + +export type patchSaasConfigApiV1ConnectionConnectionKeySaasConfigPatchResponse = + patchSaasConfigApiV1ConnectionConnectionKeySaasConfigPatchResponses[keyof patchSaasConfigApiV1ConnectionConnectionKeySaasConfigPatchResponses]; + +export type authorizeConnectionApiV1ConnectionConnectionKeyAuthorizeGetData = { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/authorize"; +}; + +export type authorizeConnectionApiV1ConnectionConnectionKeyAuthorizeGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type authorizeConnectionApiV1ConnectionConnectionKeyAuthorizeGetError = + authorizeConnectionApiV1ConnectionConnectionKeyAuthorizeGetErrors[keyof authorizeConnectionApiV1ConnectionConnectionKeyAuthorizeGetErrors]; + +export type authorizeConnectionApiV1ConnectionConnectionKeyAuthorizeGetResponses = + { + /** + * Response Authorize Connection Api V1 Connection Connection Key Authorize Get + * + * Successful Response + */ + 200: string; + }; + +export type authorizeConnectionApiV1ConnectionConnectionKeyAuthorizeGetResponse = + authorizeConnectionApiV1ConnectionConnectionKeyAuthorizeGetResponses[keyof authorizeConnectionApiV1ConnectionConnectionKeyAuthorizeGetResponses]; + +export type verifyDatasetPartitioningSchemasApiV1DatasetPartitionsVerifyPostData = + { + /** + * Partitions + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/dataset/partitions/verify"; + }; + +export type verifyDatasetPartitioningSchemasApiV1DatasetPartitionsVerifyPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type verifyDatasetPartitioningSchemasApiV1DatasetPartitionsVerifyPostError = + verifyDatasetPartitioningSchemasApiV1DatasetPartitionsVerifyPostErrors[keyof verifyDatasetPartitioningSchemasApiV1DatasetPartitionsVerifyPostErrors]; + +export type verifyDatasetPartitioningSchemasApiV1DatasetPartitionsVerifyPostResponses = + { + /** + * Response Verify Dataset Partitioning Schemas Api V1 Dataset Partitions Verify Post + * + * Successful Response + */ + 200: Array; + }; + +export type verifyDatasetPartitioningSchemasApiV1DatasetPartitionsVerifyPostResponse = + verifyDatasetPartitioningSchemasApiV1DatasetPartitionsVerifyPostResponses[keyof verifyDatasetPartitioningSchemasApiV1DatasetPartitionsVerifyPostResponses]; + +export type deleteUserApiV1UserUserIdDeleteData = { + body?: never; + path: { + /** + * User Id + */ + user_id: string; + }; + query?: never; + url: "/api/v1/user/{user_id}"; +}; + +export type deleteUserApiV1UserUserIdDeleteErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteUserApiV1UserUserIdDeleteError = + deleteUserApiV1UserUserIdDeleteErrors[keyof deleteUserApiV1UserUserIdDeleteErrors]; + +export type deleteUserApiV1UserUserIdDeleteResponses = { + /** + * Successful Response + */ + 204: void; +}; + +export type deleteUserApiV1UserUserIdDeleteResponse = + deleteUserApiV1UserUserIdDeleteResponses[keyof deleteUserApiV1UserUserIdDeleteResponses]; + +export type getUserExtendedApiV1UserUserIdGetData = { + body?: never; + path: { + /** + * User Id + */ + user_id: string; + }; + query?: never; + url: "/api/v1/user/{user_id}"; +}; + +export type getUserExtendedApiV1UserUserIdGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getUserExtendedApiV1UserUserIdGetError = + getUserExtendedApiV1UserUserIdGetErrors[keyof getUserExtendedApiV1UserUserIdGetErrors]; + +export type getUserExtendedApiV1UserUserIdGetResponses = { + /** + * Successful Response + */ + 200: UserResponseExtended; +}; + +export type getUserExtendedApiV1UserUserIdGetResponse = + getUserExtendedApiV1UserUserIdGetResponses[keyof getUserExtendedApiV1UserUserIdGetResponses]; + +export type updateUserApiV1UserUserIdPutData = { + body: UserUpdate; + path: { + /** + * User Id + */ + user_id: string; + }; + query?: never; + url: "/api/v1/user/{user_id}"; +}; + +export type updateUserApiV1UserUserIdPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateUserApiV1UserUserIdPutError = + updateUserApiV1UserUserIdPutErrors[keyof updateUserApiV1UserUserIdPutErrors]; + +export type updateUserApiV1UserUserIdPutResponses = { + /** + * Successful Response + */ + 200: UserResponse; +}; + +export type updateUserApiV1UserUserIdPutResponse = + updateUserApiV1UserUserIdPutResponses[keyof updateUserApiV1UserUserIdPutResponses]; + +export type updateUserPasswordApiV1UserUserIdResetPasswordPostData = { + body: UserPasswordReset; + path: { + /** + * User Id + */ + user_id: string; + }; + query?: never; + url: "/api/v1/user/{user_id}/reset-password"; +}; + +export type updateUserPasswordApiV1UserUserIdResetPasswordPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateUserPasswordApiV1UserUserIdResetPasswordPostError = + updateUserPasswordApiV1UserUserIdResetPasswordPostErrors[keyof updateUserPasswordApiV1UserUserIdResetPasswordPostErrors]; + +export type updateUserPasswordApiV1UserUserIdResetPasswordPostResponses = { + /** + * Successful Response + */ + 200: UserResponse; +}; + +export type updateUserPasswordApiV1UserUserIdResetPasswordPostResponse = + updateUserPasswordApiV1UserUserIdResetPasswordPostResponses[keyof updateUserPasswordApiV1UserUserIdResetPasswordPostResponses]; + +export type forceUpdatePasswordApiV1UserUserIdForceResetPasswordPostData = { + body: UserForcePasswordReset; + path: { + /** + * User Id + */ + user_id: string; + }; + query?: never; + url: "/api/v1/user/{user_id}/force-reset-password"; +}; + +export type forceUpdatePasswordApiV1UserUserIdForceResetPasswordPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type forceUpdatePasswordApiV1UserUserIdForceResetPasswordPostError = + forceUpdatePasswordApiV1UserUserIdForceResetPasswordPostErrors[keyof forceUpdatePasswordApiV1UserUserIdForceResetPasswordPostErrors]; + +export type forceUpdatePasswordApiV1UserUserIdForceResetPasswordPostResponses = + { + /** + * Successful Response + */ + 200: UserResponse; + }; + +export type forceUpdatePasswordApiV1UserUserIdForceResetPasswordPostResponse = + forceUpdatePasswordApiV1UserUserIdForceResetPasswordPostResponses[keyof forceUpdatePasswordApiV1UserUserIdForceResetPasswordPostResponses]; + +export type userLogoutApiV1LogoutPostData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/logout"; +}; + +export type userLogoutApiV1LogoutPostResponses = { + /** + * Successful Response + */ + 204: void; +}; + +export type userLogoutApiV1LogoutPostResponse = + userLogoutApiV1LogoutPostResponses[keyof userLogoutApiV1LogoutPostResponses]; + +export type getManagedSystemsApiV1UserUserIdSystemManagerGetData = { + body?: never; + path: { + /** + * User Id + */ + user_id: string; + }; + query?: never; + url: "/api/v1/user/{user_id}/system-manager"; +}; + +export type getManagedSystemsApiV1UserUserIdSystemManagerGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getManagedSystemsApiV1UserUserIdSystemManagerGetError = + getManagedSystemsApiV1UserUserIdSystemManagerGetErrors[keyof getManagedSystemsApiV1UserUserIdSystemManagerGetErrors]; + +export type getManagedSystemsApiV1UserUserIdSystemManagerGetResponses = { + /** + * Response Get Managed Systems Api V1 User User Id System Manager Get + * + * Successful Response + */ + 200: Array; +}; + +export type getManagedSystemsApiV1UserUserIdSystemManagerGetResponse = + getManagedSystemsApiV1UserUserIdSystemManagerGetResponses[keyof getManagedSystemsApiV1UserUserIdSystemManagerGetResponses]; + +export type updateManagedSystemsApiV1UserUserIdSystemManagerPutData = { + /** + * Systems + */ + body: Array; + path: { + /** + * User Id + */ + user_id: string; + }; + query?: never; + url: "/api/v1/user/{user_id}/system-manager"; +}; + +export type updateManagedSystemsApiV1UserUserIdSystemManagerPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateManagedSystemsApiV1UserUserIdSystemManagerPutError = + updateManagedSystemsApiV1UserUserIdSystemManagerPutErrors[keyof updateManagedSystemsApiV1UserUserIdSystemManagerPutErrors]; + +export type updateManagedSystemsApiV1UserUserIdSystemManagerPutResponses = { + /** + * Response Update Managed Systems Api V1 User User Id System Manager Put + * + * Successful Response + */ + 200: Array; +}; + +export type updateManagedSystemsApiV1UserUserIdSystemManagerPutResponse = + updateManagedSystemsApiV1UserUserIdSystemManagerPutResponses[keyof updateManagedSystemsApiV1UserUserIdSystemManagerPutResponses]; + +export type removeUserAsSystemManagerApiV1UserUserIdSystemManagerSystemKeyDeleteData = + { + body?: never; + path: { + /** + * User Id + */ + user_id: string; + /** + * System Key + */ + system_key: string; + }; + query?: never; + url: "/api/v1/user/{user_id}/system-manager/{system_key}"; + }; + +export type removeUserAsSystemManagerApiV1UserUserIdSystemManagerSystemKeyDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type removeUserAsSystemManagerApiV1UserUserIdSystemManagerSystemKeyDeleteError = + removeUserAsSystemManagerApiV1UserUserIdSystemManagerSystemKeyDeleteErrors[keyof removeUserAsSystemManagerApiV1UserUserIdSystemManagerSystemKeyDeleteErrors]; + +export type removeUserAsSystemManagerApiV1UserUserIdSystemManagerSystemKeyDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type removeUserAsSystemManagerApiV1UserUserIdSystemManagerSystemKeyDeleteResponse = + removeUserAsSystemManagerApiV1UserUserIdSystemManagerSystemKeyDeleteResponses[keyof removeUserAsSystemManagerApiV1UserUserIdSystemManagerSystemKeyDeleteResponses]; + +export type getManagedSystemDetailsApiV1UserUserIdSystemManagerSystemKeyGetData = + { + body?: never; + path: { + /** + * User Id + */ + user_id: string; + /** + * System Key + */ + system_key: string; + }; + query?: never; + url: "/api/v1/user/{user_id}/system-manager/{system_key}"; + }; + +export type getManagedSystemDetailsApiV1UserUserIdSystemManagerSystemKeyGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getManagedSystemDetailsApiV1UserUserIdSystemManagerSystemKeyGetError = + getManagedSystemDetailsApiV1UserUserIdSystemManagerSystemKeyGetErrors[keyof getManagedSystemDetailsApiV1UserUserIdSystemManagerSystemKeyGetErrors]; + +export type getManagedSystemDetailsApiV1UserUserIdSystemManagerSystemKeyGetResponses = + { + /** + * Successful Response + */ + 200: System; + }; + +export type getManagedSystemDetailsApiV1UserUserIdSystemManagerSystemKeyGetResponse = + getManagedSystemDetailsApiV1UserUserIdSystemManagerSystemKeyGetResponses[keyof getManagedSystemDetailsApiV1UserUserIdSystemManagerSystemKeyGetResponses]; + +export type getUsersApiV1UserGetData = { + body?: never; + path?: never; + query?: { + /** + * Username + */ + username?: string | null; + /** + * Include External + */ + include_external?: boolean; + /** + * Exclude Approvers + */ + exclude_approvers?: boolean; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/user"; +}; + +export type getUsersApiV1UserGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getUsersApiV1UserGetError = + getUsersApiV1UserGetErrors[keyof getUsersApiV1UserGetErrors]; + +export type getUsersApiV1UserGetResponses = { + /** + * Successful Response + */ + 200: Page_UserResponse_; +}; + +export type getUsersApiV1UserGetResponse = + getUsersApiV1UserGetResponses[keyof getUsersApiV1UserGetResponses]; + +export type createUserExtendedApiV1UserPostData = { + body: UserCreateExtended; + path?: never; + query?: { + /** + * Config Path Override + */ + config_path_override?: string; + /** + * Verbose + */ + verbose?: boolean; + }; + url: "/api/v1/user"; +}; + +export type createUserExtendedApiV1UserPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createUserExtendedApiV1UserPostError = + createUserExtendedApiV1UserPostErrors[keyof createUserExtendedApiV1UserPostErrors]; + +export type createUserExtendedApiV1UserPostResponses = { + /** + * Successful Response + */ + 201: UserCreateResponse; +}; + +export type createUserExtendedApiV1UserPostResponse = + createUserExtendedApiV1UserPostResponses[keyof createUserExtendedApiV1UserPostResponses]; + +export type acceptUserInviteApiV1UserAcceptInvitePostData = { + body: UserForcePasswordReset; + path?: never; + query: { + /** + * Config Path Override + */ + config_path_override?: string; + /** + * Verbose + */ + verbose?: boolean; + /** + * Username + */ + username: string; + /** + * Invite Code + */ + invite_code: string; + }; + url: "/api/v1/user/accept-invite"; +}; + +export type acceptUserInviteApiV1UserAcceptInvitePostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type acceptUserInviteApiV1UserAcceptInvitePostError = + acceptUserInviteApiV1UserAcceptInvitePostErrors[keyof acceptUserInviteApiV1UserAcceptInvitePostErrors]; + +export type acceptUserInviteApiV1UserAcceptInvitePostResponses = { + /** + * Successful Response + */ + 200: UserLoginResponse; +}; + +export type acceptUserInviteApiV1UserAcceptInvitePostResponse = + acceptUserInviteApiV1UserAcceptInvitePostResponses[keyof acceptUserInviteApiV1UserAcceptInvitePostResponses]; + +export type deleteAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookDeleteData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/access_manual_webhook"; + }; + +export type deleteAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookDeleteError = + deleteAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookDeleteErrors[keyof deleteAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookDeleteErrors]; + +export type deleteAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deleteAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookDeleteResponse = + deleteAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookDeleteResponses[keyof deleteAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookDeleteResponses]; + +export type getAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/access_manual_webhook"; + }; + +export type getAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookGetError = + getAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookGetErrors[keyof getAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookGetErrors]; + +export type getAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookGetResponses = + { + /** + * Successful Response + */ + 200: AccessManualWebhookResponse; + }; + +export type getAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookGetResponse = + getAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookGetResponses[keyof getAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookGetResponses]; + +export type patchAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPatchData = + { + body: AccessManualWebhooks; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/access_manual_webhook"; + }; + +export type patchAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type patchAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPatchError = + patchAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPatchErrors[keyof patchAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPatchErrors]; + +export type patchAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPatchResponses = + { + /** + * Successful Response + */ + 200: AccessManualWebhookResponse; + }; + +export type patchAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPatchResponse = + patchAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPatchResponses[keyof patchAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPatchResponses]; + +export type createAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPostData = + { + body: AccessManualWebhooks; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/access_manual_webhook"; + }; + +export type createAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPostError = + createAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPostErrors[keyof createAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPostErrors]; + +export type createAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPostResponses = + { + /** + * Successful Response + */ + 201: AccessManualWebhookResponse; + }; + +export type createAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPostResponse = + createAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPostResponses[keyof createAccessManualWebhookApiV1ConnectionConnectionKeyAccessManualWebhookPostResponses]; + +export type getAccessManualWebhooksApiV1AccessManualWebhookGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/access_manual_webhook"; +}; + +export type getAccessManualWebhooksApiV1AccessManualWebhookGetResponses = { + /** + * Response Get Access Manual Webhooks Api V1 Access Manual Webhook Get + * + * Successful Response + */ + 200: Array; +}; + +export type getAccessManualWebhooksApiV1AccessManualWebhookGetResponse = + getAccessManualWebhooksApiV1AccessManualWebhookGetResponses[keyof getAccessManualWebhooksApiV1AccessManualWebhookGetResponses]; + +export type getRegistrationStatusApiV1RegistrationGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/registration"; +}; + +export type getRegistrationStatusApiV1RegistrationGetResponses = { + /** + * Successful Response + */ + 200: GetRegistrationStatusResponse; +}; + +export type getRegistrationStatusApiV1RegistrationGetResponse = + getRegistrationStatusApiV1RegistrationGetResponses[keyof getRegistrationStatusApiV1RegistrationGetResponses]; + +export type updateRegistrationStatusApiV1RegistrationPutData = { + body: Registration; + path?: never; + query?: never; + url: "/api/v1/registration"; +}; + +export type updateRegistrationStatusApiV1RegistrationPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateRegistrationStatusApiV1RegistrationPutError = + updateRegistrationStatusApiV1RegistrationPutErrors[keyof updateRegistrationStatusApiV1RegistrationPutErrors]; + +export type updateRegistrationStatusApiV1RegistrationPutResponses = { + /** + * Successful Response + */ + 200: Registration; +}; + +export type updateRegistrationStatusApiV1RegistrationPutResponse = + updateRegistrationStatusApiV1RegistrationPutResponses[keyof updateRegistrationStatusApiV1RegistrationPutResponses]; + +export type getWorkerStatsApiV1WorkerStatsGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/worker-stats"; +}; + +export type getWorkerStatsApiV1WorkerStatsGetResponses = { + /** + * Successful Response + */ + 200: WorkerStats; +}; + +export type getWorkerStatsApiV1WorkerStatsGetResponse = + getWorkerStatsApiV1WorkerStatsGetResponses[keyof getWorkerStatsApiV1WorkerStatsGetResponses]; + +export type getSystemLinksApiV1ConnectionConnectionKeySystemLinksGetData = { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/system-links"; +}; + +export type getSystemLinksApiV1ConnectionConnectionKeySystemLinksGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getSystemLinksApiV1ConnectionConnectionKeySystemLinksGetError = + getSystemLinksApiV1ConnectionConnectionKeySystemLinksGetErrors[keyof getSystemLinksApiV1ConnectionConnectionKeySystemLinksGetErrors]; + +export type getSystemLinksApiV1ConnectionConnectionKeySystemLinksGetResponses = + { + /** + * Response Get System Links Api V1 Connection Connection Key System Links Get + * + * Successful Response + */ + 200: Array; + }; + +export type getSystemLinksApiV1ConnectionConnectionKeySystemLinksGetResponse = + getSystemLinksApiV1ConnectionConnectionKeySystemLinksGetResponses[keyof getSystemLinksApiV1ConnectionConnectionKeySystemLinksGetResponses]; + +export type setSystemLinksApiV1ConnectionConnectionKeySystemLinksPutData = { + body: SetSystemLinksRequest; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/system-links"; +}; + +export type setSystemLinksApiV1ConnectionConnectionKeySystemLinksPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type setSystemLinksApiV1ConnectionConnectionKeySystemLinksPutError = + setSystemLinksApiV1ConnectionConnectionKeySystemLinksPutErrors[keyof setSystemLinksApiV1ConnectionConnectionKeySystemLinksPutErrors]; + +export type setSystemLinksApiV1ConnectionConnectionKeySystemLinksPutResponses = + { + /** + * Response Set System Links Api V1 Connection Connection Key System Links Put + * + * Successful Response + */ + 200: Array; + }; + +export type setSystemLinksApiV1ConnectionConnectionKeySystemLinksPutResponse = + setSystemLinksApiV1ConnectionConnectionKeySystemLinksPutResponses[keyof setSystemLinksApiV1ConnectionConnectionKeySystemLinksPutResponses]; + +export type deleteSystemLinkApiV1ConnectionConnectionKeySystemLinksSystemFidesKeyDeleteData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + /** + * System Fides Key + */ + system_fides_key: string; + }; + query?: never; + url: "/api/v1/connection/{connection_key}/system-links/{system_fides_key}"; + }; + +export type deleteSystemLinkApiV1ConnectionConnectionKeySystemLinksSystemFidesKeyDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteSystemLinkApiV1ConnectionConnectionKeySystemLinksSystemFidesKeyDeleteError = + deleteSystemLinkApiV1ConnectionConnectionKeySystemLinksSystemFidesKeyDeleteErrors[keyof deleteSystemLinkApiV1ConnectionConnectionKeySystemLinksSystemFidesKeyDeleteErrors]; + +export type deleteSystemLinkApiV1ConnectionConnectionKeySystemLinksSystemFidesKeyDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deleteSystemLinkApiV1ConnectionConnectionKeySystemLinksSystemFidesKeyDeleteResponse = + deleteSystemLinkApiV1ConnectionConnectionKeySystemLinksSystemFidesKeyDeleteResponses[keyof deleteSystemLinkApiV1ConnectionConnectionKeySystemLinksSystemFidesKeyDeleteResponses]; + +export type dbActionApiV1AdminDbActionPostData = { + body?: never; + path: { + action: DBActions; + }; + query?: { + /** + * Revision + */ + revision?: string | null; + }; + url: "/api/v1/admin/db/{action}"; +}; + +export type dbActionApiV1AdminDbActionPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type dbActionApiV1AdminDbActionPostError = + dbActionApiV1AdminDbActionPostErrors[keyof dbActionApiV1AdminDbActionPostErrors]; + +export type dbActionApiV1AdminDbActionPostResponses = { + /** + * Response Db Action Api V1 Admin Db Action Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type dbActionApiV1AdminDbActionPostResponse = + dbActionApiV1AdminDbActionPostResponses[keyof dbActionApiV1AdminDbActionPostResponses]; + +export type triggerHeapDumpApiV1AdminHeapDumpPostData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/admin/heap-dump"; +}; + +export type triggerHeapDumpApiV1AdminHeapDumpPostResponses = { + /** + * Response Trigger Heap Dump Api V1 Admin Heap Dump Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type triggerHeapDumpApiV1AdminHeapDumpPostResponse = + triggerHeapDumpApiV1AdminHeapDumpPostResponses[keyof triggerHeapDumpApiV1AdminHeapDumpPostResponses]; + +export type getBackfillStatusApiV1AdminBackfillGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/admin/backfill"; +}; + +export type getBackfillStatusApiV1AdminBackfillGetResponses = { + /** + * Successful Response + */ + 200: BackfillStatusResponse; +}; + +export type getBackfillStatusApiV1AdminBackfillGetResponse = + getBackfillStatusApiV1AdminBackfillGetResponses[keyof getBackfillStatusApiV1AdminBackfillGetResponses]; + +export type triggerBackfillApiV1AdminBackfillPostData = { + body?: BackfillRequest; + path?: never; + query?: never; + url: "/api/v1/admin/backfill"; +}; + +export type triggerBackfillApiV1AdminBackfillPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type triggerBackfillApiV1AdminBackfillPostError = + triggerBackfillApiV1AdminBackfillPostErrors[keyof triggerBackfillApiV1AdminBackfillPostErrors]; + +export type triggerBackfillApiV1AdminBackfillPostResponses = { + /** + * Response Trigger Backfill Api V1 Admin Backfill Post + * + * Successful Response + */ + 202: { + [key: string]: unknown; + }; +}; + +export type triggerBackfillApiV1AdminBackfillPostResponse = + triggerBackfillApiV1AdminBackfillPostResponses[keyof triggerBackfillApiV1AdminBackfillPostResponses]; + +export type listDatasetsOptionallyPaginatedApiV1DatasetGetData = { + body?: never; + path?: never; + query?: { + /** + * Size + */ + size?: number | null; + /** + * Page + */ + page?: number | null; + /** + * Search + */ + search?: string | null; + /** + * Data Categories + */ + data_categories?: Array | null; + /** + * Exclude Saas Datasets + */ + exclude_saas_datasets?: boolean | null; + /** + * Only Unlinked Datasets + */ + only_unlinked_datasets?: boolean | null; + /** + * Connection Type + */ + connection_type?: ConnectionType | null; + /** + * Minimal + */ + minimal?: boolean | null; + /** + * Skip Validation + * + * [Troubleshooting only] Skip pydantic response validation. Use this to retrieve datasets that contain data failing validation. + */ + skip_validation?: boolean; + }; + url: "/api/v1/dataset"; +}; + +export type listDatasetsOptionallyPaginatedApiV1DatasetGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type listDatasetsOptionallyPaginatedApiV1DatasetGetError = + listDatasetsOptionallyPaginatedApiV1DatasetGetErrors[keyof listDatasetsOptionallyPaginatedApiV1DatasetGetErrors]; + +export type listDatasetsOptionallyPaginatedApiV1DatasetGetResponses = { + /** + * Response List Datasets Optionally Paginated Api V1 Dataset Get + * + * Successful Response + */ + 200: Page_DatasetResponse_ | Array; +}; + +export type listDatasetsOptionallyPaginatedApiV1DatasetGetResponse = + listDatasetsOptionallyPaginatedApiV1DatasetGetResponses[keyof listDatasetsOptionallyPaginatedApiV1DatasetGetResponses]; + +export type createDatasetApiV1DatasetPostData = { + body: Dataset; + path?: never; + query?: never; + url: "/api/v1/dataset"; +}; + +export type createDatasetApiV1DatasetPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createDatasetApiV1DatasetPostError = + createDatasetApiV1DatasetPostErrors[keyof createDatasetApiV1DatasetPostErrors]; + +export type createDatasetApiV1DatasetPostResponses = { + /** + * Successful Response + */ + 201: Dataset; +}; + +export type createDatasetApiV1DatasetPostResponse = + createDatasetApiV1DatasetPostResponses[keyof createDatasetApiV1DatasetPostResponses]; + +export type updateDatasetApiV1DatasetPutData = { + body: Dataset; + path?: never; + query?: never; + url: "/api/v1/dataset"; +}; + +export type updateDatasetApiV1DatasetPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateDatasetApiV1DatasetPutError = + updateDatasetApiV1DatasetPutErrors[keyof updateDatasetApiV1DatasetPutErrors]; + +export type updateDatasetApiV1DatasetPutResponses = { + /** + * Successful Response + */ + 200: Dataset; +}; + +export type updateDatasetApiV1DatasetPutResponse = + updateDatasetApiV1DatasetPutResponses[keyof updateDatasetApiV1DatasetPutResponses]; + +export type deleteDatasetApiV1DatasetFidesKeyDeleteData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/dataset/{fides_key}"; +}; + +export type deleteDatasetApiV1DatasetFidesKeyDeleteErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteDatasetApiV1DatasetFidesKeyDeleteError = + deleteDatasetApiV1DatasetFidesKeyDeleteErrors[keyof deleteDatasetApiV1DatasetFidesKeyDeleteErrors]; + +export type deleteDatasetApiV1DatasetFidesKeyDeleteResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type getDatasetApiV1DatasetFidesKeyGetData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: { + /** + * Skip Validation + * + * [Troubleshooting only] Skip pydantic response validation. Use this to retrieve a dataset that contains data failing validation. + */ + skip_validation?: boolean; + }; + url: "/api/v1/dataset/{fides_key}"; +}; + +export type getDatasetApiV1DatasetFidesKeyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getDatasetApiV1DatasetFidesKeyGetError = + getDatasetApiV1DatasetFidesKeyGetErrors[keyof getDatasetApiV1DatasetFidesKeyGetErrors]; + +export type getDatasetApiV1DatasetFidesKeyGetResponses = { + /** + * Successful Response + */ + 200: Dataset; +}; + +export type getDatasetApiV1DatasetFidesKeyGetResponse = + getDatasetApiV1DatasetFidesKeyGetResponses[keyof getDatasetApiV1DatasetFidesKeyGetResponses]; + +export type upsertDatasetsApiV1DatasetUpsertPostData = { + /** + * Datasets + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/dataset/upsert"; +}; + +export type upsertDatasetsApiV1DatasetUpsertPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type upsertDatasetsApiV1DatasetUpsertPostError = + upsertDatasetsApiV1DatasetUpsertPostErrors[keyof upsertDatasetsApiV1DatasetUpsertPostErrors]; + +export type upsertDatasetsApiV1DatasetUpsertPostResponses = { + /** + * Response Upsert Datasets Api V1 Dataset Upsert Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type upsertDatasetsApiV1DatasetUpsertPostResponse = + upsertDatasetsApiV1DatasetUpsertPostResponses[keyof upsertDatasetsApiV1DatasetUpsertPostResponses]; + +export type cleanDatasetsApiV1DatasetCleanGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/dataset/clean"; +}; + +export type cleanDatasetsApiV1DatasetCleanGetResponses = { + /** + * Response Clean Datasets Api V1 Dataset Clean Get + * + * Successful Response + */ + 200: Array; +}; + +export type cleanDatasetsApiV1DatasetCleanGetResponse = + cleanDatasetsApiV1DatasetCleanGetResponses[keyof cleanDatasetsApiV1DatasetCleanGetResponses]; + +export type deleteTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsDeleteData = + { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/data_category/{fides_key}/tagging_instructions"; + }; + +export type deleteTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsDeleteError = + deleteTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsDeleteErrors[keyof deleteTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsDeleteErrors]; + +export type deleteTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsDeleteResponses = + { + /** + * Successful Response + */ + 200: DataCategory; + }; + +export type deleteTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsDeleteResponse = + deleteTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsDeleteResponses[keyof deleteTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsDeleteResponses]; + +export type updateTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsPatchData = + { + body: Body_Update_tagging_instructions_api_v1_data_category__fides_key__tagging_instructions_patch; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/data_category/{fides_key}/tagging_instructions"; + }; + +export type updateTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsPatchError = + updateTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsPatchErrors[keyof updateTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsPatchErrors]; + +export type updateTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsPatchResponses = + { + /** + * Successful Response + */ + 200: DataCategory; + }; + +export type updateTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsPatchResponse = + updateTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsPatchResponses[keyof updateTaggingInstructionsApiV1DataCategoryFidesKeyTaggingInstructionsPatchResponses]; + +export type getPrivacyPreferencesApiV3PrivacyPreferencesGetData = { + body?: never; + path?: never; + query?: { + /** + * Include Latest + */ + include_latest?: boolean; + /** + * Include Historical + */ + include_historical?: boolean; + /** + * Start Time + */ + start_time?: string | null; + /** + * End Time + */ + end_time?: string | null; + /** + * Time Inclusivity + */ + time_inclusivity?: TimeInclusivity | null; + /** + * Cursor + */ + cursor?: string | null; + /** + * Size + */ + size?: number; + /** + * Identity Email + * + * Filter by the `email` identity + */ + "identity.email"?: string; + /** + * Identity External Id + * + * Filter by the `external_id` identity + */ + "identity.external_id"?: string; + /** + * Identity Fides User Device Id + * + * Filter by the `fides_user_device_id` identity + */ + "identity.fides_user_device_id"?: string; + /** + * Identity Phone Number + * + * Filter by the `phone_number` identity + */ + "identity.phone_number"?: string; + }; + url: "/api/v3/privacy-preferences"; +}; + +export type getPrivacyPreferencesApiV3PrivacyPreferencesGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getPrivacyPreferencesApiV3PrivacyPreferencesGetError = + getPrivacyPreferencesApiV3PrivacyPreferencesGetErrors[keyof getPrivacyPreferencesApiV3PrivacyPreferencesGetErrors]; + +export type getPrivacyPreferencesApiV3PrivacyPreferencesGetResponses = { + /** + * Successful Response + */ + 200: PaginatedResponse_ConsentResponse_; +}; + +export type getPrivacyPreferencesApiV3PrivacyPreferencesGetResponse = + getPrivacyPreferencesApiV3PrivacyPreferencesGetResponses[keyof getPrivacyPreferencesApiV3PrivacyPreferencesGetResponses]; + +export type createPrivacyPreferencesApiV3PrivacyPreferencesPostData = { + body: ConsentCreate; + path?: never; + query?: { + /** + * Async + * + * Whether to run the operation asynchronously + */ + async?: boolean; + /** + * Policy + * + * Propagation policy for propagating consent choices through the hierarchy of notices. + */ + policy?: PropagationPolicyKey | null; + /** + * Response Notice Keys + * + * Only return preferences for the given notice keys in the response. This does not affect what preferences are saved, it just filters the response values. + */ + response_notice_keys?: Array | null; + }; + url: "/api/v3/privacy-preferences"; +}; + +export type createPrivacyPreferencesApiV3PrivacyPreferencesPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createPrivacyPreferencesApiV3PrivacyPreferencesPostError = + createPrivacyPreferencesApiV3PrivacyPreferencesPostErrors[keyof createPrivacyPreferencesApiV3PrivacyPreferencesPostErrors]; + +export type createPrivacyPreferencesApiV3PrivacyPreferencesPostResponses = { + /** + * Response Create Privacy Preferences Api V3 Privacy Preferences Post + * + * Successful Response + */ + 200: ConsentResponse | null; + /** + * Privacy preferences saved successfully + */ + 201: ConsentResponse; + /** + * Privacy preferences queued for asynchronous processing + */ + 202: unknown; +}; + +export type createPrivacyPreferencesApiV3PrivacyPreferencesPostResponse = + createPrivacyPreferencesApiV3PrivacyPreferencesPostResponses[keyof createPrivacyPreferencesApiV3PrivacyPreferencesPostResponses]; + +export type getResultSetStatsApiV3PrivacyPreferencesFilterStatsPostData = { + body: PaginationFilterParams; + path?: never; + query?: never; + url: "/api/v3/privacy-preferences/filter-stats"; +}; + +export type getResultSetStatsApiV3PrivacyPreferencesFilterStatsPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getResultSetStatsApiV3PrivacyPreferencesFilterStatsPostError = + getResultSetStatsApiV3PrivacyPreferencesFilterStatsPostErrors[keyof getResultSetStatsApiV3PrivacyPreferencesFilterStatsPostErrors]; + +export type getResultSetStatsApiV3PrivacyPreferencesFilterStatsPostResponses = { + /** + * Successful Response + */ + 200: ResultSetStats; +}; + +export type getResultSetStatsApiV3PrivacyPreferencesFilterStatsPostResponse = + getResultSetStatsApiV3PrivacyPreferencesFilterStatsPostResponses[keyof getResultSetStatsApiV3PrivacyPreferencesFilterStatsPostResponses]; + +export type getCurrentPrivacyPreferencesApiV3PrivacyPreferencesCurrentGetData = + { + body?: never; + path?: never; + query?: { + /** + * Notice Keys + * + * Only retrieve preferences for the given notice keys + */ + notice_keys?: Array | null; + /** + * Include Descendants + * + * Whether to include preferences for the descendants of the given notice keys; defaults to False + */ + include_descendants?: boolean | null; + /** + * Identity Email + * + * Filter by the `email` identity + */ + "identity.email"?: string; + /** + * Identity External Id + * + * Filter by the `external_id` identity + */ + "identity.external_id"?: string; + /** + * Identity Fides User Device Id + * + * Filter by the `fides_user_device_id` identity + */ + "identity.fides_user_device_id"?: string; + /** + * Identity Phone Number + * + * Filter by the `phone_number` identity + */ + "identity.phone_number"?: string; + }; + url: "/api/v3/privacy-preferences/current"; + }; + +export type getCurrentPrivacyPreferencesApiV3PrivacyPreferencesCurrentGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCurrentPrivacyPreferencesApiV3PrivacyPreferencesCurrentGetError = + getCurrentPrivacyPreferencesApiV3PrivacyPreferencesCurrentGetErrors[keyof getCurrentPrivacyPreferencesApiV3PrivacyPreferencesCurrentGetErrors]; + +export type getCurrentPrivacyPreferencesApiV3PrivacyPreferencesCurrentGetResponses = + { + /** + * Response Get Current Privacy Preferences Api V3 Privacy Preferences Current Get + * + * Successful Response + */ + 200: Array; + }; + +export type getCurrentPrivacyPreferencesApiV3PrivacyPreferencesCurrentGetResponse = + getCurrentPrivacyPreferencesApiV3PrivacyPreferencesCurrentGetResponses[keyof getCurrentPrivacyPreferencesApiV3PrivacyPreferencesCurrentGetResponses]; + +export type getIdentityDefinitionsApiV3DefinitionsIdentitiesGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v3/definitions/identities"; +}; + +export type getIdentityDefinitionsApiV3DefinitionsIdentitiesGetResponses = { + /** + * Response Get Identity Definitions Api V3 Definitions Identities Get + * + * Successful Response + */ + 200: Array; +}; + +export type getIdentityDefinitionsApiV3DefinitionsIdentitiesGetResponse = + getIdentityDefinitionsApiV3DefinitionsIdentitiesGetResponses[keyof getIdentityDefinitionsApiV3DefinitionsIdentitiesGetResponses]; + +export type createIdentityDefinitionApiV3DefinitionsIdentitiesPostData = { + body: IdentityDefinitionCreate; + path?: never; + query?: never; + url: "/api/v3/definitions/identities"; +}; + +export type createIdentityDefinitionApiV3DefinitionsIdentitiesPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createIdentityDefinitionApiV3DefinitionsIdentitiesPostError = + createIdentityDefinitionApiV3DefinitionsIdentitiesPostErrors[keyof createIdentityDefinitionApiV3DefinitionsIdentitiesPostErrors]; + +export type createIdentityDefinitionApiV3DefinitionsIdentitiesPostResponses = { + /** + * Successful Response + */ + 201: IdentityDefinitionEntity; +}; + +export type createIdentityDefinitionApiV3DefinitionsIdentitiesPostResponse = + createIdentityDefinitionApiV3DefinitionsIdentitiesPostResponses[keyof createIdentityDefinitionApiV3DefinitionsIdentitiesPostResponses]; + +export type deleteIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyDeleteData = + { + body?: never; + path: { + /** + * Identity Key + */ + identity_key: string; + }; + query?: never; + url: "/api/v3/definitions/identities/{identity_key}"; + }; + +export type deleteIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyDeleteError = + deleteIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyDeleteErrors[keyof deleteIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyDeleteErrors]; + +export type deleteIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deleteIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyDeleteResponse = + deleteIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyDeleteResponses[keyof deleteIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyDeleteResponses]; + +export type getIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyGetData = + { + body?: never; + path: { + /** + * Identity Key + */ + identity_key: string; + }; + query?: never; + url: "/api/v3/definitions/identities/{identity_key}"; + }; + +export type getIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyGetError = + getIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyGetErrors[keyof getIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyGetErrors]; + +export type getIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyGetResponses = + { + /** + * Successful Response + */ + 200: IdentityDefinitionEntity; + }; + +export type getIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyGetResponse = + getIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyGetResponses[keyof getIdentityDefinitionApiV3DefinitionsIdentitiesIdentityKeyGetResponses]; + +export type createExportPrivacyPreferencesTaskApiV3PrivacyPreferencesExportPostData = + { + body: CreateExportPrivacyPreferencesJobRequest; + path?: never; + query?: never; + url: "/api/v3/privacy-preferences/export"; + }; + +export type createExportPrivacyPreferencesTaskApiV3PrivacyPreferencesExportPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createExportPrivacyPreferencesTaskApiV3PrivacyPreferencesExportPostError = + createExportPrivacyPreferencesTaskApiV3PrivacyPreferencesExportPostErrors[keyof createExportPrivacyPreferencesTaskApiV3PrivacyPreferencesExportPostErrors]; + +export type createExportPrivacyPreferencesTaskApiV3PrivacyPreferencesExportPostResponses = + { + /** + * Successful Response + */ + 200: CreateExportPrivacyPreferencesJobResponse; + }; + +export type createExportPrivacyPreferencesTaskApiV3PrivacyPreferencesExportPostResponse = + createExportPrivacyPreferencesTaskApiV3PrivacyPreferencesExportPostResponses[keyof createExportPrivacyPreferencesTaskApiV3PrivacyPreferencesExportPostResponses]; + +export type createIngestionPrivacyPreferencesTaskApiV3PrivacyPreferencesImportPostData = + { + body: CreateIngestionPrivacyPreferencesJobRequest; + path?: never; + query?: never; + url: "/api/v3/privacy-preferences/import"; + }; + +export type createIngestionPrivacyPreferencesTaskApiV3PrivacyPreferencesImportPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createIngestionPrivacyPreferencesTaskApiV3PrivacyPreferencesImportPostError = + createIngestionPrivacyPreferencesTaskApiV3PrivacyPreferencesImportPostErrors[keyof createIngestionPrivacyPreferencesTaskApiV3PrivacyPreferencesImportPostErrors]; + +export type createIngestionPrivacyPreferencesTaskApiV3PrivacyPreferencesImportPostResponses = + { + /** + * Successful Response + */ + 200: CreateIngestionPrivacyPreferencesJobResponse; + }; + +export type createIngestionPrivacyPreferencesTaskApiV3PrivacyPreferencesImportPostResponse = + createIngestionPrivacyPreferencesTaskApiV3PrivacyPreferencesImportPostResponses[keyof createIngestionPrivacyPreferencesTaskApiV3PrivacyPreferencesImportPostResponses]; + +export type healthApiV1PlusHealthGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/health"; +}; + +export type healthApiV1PlusHealthGetResponses = { + /** + * Successful Response + */ + 200: HealthCheck; +}; + +export type healthApiV1PlusHealthGetResponse = + healthApiV1PlusHealthGetResponses[keyof healthApiV1PlusHealthGetResponses]; + +export type getClassifyInstancesApiV1PlusClassifyGetData = { + body?: never; + path?: never; + query?: { + resource_type?: GenerateTypes; + /** + * Fides Keys + */ + fides_keys?: Array | null; + /** + * Disable With Monitors + */ + disable_with_monitors?: boolean; + }; + url: "/api/v1/plus/classify"; +}; + +export type getClassifyInstancesApiV1PlusClassifyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getClassifyInstancesApiV1PlusClassifyGetError = + getClassifyInstancesApiV1PlusClassifyGetErrors[keyof getClassifyInstancesApiV1PlusClassifyGetErrors]; + +export type getClassifyInstancesApiV1PlusClassifyGetResponses = { + /** + * Response Get Classify Instances Api V1 Plus Classify Get + * + * Successful Response + */ + 200: Array; +}; + +export type getClassifyInstancesApiV1PlusClassifyGetResponse = + getClassifyInstancesApiV1PlusClassifyGetResponses[keyof getClassifyInstancesApiV1PlusClassifyGetResponses]; + +export type classifyDatasetApiV1PlusClassifyPostData = { + body: ClassifyRequestPayload; + path?: never; + query?: never; + url: "/api/v1/plus/classify"; +}; + +export type classifyDatasetApiV1PlusClassifyPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type classifyDatasetApiV1PlusClassifyPostError = + classifyDatasetApiV1PlusClassifyPostErrors[keyof classifyDatasetApiV1PlusClassifyPostErrors]; + +export type classifyDatasetApiV1PlusClassifyPostResponses = { + /** + * Successful Response + */ + 201: ClassifyDatasetResponse; +}; + +export type classifyDatasetApiV1PlusClassifyPostResponse = + classifyDatasetApiV1PlusClassifyPostResponses[keyof classifyDatasetApiV1PlusClassifyPostResponses]; + +export type updateClassifyInstanceStateApiV1PlusClassifyPutData = { + body: ClassifyStatusUpdatePayload; + path?: never; + query?: { + resource_type?: GenerateTypes; + }; + url: "/api/v1/plus/classify"; +}; + +export type updateClassifyInstanceStateApiV1PlusClassifyPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateClassifyInstanceStateApiV1PlusClassifyPutError = + updateClassifyInstanceStateApiV1PlusClassifyPutErrors[keyof updateClassifyInstanceStateApiV1PlusClassifyPutErrors]; + +export type updateClassifyInstanceStateApiV1PlusClassifyPutResponses = { + /** + * Successful Response + */ + 204: void; +}; + +export type updateClassifyInstanceStateApiV1PlusClassifyPutResponse = + updateClassifyInstanceStateApiV1PlusClassifyPutResponses[keyof updateClassifyInstanceStateApiV1PlusClassifyPutResponses]; + +export type getClassificationDetailsApiV1PlusClassifyDetailsDatasetFidesKeyGetData = + { + body?: never; + path: { + /** + * Dataset Fides Key + */ + dataset_fides_key: string; + }; + query?: { + resource_type?: GenerateTypes; + /** + * Disable With Monitors + */ + disable_with_monitors?: boolean; + }; + url: "/api/v1/plus/classify/details/{dataset_fides_key}"; + }; + +export type getClassificationDetailsApiV1PlusClassifyDetailsDatasetFidesKeyGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getClassificationDetailsApiV1PlusClassifyDetailsDatasetFidesKeyGetError = + getClassificationDetailsApiV1PlusClassifyDetailsDatasetFidesKeyGetErrors[keyof getClassificationDetailsApiV1PlusClassifyDetailsDatasetFidesKeyGetErrors]; + +export type getClassificationDetailsApiV1PlusClassifyDetailsDatasetFidesKeyGetResponses = + { + /** + * Response Get Classification Details Api V1 Plus Classify Details Dataset Fides Key Get + * + * Successful Response + */ + 200: ClassificationResponse | ClassifySystem | ClassifyEmpty; + }; + +export type getClassificationDetailsApiV1PlusClassifyDetailsDatasetFidesKeyGetResponse = + getClassificationDetailsApiV1PlusClassifyDetailsDatasetFidesKeyGetResponses[keyof getClassificationDetailsApiV1PlusClassifyDetailsDatasetFidesKeyGetResponses]; + +export type scanDuplicateApiV1PlusScanGetData = { + body?: never; + path?: never; + query?: { + /** + * Include Empty Fields + * + * Whether to write empty fields to the generated System resources. + */ + include_empty_fields?: boolean; + /** + * Organization + * + * The `organization_fides_key` to use when creating System resources. + */ + organization?: string; + /** + * Classify + */ + classify?: boolean; + }; + url: "/api/v1/plus/scan"; +}; + +export type scanDuplicateApiV1PlusScanGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; + /** + * Internal Server Error + */ + 500: { + detail?: string; + }; +}; + +export type scanDuplicateApiV1PlusScanGetError = + scanDuplicateApiV1PlusScanGetErrors[keyof scanDuplicateApiV1PlusScanGetErrors]; + +export type scanDuplicateApiV1PlusScanGetResponses = { + /** + * Successful Response + */ + 200: SystemScanResponse; +}; + +export type scanDuplicateApiV1PlusScanGetResponse = + scanDuplicateApiV1PlusScanGetResponses[keyof scanDuplicateApiV1PlusScanGetResponses]; + +export type scanApiV1PlusScanPutData = { + body?: never; + path?: never; + query?: { + /** + * Include Empty Fields + * + * Whether to write empty fields to the generated System resources. + */ + include_empty_fields?: boolean; + /** + * Organization + * + * The `organization_fides_key` to use when creating System resources. + */ + organization?: string; + /** + * Classify + */ + classify?: boolean; + }; + url: "/api/v1/plus/scan"; +}; + +export type scanApiV1PlusScanPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; + /** + * Internal Server Error + */ + 500: { + detail?: string; + }; +}; + +export type scanApiV1PlusScanPutError = + scanApiV1PlusScanPutErrors[keyof scanApiV1PlusScanPutErrors]; + +export type scanApiV1PlusScanPutResponses = { + /** + * Successful Response + */ + 200: SystemScanResponse; +}; + +export type scanApiV1PlusScanPutResponse = + scanApiV1PlusScanPutResponses[keyof scanApiV1PlusScanPutResponses]; + +export type latestScanApiV1PlusScanLatestGetData = { + body?: never; + path?: never; + query?: { + /** + * Diff + */ + diff?: boolean | null; + }; + url: "/api/v1/plus/scan/latest"; +}; + +export type latestScanApiV1PlusScanLatestGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type latestScanApiV1PlusScanLatestGetError = + latestScanApiV1PlusScanLatestGetErrors[keyof latestScanApiV1PlusScanLatestGetErrors]; + +export type latestScanApiV1PlusScanLatestGetResponses = { + /** + * Response Latest Scan Api V1 Plus Scan Latest Get + * + * Successful Response + */ + 200: SystemScanHistory | SystemsDiff; +}; + +export type latestScanApiV1PlusScanLatestGetResponse = + latestScanApiV1PlusScanLatestGetResponses[keyof latestScanApiV1PlusScanLatestGetResponses]; + +export type getScanByIdApiV1PlusScanScanIdGetData = { + body?: never; + path: { + /** + * Scan Id + */ + scan_id: number; + }; + query?: { + /** + * Diff + */ + diff?: boolean | null; + }; + url: "/api/v1/plus/scan/{scan_id}"; +}; + +export type getScanByIdApiV1PlusScanScanIdGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getScanByIdApiV1PlusScanScanIdGetError = + getScanByIdApiV1PlusScanScanIdGetErrors[keyof getScanByIdApiV1PlusScanScanIdGetErrors]; + +export type getScanByIdApiV1PlusScanScanIdGetResponses = { + /** + * Response Get Scan By Id Api V1 Plus Scan Scan Id Get + * + * Successful Response + */ + 200: SystemScanHistory | SystemsDiff; +}; + +export type getScanByIdApiV1PlusScanScanIdGetResponse = + getScanByIdApiV1PlusScanScanIdGetResponses[keyof getScanByIdApiV1PlusScanScanIdGetResponses]; + +export type getSystemAssetsApiV1PlusSystemAssetsFidesKeyGetData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: { + /** + * Search + */ + search?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/system-assets/{fides_key}"; +}; + +export type getSystemAssetsApiV1PlusSystemAssetsFidesKeyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getSystemAssetsApiV1PlusSystemAssetsFidesKeyGetError = + getSystemAssetsApiV1PlusSystemAssetsFidesKeyGetErrors[keyof getSystemAssetsApiV1PlusSystemAssetsFidesKeyGetErrors]; + +export type getSystemAssetsApiV1PlusSystemAssetsFidesKeyGetResponses = { + /** + * Successful Response + */ + 200: Page_Asset_; +}; + +export type getSystemAssetsApiV1PlusSystemAssetsFidesKeyGetResponse = + getSystemAssetsApiV1PlusSystemAssetsFidesKeyGetResponses[keyof getSystemAssetsApiV1PlusSystemAssetsFidesKeyGetResponses]; + +export type getAssetApiV1PlusSystemAssetsFidesKeyAssetsAssetIdGetData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + /** + * Asset Id + */ + asset_id: string; + }; + query?: never; + url: "/api/v1/plus/system-assets/{fides_key}/assets/{asset_id}"; +}; + +export type getAssetApiV1PlusSystemAssetsFidesKeyAssetsAssetIdGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getAssetApiV1PlusSystemAssetsFidesKeyAssetsAssetIdGetError = + getAssetApiV1PlusSystemAssetsFidesKeyAssetsAssetIdGetErrors[keyof getAssetApiV1PlusSystemAssetsFidesKeyAssetsAssetIdGetErrors]; + +export type getAssetApiV1PlusSystemAssetsFidesKeyAssetsAssetIdGetResponses = { + /** + * Successful Response + */ + 200: Asset; +}; + +export type getAssetApiV1PlusSystemAssetsFidesKeyAssetsAssetIdGetResponse = + getAssetApiV1PlusSystemAssetsFidesKeyAssetsAssetIdGetResponses[keyof getAssetApiV1PlusSystemAssetsFidesKeyAssetsAssetIdGetResponses]; + +export type deleteSystemAssetsApiV1PlusSystemAssetsFidesKeyAssetsDeleteData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query: { + /** + * Asset Ids + */ + asset_ids: Array; + }; + url: "/api/v1/plus/system-assets/{fides_key}/assets"; +}; + +export type deleteSystemAssetsApiV1PlusSystemAssetsFidesKeyAssetsDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteSystemAssetsApiV1PlusSystemAssetsFidesKeyAssetsDeleteError = + deleteSystemAssetsApiV1PlusSystemAssetsFidesKeyAssetsDeleteErrors[keyof deleteSystemAssetsApiV1PlusSystemAssetsFidesKeyAssetsDeleteErrors]; + +export type deleteSystemAssetsApiV1PlusSystemAssetsFidesKeyAssetsDeleteResponses = + { + /** + * Response Delete System Assets Api V1 Plus System Assets Fides Key Assets Delete + * + * Successful Response + */ + 200: { + [key: string]: number; + }; + }; + +export type deleteSystemAssetsApiV1PlusSystemAssetsFidesKeyAssetsDeleteResponse = + deleteSystemAssetsApiV1PlusSystemAssetsFidesKeyAssetsDeleteResponses[keyof deleteSystemAssetsApiV1PlusSystemAssetsFidesKeyAssetsDeleteResponses]; + +export type createAssetApiV1PlusSystemAssetsFidesKeyAssetsPostData = { + body: AssetCreate; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/plus/system-assets/{fides_key}/assets"; +}; + +export type createAssetApiV1PlusSystemAssetsFidesKeyAssetsPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createAssetApiV1PlusSystemAssetsFidesKeyAssetsPostError = + createAssetApiV1PlusSystemAssetsFidesKeyAssetsPostErrors[keyof createAssetApiV1PlusSystemAssetsFidesKeyAssetsPostErrors]; + +export type createAssetApiV1PlusSystemAssetsFidesKeyAssetsPostResponses = { + /** + * Successful Response + */ + 200: Asset; +}; + +export type createAssetApiV1PlusSystemAssetsFidesKeyAssetsPostResponse = + createAssetApiV1PlusSystemAssetsFidesKeyAssetsPostResponses[keyof createAssetApiV1PlusSystemAssetsFidesKeyAssetsPostResponses]; + +export type updateAssetApiV1PlusSystemAssetsFidesKeyAssetsPutData = { + /** + * Updates + */ + body: Array; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/plus/system-assets/{fides_key}/assets"; +}; + +export type updateAssetApiV1PlusSystemAssetsFidesKeyAssetsPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateAssetApiV1PlusSystemAssetsFidesKeyAssetsPutError = + updateAssetApiV1PlusSystemAssetsFidesKeyAssetsPutErrors[keyof updateAssetApiV1PlusSystemAssetsFidesKeyAssetsPutErrors]; + +export type updateAssetApiV1PlusSystemAssetsFidesKeyAssetsPutResponses = { + /** + * Response Update Asset Api V1 Plus System Assets Fides Key Assets Put + * + * Successful Response + */ + 200: Array; +}; + +export type updateAssetApiV1PlusSystemAssetsFidesKeyAssetsPutResponse = + updateAssetApiV1PlusSystemAssetsFidesKeyAssetsPutResponses[keyof updateAssetApiV1PlusSystemAssetsFidesKeyAssetsPutResponses]; + +export type getAllAssetsApiV1PlusAssetsReportGetData = { + body?: never; + path?: never; + query?: { + /** + * Asset Type + */ + asset_type?: Array | null; + /** + * Consent Status + */ + consent_status?: Array | null; + /** + * System Id + */ + system_id?: Array | null; + /** + * Data Uses + */ + data_uses?: Array | null; + /** + * Locations + */ + locations?: Array | null; + /** + * Search + */ + search?: string | null; + /** + * Sort By + * + * Columns to sort by + */ + sort_by?: Array | null; + /** + * Sort Asc + * + * Sort ascending if true + */ + sort_asc?: boolean | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/assets-report"; +}; + +export type getAllAssetsApiV1PlusAssetsReportGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getAllAssetsApiV1PlusAssetsReportGetError = + getAllAssetsApiV1PlusAssetsReportGetErrors[keyof getAllAssetsApiV1PlusAssetsReportGetErrors]; + +export type getAllAssetsApiV1PlusAssetsReportGetResponses = { + /** + * Successful Response + */ + 200: Page_Asset_; +}; + +export type getAllAssetsApiV1PlusAssetsReportGetResponse = + getAllAssetsApiV1PlusAssetsReportGetResponses[keyof getAllAssetsApiV1PlusAssetsReportGetResponses]; + +export type exportAssetsCsvApiV1PlusAssetsReportExportedAssetsGetData = { + body?: never; + path?: never; + query?: { + /** + * Asset Type + */ + asset_type?: Array | null; + /** + * Consent Status + */ + consent_status?: Array | null; + /** + * System Id + */ + system_id?: Array | null; + /** + * Data Uses + */ + data_uses?: Array | null; + /** + * Locations + */ + locations?: Array | null; + /** + * Search + */ + search?: string | null; + }; + url: "/api/v1/plus/assets-report/exported-assets"; +}; + +export type exportAssetsCsvApiV1PlusAssetsReportExportedAssetsGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type exportAssetsCsvApiV1PlusAssetsReportExportedAssetsGetError = + exportAssetsCsvApiV1PlusAssetsReportExportedAssetsGetErrors[keyof exportAssetsCsvApiV1PlusAssetsReportExportedAssetsGetErrors]; + +export type exportAssetsCsvApiV1PlusAssetsReportExportedAssetsGetResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type getAssetReportingFiltersApiV1PlusAssetsReportFiltersGetData = { + body?: never; + path?: never; + query?: { + /** + * Asset Type + */ + asset_type?: Array | null; + /** + * Consent Status + */ + consent_status?: Array | null; + /** + * System Id + */ + system_id?: Array | null; + /** + * Data Uses + */ + data_uses?: Array | null; + /** + * Locations + */ + locations?: Array | null; + /** + * Search + */ + search?: string | null; + }; + url: "/api/v1/plus/assets-report/filters"; +}; + +export type getAssetReportingFiltersApiV1PlusAssetsReportFiltersGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getAssetReportingFiltersApiV1PlusAssetsReportFiltersGetError = + getAssetReportingFiltersApiV1PlusAssetsReportFiltersGetErrors[keyof getAssetReportingFiltersApiV1PlusAssetsReportFiltersGetErrors]; + +export type getAssetReportingFiltersApiV1PlusAssetsReportFiltersGetResponses = { + /** + * Successful Response + */ + 200: AssetReportingFilters; +}; + +export type getAssetReportingFiltersApiV1PlusAssetsReportFiltersGetResponse = + getAssetReportingFiltersApiV1PlusAssetsReportFiltersGetResponses[keyof getAssetReportingFiltersApiV1PlusAssetsReportFiltersGetResponses]; + +export type listClassificationBenchmarksApiV1PlusClassificationBenchmarkGetData = + { + body?: never; + path?: never; + query?: { + /** + * Monitor Config Key + */ + monitor_config_key?: string | null; + /** + * Dataset Fides Key + */ + dataset_fides_key?: string | null; + /** + * Created After + */ + created_after?: string | null; + /** + * Created Before + */ + created_before?: string | null; + /** + * Status + */ + status?: BenchmarkStatus | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/classification-benchmark"; + }; + +export type listClassificationBenchmarksApiV1PlusClassificationBenchmarkGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type listClassificationBenchmarksApiV1PlusClassificationBenchmarkGetError = + listClassificationBenchmarksApiV1PlusClassificationBenchmarkGetErrors[keyof listClassificationBenchmarksApiV1PlusClassificationBenchmarkGetErrors]; + +export type listClassificationBenchmarksApiV1PlusClassificationBenchmarkGetResponses = + { + /** + * Successful Response + */ + 200: Page_ClassificationBenchmarkSummary_; + }; + +export type listClassificationBenchmarksApiV1PlusClassificationBenchmarkGetResponse = + listClassificationBenchmarksApiV1PlusClassificationBenchmarkGetResponses[keyof listClassificationBenchmarksApiV1PlusClassificationBenchmarkGetResponses]; + +export type runClassificationBenchmarkApiV1PlusClassificationBenchmarkPostData = + { + body: ClassificationBenchmarkRequest; + path?: never; + query?: never; + url: "/api/v1/plus/classification-benchmark"; + }; + +export type runClassificationBenchmarkApiV1PlusClassificationBenchmarkPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type runClassificationBenchmarkApiV1PlusClassificationBenchmarkPostError = + runClassificationBenchmarkApiV1PlusClassificationBenchmarkPostErrors[keyof runClassificationBenchmarkApiV1PlusClassificationBenchmarkPostErrors]; + +export type runClassificationBenchmarkApiV1PlusClassificationBenchmarkPostResponses = + { + /** + * Successful Response + */ + 200: ClassificationBenchmarkResponse; + }; + +export type runClassificationBenchmarkApiV1PlusClassificationBenchmarkPostResponse = + runClassificationBenchmarkApiV1PlusClassificationBenchmarkPostResponses[keyof runClassificationBenchmarkApiV1PlusClassificationBenchmarkPostResponses]; + +export type getBenchmarkSummaryApiV1PlusClassificationBenchmarkBenchmarkIdSummaryGetData = + { + body?: never; + path: { + /** + * Benchmark Id + */ + benchmark_id: string; + }; + query?: never; + url: "/api/v1/plus/classification-benchmark/{benchmark_id}/summary"; + }; + +export type getBenchmarkSummaryApiV1PlusClassificationBenchmarkBenchmarkIdSummaryGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getBenchmarkSummaryApiV1PlusClassificationBenchmarkBenchmarkIdSummaryGetError = + getBenchmarkSummaryApiV1PlusClassificationBenchmarkBenchmarkIdSummaryGetErrors[keyof getBenchmarkSummaryApiV1PlusClassificationBenchmarkBenchmarkIdSummaryGetErrors]; + +export type getBenchmarkSummaryApiV1PlusClassificationBenchmarkBenchmarkIdSummaryGetResponses = + { + /** + * Successful Response + */ + 200: ClassificationBenchmarkSummary; + }; + +export type getBenchmarkSummaryApiV1PlusClassificationBenchmarkBenchmarkIdSummaryGetResponse = + getBenchmarkSummaryApiV1PlusClassificationBenchmarkBenchmarkIdSummaryGetResponses[keyof getBenchmarkSummaryApiV1PlusClassificationBenchmarkBenchmarkIdSummaryGetResponses]; + +export type getBenchmarkDetailsApiV1PlusClassificationBenchmarkBenchmarkIdDetailsGetData = + { + body?: never; + path: { + /** + * Benchmark Id + */ + benchmark_id: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/classification-benchmark/{benchmark_id}/details"; + }; + +export type getBenchmarkDetailsApiV1PlusClassificationBenchmarkBenchmarkIdDetailsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getBenchmarkDetailsApiV1PlusClassificationBenchmarkBenchmarkIdDetailsGetError = + getBenchmarkDetailsApiV1PlusClassificationBenchmarkBenchmarkIdDetailsGetErrors[keyof getBenchmarkDetailsApiV1PlusClassificationBenchmarkBenchmarkIdDetailsGetErrors]; + +export type getBenchmarkDetailsApiV1PlusClassificationBenchmarkBenchmarkIdDetailsGetResponses = + { + /** + * Successful Response + */ + 200: Page_FieldAccuracyDetail_; + }; + +export type getBenchmarkDetailsApiV1PlusClassificationBenchmarkBenchmarkIdDetailsGetResponse = + getBenchmarkDetailsApiV1PlusClassificationBenchmarkBenchmarkIdDetailsGetResponses[keyof getBenchmarkDetailsApiV1PlusClassificationBenchmarkBenchmarkIdDetailsGetResponses]; + +export type testAwsBedrockConnectionApiV1PlusConnectionAwsBedrockTestPostData = + { + body: BedrockConnectionTestRequest; + path?: never; + query?: never; + url: "/api/v1/plus/connection/aws-bedrock/test"; + }; + +export type testAwsBedrockConnectionApiV1PlusConnectionAwsBedrockTestPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type testAwsBedrockConnectionApiV1PlusConnectionAwsBedrockTestPostError = + testAwsBedrockConnectionApiV1PlusConnectionAwsBedrockTestPostErrors[keyof testAwsBedrockConnectionApiV1PlusConnectionAwsBedrockTestPostErrors]; + +export type testAwsBedrockConnectionApiV1PlusConnectionAwsBedrockTestPostResponses = + { + /** + * Successful Response + */ + 200: BedrockConnectionTestResponse; + }; + +export type testAwsBedrockConnectionApiV1PlusConnectionAwsBedrockTestPostResponse = + testAwsBedrockConnectionApiV1PlusConnectionAwsBedrockTestPostResponses[keyof testAwsBedrockConnectionApiV1PlusConnectionAwsBedrockTestPostResponses]; + +export type testChatConnectionApiV1PlusChatTestPostData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/chat/test"; +}; + +export type testChatConnectionApiV1PlusChatTestPostResponses = { + /** + * Successful Response + */ + 200: ChatConfigTestResponse; +}; + +export type testChatConnectionApiV1PlusChatTestPostResponse = + testChatConnectionApiV1PlusChatTestPostResponses[keyof testChatConnectionApiV1PlusChatTestPostResponses]; + +export type getChatChannelsApiV1PlusChatChannelsGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/chat/channels"; +}; + +export type getChatChannelsApiV1PlusChatChannelsGetResponses = { + /** + * Successful Response + */ + 200: ChatChannelsResponse; +}; + +export type getChatChannelsApiV1PlusChatChannelsGetResponse = + getChatChannelsApiV1PlusChatChannelsGetResponses[keyof getChatChannelsApiV1PlusChatChannelsGetResponses]; + +export type sendChatMessageApiV1PlusChatSendPostData = { + body: SendMessageRequest; + path?: never; + query?: never; + url: "/api/v1/plus/chat/send"; +}; + +export type sendChatMessageApiV1PlusChatSendPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type sendChatMessageApiV1PlusChatSendPostError = + sendChatMessageApiV1PlusChatSendPostErrors[keyof sendChatMessageApiV1PlusChatSendPostErrors]; + +export type sendChatMessageApiV1PlusChatSendPostResponses = { + /** + * Successful Response + */ + 200: SendMessageResponse; +}; + +export type sendChatMessageApiV1PlusChatSendPostResponse = + sendChatMessageApiV1PlusChatSendPostResponses[keyof sendChatMessageApiV1PlusChatSendPostResponses]; + +export type listChatConfigsApiV1PlusChatConfigGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/chat/config"; +}; + +export type listChatConfigsApiV1PlusChatConfigGetResponses = { + /** + * Successful Response + */ + 200: ChatConfigListResponse; +}; + +export type listChatConfigsApiV1PlusChatConfigGetResponse = + listChatConfigsApiV1PlusChatConfigGetResponses[keyof listChatConfigsApiV1PlusChatConfigGetResponses]; + +export type createChatConfigApiV1PlusChatConfigPostData = { + body: ChatConfigCreate; + path?: never; + query?: never; + url: "/api/v1/plus/chat/config"; +}; + +export type createChatConfigApiV1PlusChatConfigPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createChatConfigApiV1PlusChatConfigPostError = + createChatConfigApiV1PlusChatConfigPostErrors[keyof createChatConfigApiV1PlusChatConfigPostErrors]; + +export type createChatConfigApiV1PlusChatConfigPostResponses = { + /** + * Successful Response + */ + 200: ChatConfigResponse; +}; + +export type createChatConfigApiV1PlusChatConfigPostResponse = + createChatConfigApiV1PlusChatConfigPostResponses[keyof createChatConfigApiV1PlusChatConfigPostResponses]; + +export type deleteChatConfigApiV1PlusChatConfigConfigIdDeleteData = { + body?: never; + path: { + /** + * Config Id + */ + config_id: string; + }; + query?: never; + url: "/api/v1/plus/chat/config/{config_id}"; +}; + +export type deleteChatConfigApiV1PlusChatConfigConfigIdDeleteErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteChatConfigApiV1PlusChatConfigConfigIdDeleteError = + deleteChatConfigApiV1PlusChatConfigConfigIdDeleteErrors[keyof deleteChatConfigApiV1PlusChatConfigConfigIdDeleteErrors]; + +export type deleteChatConfigApiV1PlusChatConfigConfigIdDeleteResponses = { + /** + * Successful Response + */ + 204: void; +}; + +export type deleteChatConfigApiV1PlusChatConfigConfigIdDeleteResponse = + deleteChatConfigApiV1PlusChatConfigConfigIdDeleteResponses[keyof deleteChatConfigApiV1PlusChatConfigConfigIdDeleteResponses]; + +export type getChatConfigApiV1PlusChatConfigConfigIdGetData = { + body?: never; + path: { + /** + * Config Id + */ + config_id: string; + }; + query?: never; + url: "/api/v1/plus/chat/config/{config_id}"; +}; + +export type getChatConfigApiV1PlusChatConfigConfigIdGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getChatConfigApiV1PlusChatConfigConfigIdGetError = + getChatConfigApiV1PlusChatConfigConfigIdGetErrors[keyof getChatConfigApiV1PlusChatConfigConfigIdGetErrors]; + +export type getChatConfigApiV1PlusChatConfigConfigIdGetResponses = { + /** + * Successful Response + */ + 200: ChatConfigResponse; +}; + +export type getChatConfigApiV1PlusChatConfigConfigIdGetResponse = + getChatConfigApiV1PlusChatConfigConfigIdGetResponses[keyof getChatConfigApiV1PlusChatConfigConfigIdGetResponses]; + +export type updateChatConfigApiV1PlusChatConfigConfigIdPatchData = { + body: ChatConfigUpdate; + path: { + /** + * Config Id + */ + config_id: string; + }; + query?: never; + url: "/api/v1/plus/chat/config/{config_id}"; +}; + +export type updateChatConfigApiV1PlusChatConfigConfigIdPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateChatConfigApiV1PlusChatConfigConfigIdPatchError = + updateChatConfigApiV1PlusChatConfigConfigIdPatchErrors[keyof updateChatConfigApiV1PlusChatConfigConfigIdPatchErrors]; + +export type updateChatConfigApiV1PlusChatConfigConfigIdPatchResponses = { + /** + * Successful Response + */ + 200: ChatConfigResponse; +}; + +export type updateChatConfigApiV1PlusChatConfigConfigIdPatchResponse = + updateChatConfigApiV1PlusChatConfigConfigIdPatchResponses[keyof updateChatConfigApiV1PlusChatConfigConfigIdPatchResponses]; + +export type enableChatConfigApiV1PlusChatConfigConfigIdEnablePutData = { + body?: never; + path: { + /** + * Config Id + */ + config_id: string; + }; + query?: never; + url: "/api/v1/plus/chat/config/{config_id}/enable"; +}; + +export type enableChatConfigApiV1PlusChatConfigConfigIdEnablePutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type enableChatConfigApiV1PlusChatConfigConfigIdEnablePutError = + enableChatConfigApiV1PlusChatConfigConfigIdEnablePutErrors[keyof enableChatConfigApiV1PlusChatConfigConfigIdEnablePutErrors]; + +export type enableChatConfigApiV1PlusChatConfigConfigIdEnablePutResponses = { + /** + * Successful Response + */ + 200: ChatConfigResponse; +}; + +export type enableChatConfigApiV1PlusChatConfigConfigIdEnablePutResponse = + enableChatConfigApiV1PlusChatConfigConfigIdEnablePutResponses[keyof enableChatConfigApiV1PlusChatConfigConfigIdEnablePutResponses]; + +export type updateChatConfigSecretsApiV1PlusChatConfigConfigIdSecretPutData = { + body: ChatConfigSecrets; + path: { + /** + * Config Id + */ + config_id: string; + }; + query?: never; + url: "/api/v1/plus/chat/config/{config_id}/secret"; +}; + +export type updateChatConfigSecretsApiV1PlusChatConfigConfigIdSecretPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateChatConfigSecretsApiV1PlusChatConfigConfigIdSecretPutError = + updateChatConfigSecretsApiV1PlusChatConfigConfigIdSecretPutErrors[keyof updateChatConfigSecretsApiV1PlusChatConfigConfigIdSecretPutErrors]; + +export type updateChatConfigSecretsApiV1PlusChatConfigConfigIdSecretPutResponses = + { + /** + * Successful Response + */ + 200: ChatConfigResponse; + }; + +export type updateChatConfigSecretsApiV1PlusChatConfigConfigIdSecretPutResponse = + updateChatConfigSecretsApiV1PlusChatConfigConfigIdSecretPutResponses[keyof updateChatConfigSecretsApiV1PlusChatConfigConfigIdSecretPutResponses]; + +export type authorizeChatProviderApiV1PlusChatSlackAuthorizeGetData = { + body?: never; + path?: never; + query?: { + /** + * Config Id + */ + config_id?: string | null; + }; + url: "/api/v1/plus/chat/slack/authorize"; +}; + +export type authorizeChatProviderApiV1PlusChatSlackAuthorizeGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type authorizeChatProviderApiV1PlusChatSlackAuthorizeGetError = + authorizeChatProviderApiV1PlusChatSlackAuthorizeGetErrors[keyof authorizeChatProviderApiV1PlusChatSlackAuthorizeGetErrors]; + +export type authorizeChatProviderApiV1PlusChatSlackAuthorizeGetResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type slackOauthCallbackApiV1PlusChatSlackCallbackGetData = { + body?: never; + path?: never; + query: { + /** + * Code + */ + code: string; + /** + * State + */ + state: string; + }; + url: "/api/v1/plus/chat/slack/callback"; +}; + +export type slackOauthCallbackApiV1PlusChatSlackCallbackGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type slackOauthCallbackApiV1PlusChatSlackCallbackGetError = + slackOauthCallbackApiV1PlusChatSlackCallbackGetErrors[keyof slackOauthCallbackApiV1PlusChatSlackCallbackGetErrors]; + +export type slackOauthCallbackApiV1PlusChatSlackCallbackGetResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type slackEventsApiV1PlusChatSlackEventsPostData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/chat/slack/events"; +}; + +export type slackEventsApiV1PlusChatSlackEventsPostResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type retrieveAndMergeConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/consentable-items"; + }; + +export type retrieveAndMergeConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type retrieveAndMergeConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsGetError = + retrieveAndMergeConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsGetErrors[keyof retrieveAndMergeConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsGetErrors]; + +export type retrieveAndMergeConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsGetResponses = + { + /** + * Response Retrieve And Merge Consentable Items Api V1 Plus Connection Connection Key Consentable Items Get + * + * Successful Response + */ + 200: Array; + }; + +export type retrieveAndMergeConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsGetResponse = + retrieveAndMergeConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsGetResponses[keyof retrieveAndMergeConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsGetResponses]; + +export type saveMappedConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsPutData = + { + /** + * Mapped Consentable Items + */ + body: Array; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/consentable-items"; + }; + +export type saveMappedConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type saveMappedConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsPutError = + saveMappedConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsPutErrors[keyof saveMappedConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsPutErrors]; + +export type saveMappedConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsPutResponses = + { + /** + * Response Save Mapped Consentable Items Api V1 Plus Connection Connection Key Consentable Items Put + * + * Successful Response + */ + 200: Array; + }; + +export type saveMappedConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsPutResponse = + saveMappedConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsPutResponses[keyof saveMappedConsentableItemsApiV1PlusConnectionConnectionKeyConsentableItemsPutResponses]; + +export type connectionConsentWebhookApiV1PlusConnectionConnectionKeyConsentWebhookPostData = + { + /** + * Payload + */ + body: unknown; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/consent-webhook"; + }; + +export type connectionConsentWebhookApiV1PlusConnectionConnectionKeyConsentWebhookPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type connectionConsentWebhookApiV1PlusConnectionConnectionKeyConsentWebhookPostError = + connectionConsentWebhookApiV1PlusConnectionConnectionKeyConsentWebhookPostErrors[keyof connectionConsentWebhookApiV1PlusConnectionConnectionKeyConsentWebhookPostErrors]; + +export type connectionConsentWebhookApiV1PlusConnectionConnectionKeyConsentWebhookPostResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type createConsentWebhookTokenApiV1PlusConnectionConnectionKeyConsentWebhookTokenGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/consent-webhook/token"; + }; + +export type createConsentWebhookTokenApiV1PlusConnectionConnectionKeyConsentWebhookTokenGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createConsentWebhookTokenApiV1PlusConnectionConnectionKeyConsentWebhookTokenGetError = + createConsentWebhookTokenApiV1PlusConnectionConnectionKeyConsentWebhookTokenGetErrors[keyof createConsentWebhookTokenApiV1PlusConnectionConnectionKeyConsentWebhookTokenGetErrors]; + +export type createConsentWebhookTokenApiV1PlusConnectionConnectionKeyConsentWebhookTokenGetResponses = + { + /** + * Successful Response + */ + 200: AccessToken; + }; + +export type createConsentWebhookTokenApiV1PlusConnectionConnectionKeyConsentWebhookTokenGetResponse = + createConsentWebhookTokenApiV1PlusConnectionConnectionKeyConsentWebhookTokenGetResponses[keyof createConsentWebhookTokenApiV1PlusConnectionConnectionKeyConsentWebhookTokenGetResponses]; + +export type connectionDatahubSyncApiV1PlusConnectionDatahubConnectionKeySyncPostData = + { + body: ConnectionDatahubSyncPayload; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/connection/datahub/{connection_key}/sync"; + }; + +export type connectionDatahubSyncApiV1PlusConnectionDatahubConnectionKeySyncPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type connectionDatahubSyncApiV1PlusConnectionDatahubConnectionKeySyncPostError = + connectionDatahubSyncApiV1PlusConnectionDatahubConnectionKeySyncPostErrors[keyof connectionDatahubSyncApiV1PlusConnectionDatahubConnectionKeySyncPostErrors]; + +export type connectionDatahubSyncApiV1PlusConnectionDatahubConnectionKeySyncPostResponses = + { + /** + * Successful Response + */ + 200: ConnectionDatahubSyncResponse; + }; + +export type connectionDatahubSyncApiV1PlusConnectionDatahubConnectionKeySyncPostResponse = + connectionDatahubSyncApiV1PlusConnectionDatahubConnectionKeySyncPostResponses[keyof connectionDatahubSyncApiV1PlusConnectionDatahubConnectionKeySyncPostResponses]; + +export type getManualTaskForConnectionApiV1PlusConnectionConnectionKeyManualTaskGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/manual-task"; + }; + +export type getManualTaskForConnectionApiV1PlusConnectionConnectionKeyManualTaskGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getManualTaskForConnectionApiV1PlusConnectionConnectionKeyManualTaskGetError = + getManualTaskForConnectionApiV1PlusConnectionConnectionKeyManualTaskGetErrors[keyof getManualTaskForConnectionApiV1PlusConnectionConnectionKeyManualTaskGetErrors]; + +export type getManualTaskForConnectionApiV1PlusConnectionConnectionKeyManualTaskGetResponses = + { + /** + * Successful Response + */ + 200: ManualTaskResponse; + }; + +export type getManualTaskForConnectionApiV1PlusConnectionConnectionKeyManualTaskGetResponse = + getManualTaskForConnectionApiV1PlusConnectionConnectionKeyManualTaskGetResponses[keyof getManualTaskForConnectionApiV1PlusConnectionConnectionKeyManualTaskGetResponses]; + +export type createManualTaskApiV1PlusConnectionConnectionKeyManualTaskPostData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/manual-task"; + }; + +export type createManualTaskApiV1PlusConnectionConnectionKeyManualTaskPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createManualTaskApiV1PlusConnectionConnectionKeyManualTaskPostError = + createManualTaskApiV1PlusConnectionConnectionKeyManualTaskPostErrors[keyof createManualTaskApiV1PlusConnectionConnectionKeyManualTaskPostErrors]; + +export type createManualTaskApiV1PlusConnectionConnectionKeyManualTaskPostResponses = + { + /** + * Successful Response + */ + 201: ManualTaskResponse; + }; + +export type createManualTaskApiV1PlusConnectionConnectionKeyManualTaskPostResponse = + createManualTaskApiV1PlusConnectionConnectionKeyManualTaskPostResponses[keyof createManualTaskApiV1PlusConnectionConnectionKeyManualTaskPostResponses]; + +export type getManualTasksForAllConnectionsApiV1PlusConnectionManualTaskGetData = + { + body?: never; + path?: never; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/connection/manual-task"; + }; + +export type getManualTasksForAllConnectionsApiV1PlusConnectionManualTaskGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getManualTasksForAllConnectionsApiV1PlusConnectionManualTaskGetError = + getManualTasksForAllConnectionsApiV1PlusConnectionManualTaskGetErrors[keyof getManualTasksForAllConnectionsApiV1PlusConnectionManualTaskGetErrors]; + +export type getManualTasksForAllConnectionsApiV1PlusConnectionManualTaskGetResponses = + { + /** + * Successful Response + */ + 200: Page_ManualTaskResponse_; + }; + +export type getManualTasksForAllConnectionsApiV1PlusConnectionManualTaskGetResponse = + getManualTasksForAllConnectionsApiV1PlusConnectionManualTaskGetResponses[keyof getManualTasksForAllConnectionsApiV1PlusConnectionManualTaskGetResponses]; + +export type getManualTaskDependencyRequestConditionFieldsApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPrivacyRequestFieldsGetData = + { + body?: never; + path?: never; + query?: { + /** + * Action Type + * + * Filter available fields by action type. Use 'consent' to exclude fields not applicable to consent requests (e.g. due_date, execution_timeframe). + */ + action_type?: ActionType | null; + }; + url: "/api/v1/plus/connection/{connection_key}/manual-task/dependency-conditions/privacy-request-fields"; + }; + +export type getManualTaskDependencyRequestConditionFieldsApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPrivacyRequestFieldsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getManualTaskDependencyRequestConditionFieldsApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPrivacyRequestFieldsGetError = + getManualTaskDependencyRequestConditionFieldsApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPrivacyRequestFieldsGetErrors[keyof getManualTaskDependencyRequestConditionFieldsApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPrivacyRequestFieldsGetErrors]; + +export type getManualTaskDependencyRequestConditionFieldsApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPrivacyRequestFieldsGetResponses = + { + /** + * Successful Response + */ + 200: PrivacyRequestFieldsResponse; + }; + +export type getManualTaskDependencyRequestConditionFieldsApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPrivacyRequestFieldsGetResponse = + getManualTaskDependencyRequestConditionFieldsApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPrivacyRequestFieldsGetResponses[keyof getManualTaskDependencyRequestConditionFieldsApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPrivacyRequestFieldsGetResponses]; + +export type updateManualTaskConditionalDependenciesApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPutData = + { + /** + * Condition Assignment + */ + body: Array | BulkConditionAssignment; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: { + /** + * Config Field Key + * + * (Deprecated) Field key for field-level conditions. Use the bulk format with field_conditions instead. + */ + config_field_key?: string | null; + }; + url: "/api/v1/plus/connection/{connection_key}/manual-task/dependency-conditions"; + }; + +export type updateManualTaskConditionalDependenciesApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPutErrors = + { + /** + * Manual task not found + */ + 404: unknown; + /** + * Validation error + */ + 422: ValidationErrorResponse; + /** + * Internal server error + */ + 500: unknown; + }; + +export type updateManualTaskConditionalDependenciesApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPutError = + updateManualTaskConditionalDependenciesApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPutErrors[keyof updateManualTaskConditionalDependenciesApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPutErrors]; + +export type updateManualTaskConditionalDependenciesApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPutResponses = + { + /** + * Successful Response + */ + 200: ManualTaskResponse; + }; + +export type updateManualTaskConditionalDependenciesApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPutResponse = + updateManualTaskConditionalDependenciesApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPutResponses[keyof updateManualTaskConditionalDependenciesApiV1PlusConnectionConnectionKeyManualTaskDependencyConditionsPutResponses]; + +export type assignUsersToManualTaskApiV1PlusConnectionConnectionKeyManualTaskAssignUsersPutData = + { + /** + * User Assignment + */ + body: Array | BulkUserAssignment; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: { + /** + * Config Field Key + * + * (Deprecated) Field key for field-level assignment. Use the bulk format with field_users instead. + */ + config_field_key?: string | null; + }; + url: "/api/v1/plus/connection/{connection_key}/manual-task/assign-users"; + }; + +export type assignUsersToManualTaskApiV1PlusConnectionConnectionKeyManualTaskAssignUsersPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type assignUsersToManualTaskApiV1PlusConnectionConnectionKeyManualTaskAssignUsersPutError = + assignUsersToManualTaskApiV1PlusConnectionConnectionKeyManualTaskAssignUsersPutErrors[keyof assignUsersToManualTaskApiV1PlusConnectionConnectionKeyManualTaskAssignUsersPutErrors]; + +export type assignUsersToManualTaskApiV1PlusConnectionConnectionKeyManualTaskAssignUsersPutResponses = + { + /** + * Successful Response + */ + 200: ManualTaskResponse; + }; + +export type assignUsersToManualTaskApiV1PlusConnectionConnectionKeyManualTaskAssignUsersPutResponse = + assignUsersToManualTaskApiV1PlusConnectionConnectionKeyManualTaskAssignUsersPutResponses[keyof assignUsersToManualTaskApiV1PlusConnectionConnectionKeyManualTaskAssignUsersPutResponses]; + +export type deleteManualTaskApiV1PlusConnectionConnectionKeyManualTaskManualTaskIdDeleteData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + /** + * Manual Task Id + */ + manual_task_id: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/manual-task/{manual_task_id}"; + }; + +export type deleteManualTaskApiV1PlusConnectionConnectionKeyManualTaskManualTaskIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteManualTaskApiV1PlusConnectionConnectionKeyManualTaskManualTaskIdDeleteError = + deleteManualTaskApiV1PlusConnectionConnectionKeyManualTaskManualTaskIdDeleteErrors[keyof deleteManualTaskApiV1PlusConnectionConnectionKeyManualTaskManualTaskIdDeleteErrors]; + +export type deleteManualTaskApiV1PlusConnectionConnectionKeyManualTaskManualTaskIdDeleteResponses = + { + /** + * Response Delete Manual Task Api V1 Plus Connection Connection Key Manual Task Manual Task Id Delete + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; + }; + +export type deleteManualTaskApiV1PlusConnectionConnectionKeyManualTaskManualTaskIdDeleteResponse = + deleteManualTaskApiV1PlusConnectionConnectionKeyManualTaskManualTaskIdDeleteResponses[keyof deleteManualTaskApiV1PlusConnectionConnectionKeyManualTaskManualTaskIdDeleteResponses]; + +export type deleteManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigDeleteData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/manual-task-config"; + }; + +export type deleteManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigDeleteError = + deleteManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigDeleteErrors[keyof deleteManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigDeleteErrors]; + +export type deleteManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigDeleteResponses = + { + /** + * Response Delete Manual Task Configuration Api V1 Plus Connection Connection Key Manual Task Config Delete + * + * Successful Response + */ + 200: { + [key: string]: string; + }; + }; + +export type deleteManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigDeleteResponse = + deleteManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigDeleteResponses[keyof deleteManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigDeleteResponses]; + +export type getCurrentManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/manual-task-config"; + }; + +export type getCurrentManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCurrentManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigGetError = + getCurrentManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigGetErrors[keyof getCurrentManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigGetErrors]; + +export type getCurrentManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigGetResponses = + { + /** + * Response Get Current Manual Task Configuration Api V1 Plus Connection Connection Key Manual Task Config Get + * + * Successful Response + */ + 200: Array; + }; + +export type getCurrentManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigGetResponse = + getCurrentManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigGetResponses[keyof getCurrentManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigGetResponses]; + +export type createManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPostData = + { + body: ManualTaskConfigCreate; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/manual-task-config"; + }; + +export type createManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPostError = + createManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPostErrors[keyof createManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPostErrors]; + +export type createManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPostResponses = + { + /** + * Successful Response + */ + 201: ManualTaskConfigResponse; + }; + +export type createManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPostResponse = + createManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPostResponses[keyof createManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPostResponses]; + +export type updateManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPutData = + { + body: ManualTaskConfigUpdate; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/manual-task-config"; + }; + +export type updateManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPutError = + updateManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPutErrors[keyof updateManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPutErrors]; + +export type updateManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPutResponses = + { + /** + * Successful Response + */ + 200: ManualTaskConfigResponse; + }; + +export type updateManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPutResponse = + updateManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPutResponses[keyof updateManualTaskConfigurationApiV1PlusConnectionConnectionKeyManualTaskConfigPutResponses]; + +export type getAllManualTaskConfigurationsApiV1PlusConnectionManualTaskConfigurationsGetData = + { + body?: never; + path?: never; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/connection/manual-task/configurations"; + }; + +export type getAllManualTaskConfigurationsApiV1PlusConnectionManualTaskConfigurationsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAllManualTaskConfigurationsApiV1PlusConnectionManualTaskConfigurationsGetError = + getAllManualTaskConfigurationsApiV1PlusConnectionManualTaskConfigurationsGetErrors[keyof getAllManualTaskConfigurationsApiV1PlusConnectionManualTaskConfigurationsGetErrors]; + +export type getAllManualTaskConfigurationsApiV1PlusConnectionManualTaskConfigurationsGetResponses = + { + /** + * Successful Response + */ + 200: Page_ManualTaskConfigResponse_; + }; + +export type getAllManualTaskConfigurationsApiV1PlusConnectionManualTaskConfigurationsGetResponse = + getAllManualTaskConfigurationsApiV1PlusConnectionManualTaskConfigurationsGetResponses[keyof getAllManualTaskConfigurationsApiV1PlusConnectionManualTaskConfigurationsGetResponses]; + +export type listJiraProjectsApiV1PlusConnectionConnectionKeyJiraProjectsGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: { + /** + * Config Path Override + */ + config_path_override?: string; + /** + * Verbose + */ + verbose?: boolean; + }; + url: "/api/v1/plus/connection/{connection_key}/jira/projects"; + }; + +export type listJiraProjectsApiV1PlusConnectionConnectionKeyJiraProjectsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type listJiraProjectsApiV1PlusConnectionConnectionKeyJiraProjectsGetError = + listJiraProjectsApiV1PlusConnectionConnectionKeyJiraProjectsGetErrors[keyof listJiraProjectsApiV1PlusConnectionConnectionKeyJiraProjectsGetErrors]; + +export type listJiraProjectsApiV1PlusConnectionConnectionKeyJiraProjectsGetResponses = + { + /** + * Response List Jira Projects Api V1 Plus Connection Connection Key Jira Projects Get + * + * Successful Response + */ + 200: Array; + }; + +export type listJiraProjectsApiV1PlusConnectionConnectionKeyJiraProjectsGetResponse = + listJiraProjectsApiV1PlusConnectionConnectionKeyJiraProjectsGetResponses[keyof listJiraProjectsApiV1PlusConnectionConnectionKeyJiraProjectsGetResponses]; + +export type listJiraIssueTypesApiV1PlusConnectionConnectionKeyJiraProjectsProjectKeyIssuetypesGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + /** + * Project Key + */ + project_key: string; + }; + query?: { + /** + * Config Path Override + */ + config_path_override?: string; + /** + * Verbose + */ + verbose?: boolean; + }; + url: "/api/v1/plus/connection/{connection_key}/jira/projects/{project_key}/issuetypes"; + }; + +export type listJiraIssueTypesApiV1PlusConnectionConnectionKeyJiraProjectsProjectKeyIssuetypesGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type listJiraIssueTypesApiV1PlusConnectionConnectionKeyJiraProjectsProjectKeyIssuetypesGetError = + listJiraIssueTypesApiV1PlusConnectionConnectionKeyJiraProjectsProjectKeyIssuetypesGetErrors[keyof listJiraIssueTypesApiV1PlusConnectionConnectionKeyJiraProjectsProjectKeyIssuetypesGetErrors]; + +export type listJiraIssueTypesApiV1PlusConnectionConnectionKeyJiraProjectsProjectKeyIssuetypesGetResponses = + { + /** + * Response List Jira Issue Types Api V1 Plus Connection Connection Key Jira Projects Project Key Issuetypes Get + * + * Successful Response + */ + 200: Array; + }; + +export type listJiraIssueTypesApiV1PlusConnectionConnectionKeyJiraProjectsProjectKeyIssuetypesGetResponse = + listJiraIssueTypesApiV1PlusConnectionConnectionKeyJiraProjectsProjectKeyIssuetypesGetResponses[keyof listJiraIssueTypesApiV1PlusConnectionConnectionKeyJiraProjectsProjectKeyIssuetypesGetResponses]; + +export type listJiraStatusesApiV1PlusConnectionConnectionKeyJiraStatusesGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: { + /** + * Config Path Override + */ + config_path_override?: string; + /** + * Verbose + */ + verbose?: boolean; + }; + url: "/api/v1/plus/connection/{connection_key}/jira/statuses"; + }; + +export type listJiraStatusesApiV1PlusConnectionConnectionKeyJiraStatusesGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type listJiraStatusesApiV1PlusConnectionConnectionKeyJiraStatusesGetError = + listJiraStatusesApiV1PlusConnectionConnectionKeyJiraStatusesGetErrors[keyof listJiraStatusesApiV1PlusConnectionConnectionKeyJiraStatusesGetErrors]; + +export type listJiraStatusesApiV1PlusConnectionConnectionKeyJiraStatusesGetResponses = + { + /** + * Response List Jira Statuses Api V1 Plus Connection Connection Key Jira Statuses Get + * + * Successful Response + */ + 200: Array; + }; + +export type listJiraStatusesApiV1PlusConnectionConnectionKeyJiraStatusesGetResponse = + listJiraStatusesApiV1PlusConnectionConnectionKeyJiraStatusesGetResponses[keyof listJiraStatusesApiV1PlusConnectionConnectionKeyJiraStatusesGetResponses]; + +export type getJiraTemplateVariablesApiV1PlusConnectionConnectionKeyJiraTemplateVariablesGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/jira/template-variables"; + }; + +export type getJiraTemplateVariablesApiV1PlusConnectionConnectionKeyJiraTemplateVariablesGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getJiraTemplateVariablesApiV1PlusConnectionConnectionKeyJiraTemplateVariablesGetError = + getJiraTemplateVariablesApiV1PlusConnectionConnectionKeyJiraTemplateVariablesGetErrors[keyof getJiraTemplateVariablesApiV1PlusConnectionConnectionKeyJiraTemplateVariablesGetErrors]; + +export type getJiraTemplateVariablesApiV1PlusConnectionConnectionKeyJiraTemplateVariablesGetResponses = + { + /** + * Response Get Jira Template Variables Api V1 Plus Connection Connection Key Jira Template Variables Get + * + * Successful Response + */ + 200: Array; + }; + +export type getJiraTemplateVariablesApiV1PlusConnectionConnectionKeyJiraTemplateVariablesGetResponse = + getJiraTemplateVariablesApiV1PlusConnectionConnectionKeyJiraTemplateVariablesGetResponses[keyof getJiraTemplateVariablesApiV1PlusConnectionConnectionKeyJiraTemplateVariablesGetResponses]; + +export type previewJiraTicketApiV1PlusConnectionConnectionKeyJiraPreviewPostData = + { + body: JiraPreviewRequest; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/jira/preview"; + }; + +export type previewJiraTicketApiV1PlusConnectionConnectionKeyJiraPreviewPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type previewJiraTicketApiV1PlusConnectionConnectionKeyJiraPreviewPostError = + previewJiraTicketApiV1PlusConnectionConnectionKeyJiraPreviewPostErrors[keyof previewJiraTicketApiV1PlusConnectionConnectionKeyJiraPreviewPostErrors]; + +export type previewJiraTicketApiV1PlusConnectionConnectionKeyJiraPreviewPostResponses = + { + /** + * Successful Response + */ + 200: JiraTicketData; + }; + +export type previewJiraTicketApiV1PlusConnectionConnectionKeyJiraPreviewPostResponse = + previewJiraTicketApiV1PlusConnectionConnectionKeyJiraPreviewPostResponses[keyof previewJiraTicketApiV1PlusConnectionConnectionKeyJiraPreviewPostResponses]; + +export type initiateJiraOauthApiV1PlusOauthJiraInitiatePostData = { + body: JiraOAuthInitiateRequest; + path?: never; + query?: { + /** + * Config Path Override + */ + config_path_override?: string; + /** + * Verbose + */ + verbose?: boolean; + }; + url: "/api/v1/plus/oauth/jira/initiate"; +}; + +export type initiateJiraOauthApiV1PlusOauthJiraInitiatePostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type initiateJiraOauthApiV1PlusOauthJiraInitiatePostError = + initiateJiraOauthApiV1PlusOauthJiraInitiatePostErrors[keyof initiateJiraOauthApiV1PlusOauthJiraInitiatePostErrors]; + +export type initiateJiraOauthApiV1PlusOauthJiraInitiatePostResponses = { + /** + * Successful Response + */ + 200: JiraOAuthInitiateResponse; +}; + +export type initiateJiraOauthApiV1PlusOauthJiraInitiatePostResponse = + initiateJiraOauthApiV1PlusOauthJiraInitiatePostResponses[keyof initiateJiraOauthApiV1PlusOauthJiraInitiatePostResponses]; + +export type jiraOauthCallbackApiV1PlusOauthJiraCallbackGetData = { + body?: never; + path?: never; + query: { + /** + * Code + */ + code: string; + /** + * State + */ + state: string; + /** + * Config Path Override + */ + config_path_override?: string; + /** + * Verbose + */ + verbose?: boolean; + }; + url: "/api/v1/plus/oauth/jira/callback"; +}; + +export type jiraOauthCallbackApiV1PlusOauthJiraCallbackGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type jiraOauthCallbackApiV1PlusOauthJiraCallbackGetError = + jiraOauthCallbackApiV1PlusOauthJiraCallbackGetErrors[keyof jiraOauthCallbackApiV1PlusOauthJiraCallbackGetErrors]; + +export type jiraOauthCallbackApiV1PlusOauthJiraCallbackGetResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type getCustomAssetApiV1PlusCustomAssetAssetTypeGetData = { + body?: never; + path: { + asset_type: CustomAssetType; + }; + query?: never; + url: "/api/v1/plus/custom-asset/{asset_type}"; +}; + +export type getCustomAssetApiV1PlusCustomAssetAssetTypeGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getCustomAssetApiV1PlusCustomAssetAssetTypeGetError = + getCustomAssetApiV1PlusCustomAssetAssetTypeGetErrors[keyof getCustomAssetApiV1PlusCustomAssetAssetTypeGetErrors]; + +export type getCustomAssetApiV1PlusCustomAssetAssetTypeGetResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type updateCustomAssetApiV1PlusCustomAssetAssetTypePutData = { + /** + * Content + */ + body: string; + path: { + asset_type: CustomAssetType; + }; + query?: never; + url: "/api/v1/plus/custom-asset/{asset_type}"; +}; + +export type updateCustomAssetApiV1PlusCustomAssetAssetTypePutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateCustomAssetApiV1PlusCustomAssetAssetTypePutError = + updateCustomAssetApiV1PlusCustomAssetAssetTypePutErrors[keyof updateCustomAssetApiV1PlusCustomAssetAssetTypePutErrors]; + +export type updateCustomAssetApiV1PlusCustomAssetAssetTypePutResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type createCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPostData = + { + body: CustomField; + path?: never; + query?: never; + url: "/api/v1/plus/custom-metadata/custom-field"; + }; + +export type createCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPostError = + createCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPostErrors[keyof createCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPostErrors]; + +export type createCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPostResponses = + { + /** + * Successful Response + */ + 200: CustomFieldWithId; + }; + +export type createCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPostResponse = + createCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPostResponses[keyof createCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPostResponses]; + +export type updateOrCreateCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPutData = + { + body: CustomFieldWithId; + path?: never; + query?: never; + url: "/api/v1/plus/custom-metadata/custom-field"; + }; + +export type updateOrCreateCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateOrCreateCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPutError = + updateOrCreateCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPutErrors[keyof updateOrCreateCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPutErrors]; + +export type updateOrCreateCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPutResponses = + { + /** + * Successful Response + */ + 200: CustomFieldWithId; + }; + +export type updateOrCreateCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPutResponse = + updateOrCreateCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPutResponses[keyof updateOrCreateCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldPutResponses]; + +export type getCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldResourceResourceIdGetData = + { + body?: never; + path: { + /** + * Resource Id + */ + resource_id: string; + }; + query?: never; + url: "/api/v1/plus/custom-metadata/custom-field/resource/{resource_id}"; + }; + +export type getCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldResourceResourceIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldResourceResourceIdGetError = + getCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldResourceResourceIdGetErrors[keyof getCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldResourceResourceIdGetErrors]; + +export type getCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldResourceResourceIdGetResponses = + { + /** + * Response Get Custom Fields For Resource Api V1 Plus Custom Metadata Custom Field Resource Resource Id Get + * + * Successful Response + */ + 200: Array; + }; + +export type getCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldResourceResourceIdGetResponse = + getCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldResourceResourceIdGetResponses[keyof getCustomFieldsForResourceApiV1PlusCustomMetadataCustomFieldResourceResourceIdGetResponses]; + +export type bulkCustomFieldUpdateApiV1PlusCustomMetadataCustomFieldBulkPostData = + { + body: BulkCustomFieldRequest; + path?: never; + query?: never; + url: "/api/v1/plus/custom-metadata/custom-field/bulk"; + }; + +export type bulkCustomFieldUpdateApiV1PlusCustomMetadataCustomFieldBulkPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type bulkCustomFieldUpdateApiV1PlusCustomMetadataCustomFieldBulkPostError = + bulkCustomFieldUpdateApiV1PlusCustomMetadataCustomFieldBulkPostErrors[keyof bulkCustomFieldUpdateApiV1PlusCustomMetadataCustomFieldBulkPostErrors]; + +export type bulkCustomFieldUpdateApiV1PlusCustomMetadataCustomFieldBulkPostResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type deleteCustomFieldApiV1PlusCustomMetadataCustomFieldFieldIdDeleteData = + { + body?: never; + path: { + /** + * Field Id + */ + field_id: string; + }; + query?: never; + url: "/api/v1/plus/custom-metadata/custom-field/{field_id}"; + }; + +export type deleteCustomFieldApiV1PlusCustomMetadataCustomFieldFieldIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteCustomFieldApiV1PlusCustomMetadataCustomFieldFieldIdDeleteError = + deleteCustomFieldApiV1PlusCustomMetadataCustomFieldFieldIdDeleteErrors[keyof deleteCustomFieldApiV1PlusCustomMetadataCustomFieldFieldIdDeleteErrors]; + +export type deleteCustomFieldApiV1PlusCustomMetadataCustomFieldFieldIdDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deleteCustomFieldApiV1PlusCustomMetadataCustomFieldFieldIdDeleteResponse = + deleteCustomFieldApiV1PlusCustomMetadataCustomFieldFieldIdDeleteResponses[keyof deleteCustomFieldApiV1PlusCustomMetadataCustomFieldFieldIdDeleteResponses]; + +export type getAllCustomFieldDefinitionsApiV1PlusCustomMetadataCustomFieldDefinitionGetData = + { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/custom-metadata/custom-field-definition"; + }; + +export type getAllCustomFieldDefinitionsApiV1PlusCustomMetadataCustomFieldDefinitionGetResponses = + { + /** + * Response Get All Custom Field Definitions Api V1 Plus Custom Metadata Custom Field Definition Get + * + * Successful Response + */ + 200: Array; + }; + +export type getAllCustomFieldDefinitionsApiV1PlusCustomMetadataCustomFieldDefinitionGetResponse = + getAllCustomFieldDefinitionsApiV1PlusCustomMetadataCustomFieldDefinitionGetResponses[keyof getAllCustomFieldDefinitionsApiV1PlusCustomMetadataCustomFieldDefinitionGetResponses]; + +export type addCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPostData = + { + body: CustomFieldDefinition; + path?: never; + query?: never; + url: "/api/v1/plus/custom-metadata/custom-field-definition"; + }; + +export type addCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type addCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPostError = + addCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPostErrors[keyof addCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPostErrors]; + +export type addCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPostResponses = + { + /** + * Successful Response + */ + 200: CustomFieldDefinitionResponse; + }; + +export type addCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPostResponse = + addCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPostResponses[keyof addCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPostResponses]; + +export type updateCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPutData = + { + body: CustomFieldDefinitionWithId; + path?: never; + query?: never; + url: "/api/v1/plus/custom-metadata/custom-field-definition"; + }; + +export type updateCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPutError = + updateCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPutErrors[keyof updateCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPutErrors]; + +export type updateCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPutResponses = + { + /** + * Successful Response + */ + 200: CustomFieldDefinitionResponse; + }; + +export type updateCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPutResponse = + updateCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPutResponses[keyof updateCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionPutResponses]; + +export type deleteCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdDeleteData = + { + body?: never; + path: { + /** + * Definition Id + */ + definition_id: string; + }; + query?: never; + url: "/api/v1/plus/custom-metadata/custom-field-definition/{definition_id}"; + }; + +export type deleteCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdDeleteError = + deleteCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdDeleteErrors[keyof deleteCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdDeleteErrors]; + +export type deleteCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deleteCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdDeleteResponse = + deleteCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdDeleteResponses[keyof deleteCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdDeleteResponses]; + +export type getCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdGetData = + { + body?: never; + path: { + /** + * Definition Id + */ + definition_id: string; + }; + query?: never; + url: "/api/v1/plus/custom-metadata/custom-field-definition/{definition_id}"; + }; + +export type getCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdGetError = + getCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdGetErrors[keyof getCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdGetErrors]; + +export type getCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdGetResponses = + { + /** + * Successful Response + */ + 200: CustomFieldDefinitionResponse; + }; + +export type getCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdGetResponse = + getCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdGetResponses[keyof getCustomFieldDefinitionApiV1PlusCustomMetadataCustomFieldDefinitionDefinitionIdGetResponses]; + +export type getCustomFieldDefinitionsByResourceTypeApiV1PlusCustomMetadataCustomFieldDefinitionResourceTypeResourceTypeGetData = + { + body?: never; + path: { + /** + * Resource Type + */ + resource_type: string; + }; + query?: { + /** + * Active Only + */ + active_only?: boolean; + }; + url: "/api/v1/plus/custom-metadata/custom-field-definition/resource-type/{resource_type}"; + }; + +export type getCustomFieldDefinitionsByResourceTypeApiV1PlusCustomMetadataCustomFieldDefinitionResourceTypeResourceTypeGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCustomFieldDefinitionsByResourceTypeApiV1PlusCustomMetadataCustomFieldDefinitionResourceTypeResourceTypeGetError = + getCustomFieldDefinitionsByResourceTypeApiV1PlusCustomMetadataCustomFieldDefinitionResourceTypeResourceTypeGetErrors[keyof getCustomFieldDefinitionsByResourceTypeApiV1PlusCustomMetadataCustomFieldDefinitionResourceTypeResourceTypeGetErrors]; + +export type getCustomFieldDefinitionsByResourceTypeApiV1PlusCustomMetadataCustomFieldDefinitionResourceTypeResourceTypeGetResponses = + { + /** + * Response Get Custom Field Definitions By Resource Type Api V1 Plus Custom Metadata Custom Field Definition Resource Type Resource Type Get + * + * Successful Response + */ + 200: Array; + }; + +export type getCustomFieldDefinitionsByResourceTypeApiV1PlusCustomMetadataCustomFieldDefinitionResourceTypeResourceTypeGetResponse = + getCustomFieldDefinitionsByResourceTypeApiV1PlusCustomMetadataCustomFieldDefinitionResourceTypeResourceTypeGetResponses[keyof getCustomFieldDefinitionsByResourceTypeApiV1PlusCustomMetadataCustomFieldDefinitionResourceTypeResourceTypeGetResponses]; + +export type getCustomFieldDefinitionsByNameApiV1PlusCustomMetadataCustomFieldDefinitionNameNameGetData = + { + body?: never; + path: { + /** + * Name + */ + name: string; + }; + query?: never; + url: "/api/v1/plus/custom-metadata/custom-field-definition/name/{name}"; + }; + +export type getCustomFieldDefinitionsByNameApiV1PlusCustomMetadataCustomFieldDefinitionNameNameGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCustomFieldDefinitionsByNameApiV1PlusCustomMetadataCustomFieldDefinitionNameNameGetError = + getCustomFieldDefinitionsByNameApiV1PlusCustomMetadataCustomFieldDefinitionNameNameGetErrors[keyof getCustomFieldDefinitionsByNameApiV1PlusCustomMetadataCustomFieldDefinitionNameNameGetErrors]; + +export type getCustomFieldDefinitionsByNameApiV1PlusCustomMetadataCustomFieldDefinitionNameNameGetResponses = + { + /** + * Response Get Custom Field Definitions By Name Api V1 Plus Custom Metadata Custom Field Definition Name Name Get + * + * Successful Response + */ + 200: Array; + }; + +export type getCustomFieldDefinitionsByNameApiV1PlusCustomMetadataCustomFieldDefinitionNameNameGetResponse = + getCustomFieldDefinitionsByNameApiV1PlusCustomMetadataCustomFieldDefinitionNameNameGetResponses[keyof getCustomFieldDefinitionsByNameApiV1PlusCustomMetadataCustomFieldDefinitionNameNameGetResponses]; + +export type getAllAllowListsApiV1PlusCustomMetadataAllowListGetData = { + body?: never; + path?: never; + query?: { + /** + * Show Values + */ + show_values?: boolean; + }; + url: "/api/v1/plus/custom-metadata/allow-list"; +}; + +export type getAllAllowListsApiV1PlusCustomMetadataAllowListGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getAllAllowListsApiV1PlusCustomMetadataAllowListGetError = + getAllAllowListsApiV1PlusCustomMetadataAllowListGetErrors[keyof getAllAllowListsApiV1PlusCustomMetadataAllowListGetErrors]; + +export type getAllAllowListsApiV1PlusCustomMetadataAllowListGetResponses = { + /** + * Response Get All Allow Lists Api V1 Plus Custom Metadata Allow List Get + * + * Successful Response + */ + 200: Array; +}; + +export type getAllAllowListsApiV1PlusCustomMetadataAllowListGetResponse = + getAllAllowListsApiV1PlusCustomMetadataAllowListGetResponses[keyof getAllAllowListsApiV1PlusCustomMetadataAllowListGetResponses]; + +export type createOrUpdateAllowListApiV1PlusCustomMetadataAllowListPutData = { + body: AllowListUpdate; + path?: never; + query?: never; + url: "/api/v1/plus/custom-metadata/allow-list"; +}; + +export type createOrUpdateAllowListApiV1PlusCustomMetadataAllowListPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createOrUpdateAllowListApiV1PlusCustomMetadataAllowListPutError = + createOrUpdateAllowListApiV1PlusCustomMetadataAllowListPutErrors[keyof createOrUpdateAllowListApiV1PlusCustomMetadataAllowListPutErrors]; + +export type createOrUpdateAllowListApiV1PlusCustomMetadataAllowListPutResponses = + { + /** + * Successful Response + */ + 200: AllowList; + }; + +export type createOrUpdateAllowListApiV1PlusCustomMetadataAllowListPutResponse = + createOrUpdateAllowListApiV1PlusCustomMetadataAllowListPutResponses[keyof createOrUpdateAllowListApiV1PlusCustomMetadataAllowListPutResponses]; + +export type deleteAllowListApiV1PlusCustomMetadataAllowListListIdDeleteData = { + body?: never; + path: { + /** + * List Id + */ + list_id: string; + }; + query?: never; + url: "/api/v1/plus/custom-metadata/allow-list/{list_id}"; +}; + +export type deleteAllowListApiV1PlusCustomMetadataAllowListListIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteAllowListApiV1PlusCustomMetadataAllowListListIdDeleteError = + deleteAllowListApiV1PlusCustomMetadataAllowListListIdDeleteErrors[keyof deleteAllowListApiV1PlusCustomMetadataAllowListListIdDeleteErrors]; + +export type deleteAllowListApiV1PlusCustomMetadataAllowListListIdDeleteResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getAllowListApiV1PlusCustomMetadataAllowListListIdGetData = { + body?: never; + path: { + /** + * List Id + */ + list_id: string; + }; + query?: { + /** + * Show Values + */ + show_values?: boolean; + }; + url: "/api/v1/plus/custom-metadata/allow-list/{list_id}"; +}; + +export type getAllowListApiV1PlusCustomMetadataAllowListListIdGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getAllowListApiV1PlusCustomMetadataAllowListListIdGetError = + getAllowListApiV1PlusCustomMetadataAllowListListIdGetErrors[keyof getAllowListApiV1PlusCustomMetadataAllowListListIdGetErrors]; + +export type getAllowListApiV1PlusCustomMetadataAllowListListIdGetResponses = { + /** + * Successful Response + */ + 200: AllowList; +}; + +export type getAllowListApiV1PlusCustomMetadataAllowListListIdGetResponse = + getAllowListApiV1PlusCustomMetadataAllowListListIdGetResponses[keyof getAllowListApiV1PlusCustomMetadataAllowListListIdGetResponses]; + +export type patchAllowListApiV1PlusCustomMetadataAllowListListIdPatchData = { + body: AllowList; + path: { + /** + * List Id + */ + list_id: string; + }; + query?: never; + url: "/api/v1/plus/custom-metadata/allow-list/{list_id}"; +}; + +export type patchAllowListApiV1PlusCustomMetadataAllowListListIdPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type patchAllowListApiV1PlusCustomMetadataAllowListListIdPatchError = + patchAllowListApiV1PlusCustomMetadataAllowListListIdPatchErrors[keyof patchAllowListApiV1PlusCustomMetadataAllowListListIdPatchErrors]; + +export type patchAllowListApiV1PlusCustomMetadataAllowListListIdPatchResponses = + { + /** + * Successful Response + */ + 200: AllowList; + }; + +export type patchAllowListApiV1PlusCustomMetadataAllowListListIdPatchResponse = + patchAllowListApiV1PlusCustomMetadataAllowListListIdPatchResponses[keyof patchAllowListApiV1PlusCustomMetadataAllowListListIdPatchResponses]; + +export type clearAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesDeleteData = + { + body?: never; + path: { + /** + * List Id + */ + list_id: string; + }; + query?: never; + url: "/api/v1/plus/custom-metadata/allow-list/{list_id}/values"; + }; + +export type clearAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type clearAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesDeleteError = + clearAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesDeleteErrors[keyof clearAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesDeleteErrors]; + +export type clearAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesDeleteResponses = + { + /** + * Successful Response + */ + 200: AllowList; + }; + +export type clearAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesDeleteResponse = + clearAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesDeleteResponses[keyof clearAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesDeleteResponses]; + +export type getAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesGetData = + { + body?: never; + path: { + /** + * List Id + */ + list_id: string; + }; + query?: never; + url: "/api/v1/plus/custom-metadata/allow-list/{list_id}/values"; + }; + +export type getAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesGetError = + getAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesGetErrors[keyof getAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesGetErrors]; + +export type getAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesGetResponses = + { + /** + * Response Get Allow List Values Api V1 Plus Custom Metadata Allow List List Id Values Get + * + * Successful Response + */ + 200: Array; + }; + +export type getAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesGetResponse = + getAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesGetResponses[keyof getAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesGetResponses]; + +export type updateAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesPostData = + { + body: ValuesList; + path: { + /** + * List Id + */ + list_id: string; + }; + query?: { + /** + * Add Values + */ + add_values?: boolean; + /** + * Show Values + */ + show_values?: boolean; + }; + url: "/api/v1/plus/custom-metadata/allow-list/{list_id}/values"; + }; + +export type updateAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesPostError = + updateAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesPostErrors[keyof updateAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesPostErrors]; + +export type updateAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesPostResponses = + { + /** + * Response Update Allow List Values Api V1 Plus Custom Metadata Allow List List Id Values Post + * + * Successful Response + */ + 200: Array; + }; + +export type updateAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesPostResponse = + updateAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesPostResponses[keyof updateAllowListValuesApiV1PlusCustomMetadataAllowListListIdValuesPostResponses]; + +export type getCustomReportsApiV1PlusCustomReportGetData = { + body?: never; + path?: never; + query?: { + /** + * Search + */ + search?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/custom-report"; +}; + +export type getCustomReportsApiV1PlusCustomReportGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getCustomReportsApiV1PlusCustomReportGetError = + getCustomReportsApiV1PlusCustomReportGetErrors[keyof getCustomReportsApiV1PlusCustomReportGetErrors]; + +export type getCustomReportsApiV1PlusCustomReportGetResponses = { + /** + * Successful Response + */ + 200: Page_CustomReportResponse_; +}; + +export type getCustomReportsApiV1PlusCustomReportGetResponse = + getCustomReportsApiV1PlusCustomReportGetResponses[keyof getCustomReportsApiV1PlusCustomReportGetResponses]; + +export type createCustomReportApiV1PlusCustomReportPostData = { + body: CustomReportCreate; + path?: never; + query?: never; + url: "/api/v1/plus/custom-report"; +}; + +export type createCustomReportApiV1PlusCustomReportPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createCustomReportApiV1PlusCustomReportPostError = + createCustomReportApiV1PlusCustomReportPostErrors[keyof createCustomReportApiV1PlusCustomReportPostErrors]; + +export type createCustomReportApiV1PlusCustomReportPostResponses = { + /** + * Successful Response + */ + 200: CustomReportResponse; +}; + +export type createCustomReportApiV1PlusCustomReportPostResponse = + createCustomReportApiV1PlusCustomReportPostResponses[keyof createCustomReportApiV1PlusCustomReportPostResponses]; + +export type getMinimalCustomReportsApiV1PlusCustomReportMinimalGetData = { + body?: never; + path?: never; + query?: { + /** + * Search + */ + search?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/custom-report/minimal"; +}; + +export type getMinimalCustomReportsApiV1PlusCustomReportMinimalGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getMinimalCustomReportsApiV1PlusCustomReportMinimalGetError = + getMinimalCustomReportsApiV1PlusCustomReportMinimalGetErrors[keyof getMinimalCustomReportsApiV1PlusCustomReportMinimalGetErrors]; + +export type getMinimalCustomReportsApiV1PlusCustomReportMinimalGetResponses = { + /** + * Successful Response + */ + 200: Page_CustomReportResponseMinimal_; +}; + +export type getMinimalCustomReportsApiV1PlusCustomReportMinimalGetResponse = + getMinimalCustomReportsApiV1PlusCustomReportMinimalGetResponses[keyof getMinimalCustomReportsApiV1PlusCustomReportMinimalGetResponses]; + +export type deleteCustomReportApiV1PlusCustomReportReportIdDeleteData = { + body?: never; + path: { + /** + * Report Id + */ + report_id: string; + }; + query?: never; + url: "/api/v1/plus/custom-report/{report_id}"; +}; + +export type deleteCustomReportApiV1PlusCustomReportReportIdDeleteErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteCustomReportApiV1PlusCustomReportReportIdDeleteError = + deleteCustomReportApiV1PlusCustomReportReportIdDeleteErrors[keyof deleteCustomReportApiV1PlusCustomReportReportIdDeleteErrors]; + +export type deleteCustomReportApiV1PlusCustomReportReportIdDeleteResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type getReportByIdApiV1PlusCustomReportReportIdGetData = { + body?: never; + path: { + /** + * Report Id + */ + report_id: string; + }; + query?: never; + url: "/api/v1/plus/custom-report/{report_id}"; +}; + +export type getReportByIdApiV1PlusCustomReportReportIdGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getReportByIdApiV1PlusCustomReportReportIdGetError = + getReportByIdApiV1PlusCustomReportReportIdGetErrors[keyof getReportByIdApiV1PlusCustomReportReportIdGetErrors]; + +export type getReportByIdApiV1PlusCustomReportReportIdGetResponses = { + /** + * Successful Response + */ + 200: CustomReportResponse; +}; + +export type getReportByIdApiV1PlusCustomReportReportIdGetResponse = + getReportByIdApiV1PlusCustomReportReportIdGetResponses[keyof getReportByIdApiV1PlusCustomReportReportIdGetResponses]; + +export type getProjectsApiV1PlusDataCatalogProjectGetData = { + body?: never; + path?: never; + query?: { + /** + * Monitor Config Ids + */ + monitor_config_ids?: Array; + /** + * Show Hidden + */ + show_hidden?: boolean; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/data-catalog/project"; +}; + +export type getProjectsApiV1PlusDataCatalogProjectGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getProjectsApiV1PlusDataCatalogProjectGetError = + getProjectsApiV1PlusDataCatalogProjectGetErrors[keyof getProjectsApiV1PlusDataCatalogProjectGetErrors]; + +export type getProjectsApiV1PlusDataCatalogProjectGetResponses = { + /** + * Successful Response + */ + 200: Page_StagedResourceAPIResponse_; +}; + +export type getProjectsApiV1PlusDataCatalogProjectGetResponse = + getProjectsApiV1PlusDataCatalogProjectGetResponses[keyof getProjectsApiV1PlusDataCatalogProjectGetResponses]; + +export type getDatasetsApiV1PlusDataCatalogDatasetGetData = { + body?: never; + path?: never; + query?: { + /** + * Monitor Config Ids + */ + monitor_config_ids?: Array; + /** + * Show Hidden + */ + show_hidden?: boolean; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/data-catalog/dataset"; +}; + +export type getDatasetsApiV1PlusDataCatalogDatasetGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getDatasetsApiV1PlusDataCatalogDatasetGetError = + getDatasetsApiV1PlusDataCatalogDatasetGetErrors[keyof getDatasetsApiV1PlusDataCatalogDatasetGetErrors]; + +export type getDatasetsApiV1PlusDataCatalogDatasetGetResponses = { + /** + * Successful Response + */ + 200: Page_StagedResourceAPIResponse_; +}; + +export type getDatasetsApiV1PlusDataCatalogDatasetGetResponse = + getDatasetsApiV1PlusDataCatalogDatasetGetResponses[keyof getDatasetsApiV1PlusDataCatalogDatasetGetResponses]; + +export type getSystemsApiV1PlusDataCatalogSystemGetData = { + body?: never; + path?: never; + query?: { + /** + * Show Hidden + */ + show_hidden?: boolean; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/data-catalog/system"; +}; + +export type getSystemsApiV1PlusDataCatalogSystemGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getSystemsApiV1PlusDataCatalogSystemGetError = + getSystemsApiV1PlusDataCatalogSystemGetErrors[keyof getSystemsApiV1PlusDataCatalogSystemGetErrors]; + +export type getSystemsApiV1PlusDataCatalogSystemGetResponses = { + /** + * Successful Response + */ + 200: Page_SystemWithMonitorKeys_; +}; + +export type getSystemsApiV1PlusDataCatalogSystemGetResponse = + getSystemsApiV1PlusDataCatalogSystemGetResponses[keyof getSystemsApiV1PlusDataCatalogSystemGetResponses]; + +export type exportMinimalDatamapApiV1PlusDatamapMinimalGetData = { + body?: never; + path?: never; + query: { + group_by: DATAMAP_GROUPING; + /** + * Search + */ + search?: string | null; + /** + * Data Uses + */ + data_uses?: Array | null; + /** + * Data Categories + */ + data_categories?: Array | null; + /** + * Data Subjects + */ + data_subjects?: Array | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/datamap/minimal"; +}; + +export type exportMinimalDatamapApiV1PlusDatamapMinimalGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type exportMinimalDatamapApiV1PlusDatamapMinimalGetError = + exportMinimalDatamapApiV1PlusDatamapMinimalGetErrors[keyof exportMinimalDatamapApiV1PlusDatamapMinimalGetErrors]; + +export type exportMinimalDatamapApiV1PlusDatamapMinimalGetResponses = { + /** + * Successful Response + */ + 200: Page_DatamapReport_; +}; + +export type exportMinimalDatamapApiV1PlusDatamapMinimalGetResponse = + exportMinimalDatamapApiV1PlusDatamapMinimalGetResponses[keyof exportMinimalDatamapApiV1PlusDatamapMinimalGetResponses]; + +export type exportMinimalDatamapCsvApiV1PlusDatamapMinimalCsvGetData = { + body?: never; + path?: never; + query: { + group_by: DATAMAP_GROUPING; + /** + * Search + */ + search?: string | null; + /** + * Data Uses + */ + data_uses?: Array | null; + /** + * Data Categories + */ + data_categories?: Array | null; + /** + * Data Subjects + */ + data_subjects?: Array | null; + /** + * Report Id + * + * Optional report ID that contains custom column mappings + */ + report_id?: string | null; + }; + url: "/api/v1/plus/datamap/minimal/csv"; +}; + +export type exportMinimalDatamapCsvApiV1PlusDatamapMinimalCsvGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type exportMinimalDatamapCsvApiV1PlusDatamapMinimalCsvGetError = + exportMinimalDatamapCsvApiV1PlusDatamapMinimalCsvGetErrors[keyof exportMinimalDatamapCsvApiV1PlusDatamapMinimalCsvGetErrors]; + +export type exportMinimalDatamapCsvApiV1PlusDatamapMinimalCsvGetResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type exportMinimalDatamapXlsxApiV1PlusDatamapMinimalXlsxGetData = { + body?: never; + path?: never; + query: { + group_by: DATAMAP_GROUPING; + /** + * Search + */ + search?: string | null; + /** + * Data Uses + */ + data_uses?: Array | null; + /** + * Data Categories + */ + data_categories?: Array | null; + /** + * Data Subjects + */ + data_subjects?: Array | null; + /** + * Report Id + * + * Optional report ID that contains custom column mappings + */ + report_id?: string | null; + }; + url: "/api/v1/plus/datamap/minimal/xlsx"; +}; + +export type exportMinimalDatamapXlsxApiV1PlusDatamapMinimalXlsxGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type exportMinimalDatamapXlsxApiV1PlusDatamapMinimalXlsxGetError = + exportMinimalDatamapXlsxApiV1PlusDatamapMinimalXlsxGetErrors[keyof exportMinimalDatamapXlsxApiV1PlusDatamapMinimalXlsxGetErrors]; + +export type exportMinimalDatamapXlsxApiV1PlusDatamapMinimalXlsxGetResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type exportMinimalDatamapWithFormatApiV1PlusDatamapMinimalExportFormatPostData = + { + body?: Body_export_minimal_datamap_with_format_api_v1_plus_datamap_minimal__export_format__post; + path: { + export_format: ReportExportFormat; + }; + query: { + group_by: DATAMAP_GROUPING; + /** + * Search + */ + search?: string | null; + /** + * Data Uses + */ + data_uses?: Array | null; + /** + * Data Categories + */ + data_categories?: Array | null; + /** + * Data Subjects + */ + data_subjects?: Array | null; + /** + * Report Id + * + * Optional report ID that contains custom column mappings + */ + report_id?: string | null; + }; + url: "/api/v1/plus/datamap/minimal/{export_format}"; + }; + +export type exportMinimalDatamapWithFormatApiV1PlusDatamapMinimalExportFormatPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type exportMinimalDatamapWithFormatApiV1PlusDatamapMinimalExportFormatPostError = + exportMinimalDatamapWithFormatApiV1PlusDatamapMinimalExportFormatPostErrors[keyof exportMinimalDatamapWithFormatApiV1PlusDatamapMinimalExportFormatPostErrors]; + +export type exportMinimalDatamapWithFormatApiV1PlusDatamapMinimalExportFormatPostResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type exportDatamapApiV1PlusDatamapOrganizationFidesKeyGetData = { + body?: never; + path: { + /** + * Organization Fides Key + */ + organization_fides_key: string; + }; + query?: { + /** + * Include Deprecated Columns + */ + include_deprecated_columns?: boolean; + /** + * Include Gvl Systems + */ + include_gvl_systems?: boolean; + }; + url: "/api/v1/plus/datamap/{organization_fides_key}"; +}; + +export type exportDatamapApiV1PlusDatamapOrganizationFidesKeyGetErrors = { + /** + * Bad Request + */ + 400: unknown; + /** + * Not Found + */ + 404: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type exportDatamapApiV1PlusDatamapOrganizationFidesKeyGetError = + exportDatamapApiV1PlusDatamapOrganizationFidesKeyGetErrors[keyof exportDatamapApiV1PlusDatamapOrganizationFidesKeyGetErrors]; + +export type exportDatamapApiV1PlusDatamapOrganizationFidesKeyGetResponses = { + /** + * Response Export Datamap Api V1 Plus Datamap Organization Fides Key Get + * + * Successful Response + */ + 200: Array<{ + [key: string]: unknown; + }>; +}; + +export type exportDatamapApiV1PlusDatamapOrganizationFidesKeyGetResponse = + exportDatamapApiV1PlusDatamapOrganizationFidesKeyGetResponses[keyof exportDatamapApiV1PlusDatamapOrganizationFidesKeyGetResponses]; + +export type listDigestConfigsApiV1PlusDigestConfigGetData = { + body?: never; + path?: never; + query: { + digest_config_type: DigestType; + /** + * Enabled + */ + enabled?: boolean | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/digest-config"; +}; + +export type listDigestConfigsApiV1PlusDigestConfigGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type listDigestConfigsApiV1PlusDigestConfigGetError = + listDigestConfigsApiV1PlusDigestConfigGetErrors[keyof listDigestConfigsApiV1PlusDigestConfigGetErrors]; + +export type listDigestConfigsApiV1PlusDigestConfigGetResponses = { + /** + * Successful Response + */ + 200: Page_DigestConfigResponse_; +}; + +export type listDigestConfigsApiV1PlusDigestConfigGetResponse = + listDigestConfigsApiV1PlusDigestConfigGetResponses[keyof listDigestConfigsApiV1PlusDigestConfigGetResponses]; + +export type createDigestConfigApiV1PlusDigestConfigPostData = { + body: DigestConfigRequest; + path?: never; + query?: never; + url: "/api/v1/plus/digest-config"; +}; + +export type createDigestConfigApiV1PlusDigestConfigPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createDigestConfigApiV1PlusDigestConfigPostError = + createDigestConfigApiV1PlusDigestConfigPostErrors[keyof createDigestConfigApiV1PlusDigestConfigPostErrors]; + +export type createDigestConfigApiV1PlusDigestConfigPostResponses = { + /** + * Successful Response + */ + 201: DigestConfigResponse; +}; + +export type createDigestConfigApiV1PlusDigestConfigPostResponse = + createDigestConfigApiV1PlusDigestConfigPostResponses[keyof createDigestConfigApiV1PlusDigestConfigPostResponses]; + +export type deleteDigestConfigApiV1PlusDigestConfigConfigIdDeleteData = { + body?: never; + path: { + /** + * Config Id + */ + config_id: string; + }; + query: { + digest_config_type: DigestType; + }; + url: "/api/v1/plus/digest-config/{config_id}"; +}; + +export type deleteDigestConfigApiV1PlusDigestConfigConfigIdDeleteErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteDigestConfigApiV1PlusDigestConfigConfigIdDeleteError = + deleteDigestConfigApiV1PlusDigestConfigConfigIdDeleteErrors[keyof deleteDigestConfigApiV1PlusDigestConfigConfigIdDeleteErrors]; + +export type deleteDigestConfigApiV1PlusDigestConfigConfigIdDeleteResponses = { + /** + * Successful Response + */ + 204: void; +}; + +export type deleteDigestConfigApiV1PlusDigestConfigConfigIdDeleteResponse = + deleteDigestConfigApiV1PlusDigestConfigConfigIdDeleteResponses[keyof deleteDigestConfigApiV1PlusDigestConfigConfigIdDeleteResponses]; + +export type getDigestConfigByIdApiV1PlusDigestConfigConfigIdGetData = { + body?: never; + path: { + /** + * Config Id + */ + config_id: string; + }; + query?: never; + url: "/api/v1/plus/digest-config/{config_id}"; +}; + +export type getDigestConfigByIdApiV1PlusDigestConfigConfigIdGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getDigestConfigByIdApiV1PlusDigestConfigConfigIdGetError = + getDigestConfigByIdApiV1PlusDigestConfigConfigIdGetErrors[keyof getDigestConfigByIdApiV1PlusDigestConfigConfigIdGetErrors]; + +export type getDigestConfigByIdApiV1PlusDigestConfigConfigIdGetResponses = { + /** + * Successful Response + */ + 200: DigestConfigResponse; +}; + +export type getDigestConfigByIdApiV1PlusDigestConfigConfigIdGetResponse = + getDigestConfigByIdApiV1PlusDigestConfigConfigIdGetResponses[keyof getDigestConfigByIdApiV1PlusDigestConfigConfigIdGetResponses]; + +export type updateDigestConfigApiV1PlusDigestConfigConfigIdPutData = { + body: DigestConfigRequest; + path: { + /** + * Config Id + */ + config_id: string; + }; + query: { + digest_config_type: DigestType; + }; + url: "/api/v1/plus/digest-config/{config_id}"; +}; + +export type updateDigestConfigApiV1PlusDigestConfigConfigIdPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateDigestConfigApiV1PlusDigestConfigConfigIdPutError = + updateDigestConfigApiV1PlusDigestConfigConfigIdPutErrors[keyof updateDigestConfigApiV1PlusDigestConfigConfigIdPutErrors]; + +export type updateDigestConfigApiV1PlusDigestConfigConfigIdPutResponses = { + /** + * Response Update Digest Config Api V1 Plus Digest Config Config Id Put + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type updateDigestConfigApiV1PlusDigestConfigConfigIdPutResponse = + updateDigestConfigApiV1PlusDigestConfigConfigIdPutResponses[keyof updateDigestConfigApiV1PlusDigestConfigConfigIdPutResponses]; + +export type testDigestConfigApiV1PlusDigestConfigTestPostData = { + body?: never; + path?: never; + query: { + /** + * Digest Config Id + */ + digest_config_id: string; + digest_config_type: DigestType; + /** + * Test Email + */ + test_email: string; + }; + url: "/api/v1/plus/digest-config/test"; +}; + +export type testDigestConfigApiV1PlusDigestConfigTestPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type testDigestConfigApiV1PlusDigestConfigTestPostError = + testDigestConfigApiV1PlusDigestConfigTestPostErrors[keyof testDigestConfigApiV1PlusDigestConfigTestPostErrors]; + +export type testDigestConfigApiV1PlusDigestConfigTestPostResponses = { + /** + * Response Test Digest Config Api V1 Plus Digest Config Test Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type testDigestConfigApiV1PlusDigestConfigTestPostResponse = + testDigestConfigApiV1PlusDigestConfigTestPostResponses[keyof testDigestConfigApiV1PlusDigestConfigTestPostResponses]; + +export type listMonitorTasksApiV1PlusDiscoveryMonitorTasksGetData = { + body?: never; + path?: never; + query?: { + /** + * Monitor Config Id + * + * Filter tasks by monitor config ID + */ + monitor_config_id?: string | null; + /** + * Monitor Config Key + * + * Filter tasks by monitor config key + */ + monitor_config_key?: string | null; + /** + * Action Type + * + * Filter tasks by action type (detection, classification, promotion) + */ + action_type?: Array | null; + /** + * Celery Id + * + * Filter tasks by Celery task ID + */ + celery_id?: string | null; + /** + * Status + * + * Filter tasks by execution status (pending, in_processing, complete, error) + */ + status?: Array | null; + /** + * Search + * + * Search by monitor name + */ + search?: string | null; + /** + * Return Dismissed + * + * Whether to return dismissed tasks (defaults to false) + */ + return_dismissed?: boolean | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/discovery-monitor/tasks"; +}; + +export type listMonitorTasksApiV1PlusDiscoveryMonitorTasksGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type listMonitorTasksApiV1PlusDiscoveryMonitorTasksGetError = + listMonitorTasksApiV1PlusDiscoveryMonitorTasksGetErrors[keyof listMonitorTasksApiV1PlusDiscoveryMonitorTasksGetErrors]; + +export type listMonitorTasksApiV1PlusDiscoveryMonitorTasksGetResponses = { + /** + * Successful Response + */ + 200: Page_MonitorTaskResponse_; +}; + +export type listMonitorTasksApiV1PlusDiscoveryMonitorTasksGetResponse = + listMonitorTasksApiV1PlusDiscoveryMonitorTasksGetResponses[keyof listMonitorTasksApiV1PlusDiscoveryMonitorTasksGetResponses]; + +export type getMonitorTaskDetailApiV1PlusDiscoveryMonitorTasksTaskIdGetData = { + body?: never; + path: { + /** + * Task Id + */ + task_id: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/tasks/{task_id}"; +}; + +export type getMonitorTaskDetailApiV1PlusDiscoveryMonitorTasksTaskIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getMonitorTaskDetailApiV1PlusDiscoveryMonitorTasksTaskIdGetError = + getMonitorTaskDetailApiV1PlusDiscoveryMonitorTasksTaskIdGetErrors[keyof getMonitorTaskDetailApiV1PlusDiscoveryMonitorTasksTaskIdGetErrors]; + +export type getMonitorTaskDetailApiV1PlusDiscoveryMonitorTasksTaskIdGetResponses = + { + /** + * Successful Response + */ + 200: MonitorTaskDetailResponse; + }; + +export type getMonitorTaskDetailApiV1PlusDiscoveryMonitorTasksTaskIdGetResponse = + getMonitorTaskDetailApiV1PlusDiscoveryMonitorTasksTaskIdGetResponses[keyof getMonitorTaskDetailApiV1PlusDiscoveryMonitorTasksTaskIdGetResponses]; + +export type stopMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdStopPostData = { + body?: never; + path: { + /** + * Task Id + */ + task_id: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/tasks/{task_id}/stop"; +}; + +export type stopMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdStopPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type stopMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdStopPostError = + stopMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdStopPostErrors[keyof stopMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdStopPostErrors]; + +export type stopMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdStopPostResponses = + { + /** + * Successful Response + */ + 200: MonitorTaskDetailResponse; + }; + +export type stopMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdStopPostResponse = + stopMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdStopPostResponses[keyof stopMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdStopPostResponses]; + +export type forceRetryMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdRetryPostData = + { + body?: never; + path: { + /** + * Task Id + */ + task_id: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/tasks/{task_id}/retry"; + }; + +export type forceRetryMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdRetryPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type forceRetryMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdRetryPostError = + forceRetryMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdRetryPostErrors[keyof forceRetryMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdRetryPostErrors]; + +export type forceRetryMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdRetryPostResponses = + { + /** + * Successful Response + */ + 200: MonitorTaskDetailResponse; + }; + +export type forceRetryMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdRetryPostResponse = + forceRetryMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdRetryPostResponses[keyof forceRetryMonitorTaskApiV1PlusDiscoveryMonitorTasksTaskIdRetryPostResponses]; + +export type unsetMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedDeleteData = + { + body?: never; + path: { + /** + * Task Id + */ + task_id: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/tasks/{task_id}/dismissed"; + }; + +export type unsetMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type unsetMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedDeleteError = + unsetMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedDeleteErrors[keyof unsetMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedDeleteErrors]; + +export type unsetMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedDeleteResponses = + { + /** + * Successful Response + */ + 200: MonitorTaskResponse; + }; + +export type unsetMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedDeleteResponse = + unsetMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedDeleteResponses[keyof unsetMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedDeleteResponses]; + +export type setMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedPostData = + { + body?: never; + path: { + /** + * Task Id + */ + task_id: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/tasks/{task_id}/dismissed"; + }; + +export type setMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type setMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedPostError = + setMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedPostErrors[keyof setMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedPostErrors]; + +export type setMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedPostResponses = + { + /** + * Successful Response + */ + 200: MonitorTaskResponse; + }; + +export type setMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedPostResponse = + setMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedPostResponses[keyof setMonitorTaskDismissedApiV1PlusDiscoveryMonitorTasksTaskIdDismissedPostResponses]; + +export type getMonitorExecutionApiV1PlusDiscoveryMonitorExecutionMonitorExecutionIdGetData = + { + body?: never; + path: { + /** + * Monitor Execution Id + */ + monitor_execution_id: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/execution/{monitor_execution_id}"; + }; + +export type getMonitorExecutionApiV1PlusDiscoveryMonitorExecutionMonitorExecutionIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getMonitorExecutionApiV1PlusDiscoveryMonitorExecutionMonitorExecutionIdGetError = + getMonitorExecutionApiV1PlusDiscoveryMonitorExecutionMonitorExecutionIdGetErrors[keyof getMonitorExecutionApiV1PlusDiscoveryMonitorExecutionMonitorExecutionIdGetErrors]; + +export type getMonitorExecutionApiV1PlusDiscoveryMonitorExecutionMonitorExecutionIdGetResponses = + { + /** + * Successful Response + */ + 200: MonitorExecution; + }; + +export type getMonitorExecutionApiV1PlusDiscoveryMonitorExecutionMonitorExecutionIdGetResponse = + getMonitorExecutionApiV1PlusDiscoveryMonitorExecutionMonitorExecutionIdGetResponses[keyof getMonitorExecutionApiV1PlusDiscoveryMonitorExecutionMonitorExecutionIdGetResponses]; + +export type listMonitorExecutionApiV1PlusDiscoveryMonitorExecutionGetData = { + body?: never; + path?: never; + query?: { + /** + * Monitor Config Key + */ + monitor_config_key?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/discovery-monitor/execution"; +}; + +export type listMonitorExecutionApiV1PlusDiscoveryMonitorExecutionGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type listMonitorExecutionApiV1PlusDiscoveryMonitorExecutionGetError = + listMonitorExecutionApiV1PlusDiscoveryMonitorExecutionGetErrors[keyof listMonitorExecutionApiV1PlusDiscoveryMonitorExecutionGetErrors]; + +export type listMonitorExecutionApiV1PlusDiscoveryMonitorExecutionGetResponses = + { + /** + * Successful Response + */ + 200: Page_MonitorExecution_; + }; + +export type listMonitorExecutionApiV1PlusDiscoveryMonitorExecutionGetResponse = + listMonitorExecutionApiV1PlusDiscoveryMonitorExecutionGetResponses[keyof listMonitorExecutionApiV1PlusDiscoveryMonitorExecutionGetResponses]; + +export type listMonitorClassifyInstancesApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationInstancesGetData = + { + body?: never; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/classification-instances"; + }; + +export type listMonitorClassifyInstancesApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationInstancesGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type listMonitorClassifyInstancesApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationInstancesGetError = + listMonitorClassifyInstancesApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationInstancesGetErrors[keyof listMonitorClassifyInstancesApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationInstancesGetErrors]; + +export type listMonitorClassifyInstancesApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationInstancesGetResponses = + { + /** + * Successful Response + */ + 200: Page_ClassifyInstanceResponseValues_; + }; + +export type listMonitorClassifyInstancesApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationInstancesGetResponse = + listMonitorClassifyInstancesApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationInstancesGetResponses[keyof listMonitorClassifyInstancesApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationInstancesGetResponses]; + +export type discoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorMonitorConfigKeyDatabasesGetData = + { + body?: never; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: { + /** + * Search + */ + search?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/databases"; + }; + +export type discoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorMonitorConfigKeyDatabasesGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type discoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorMonitorConfigKeyDatabasesGetError = + discoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorMonitorConfigKeyDatabasesGetErrors[keyof discoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorMonitorConfigKeyDatabasesGetErrors]; + +export type discoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorMonitorConfigKeyDatabasesGetResponses = + { + /** + * Successful Response + */ + 200: Page_str_; + }; + +export type discoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorMonitorConfigKeyDatabasesGetResponse = + discoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorMonitorConfigKeyDatabasesGetResponses[keyof discoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorMonitorConfigKeyDatabasesGetResponses]; + +export type proposedDiscoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorDatabasesPostData = + { + body: MonitorConfig; + path?: never; + query?: { + /** + * Search + */ + search?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/discovery-monitor/databases"; + }; + +export type proposedDiscoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorDatabasesPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type proposedDiscoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorDatabasesPostError = + proposedDiscoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorDatabasesPostErrors[keyof proposedDiscoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorDatabasesPostErrors]; + +export type proposedDiscoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorDatabasesPostResponses = + { + /** + * Successful Response + */ + 200: Page_str_; + }; + +export type proposedDiscoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorDatabasesPostResponse = + proposedDiscoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorDatabasesPostResponses[keyof proposedDiscoveryMonitorListAllDatabasesApiV1PlusDiscoveryMonitorDatabasesPostResponses]; + +export type executeMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyExecutePostData = + { + body?: never; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/execute"; + }; + +export type executeMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyExecutePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type executeMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyExecutePostError = + executeMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyExecutePostErrors[keyof executeMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyExecutePostErrors]; + +export type executeMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyExecutePostResponses = + { + /** + * Successful Response + */ + 200: MonitorExecutionRequestResponse; + }; + +export type executeMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyExecutePostResponse = + executeMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyExecutePostResponses[keyof executeMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyExecutePostResponses]; + +export type getSpecificMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigIdResultsGetData = + { + body?: never; + path: { + /** + * Monitor Config Id + */ + monitor_config_id: string; + }; + query?: { + /** + * Sort By + * + * Sort the results by the specified fields. If no sort is specified, the results are sorted by the resource's `name` attribute. + */ + sort_by?: Array; + /** + * Sort Asc + * + * Sort the results in ascending order. If False, descending + */ + sort_asc?: boolean | null; + /** + * Resource Type + */ + resource_type?: Array | null; + /** + * Locations + */ + locations?: Array | null; + /** + * Consent Aggregated + */ + consent_aggregated?: Array | null; + /** + * Data Uses + */ + data_uses?: Array | null; + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Child Diff Status + */ + child_diff_status?: Array | null; + /** + * Search + */ + search?: string | null; + /** + * Resolved System Id + */ + resolved_system_id?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_id}/results"; + }; + +export type getSpecificMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigIdResultsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getSpecificMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigIdResultsGetError = + getSpecificMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigIdResultsGetErrors[keyof getSpecificMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigIdResultsGetErrors]; + +export type getSpecificMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigIdResultsGetResponses = + { + /** + * Successful Response + */ + 200: Page_StagedResourceAPIResponse_; + }; + +export type getSpecificMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigIdResultsGetResponse = + getSpecificMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigIdResultsGetResponses[keyof getSpecificMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigIdResultsGetResponses]; + +export type deleteStagedResourcesApiV1PlusDiscoveryMonitorResultsDeleteData = { + body?: never; + path?: never; + query?: { + /** + * Staged Resource Urns + */ + staged_resource_urns?: Array; + /** + * Diff Status + */ + diff_status?: Array | null; + }; + url: "/api/v1/plus/discovery-monitor/results"; +}; + +export type deleteStagedResourcesApiV1PlusDiscoveryMonitorResultsDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteStagedResourcesApiV1PlusDiscoveryMonitorResultsDeleteError = + deleteStagedResourcesApiV1PlusDiscoveryMonitorResultsDeleteErrors[keyof deleteStagedResourcesApiV1PlusDiscoveryMonitorResultsDeleteErrors]; + +export type deleteStagedResourcesApiV1PlusDiscoveryMonitorResultsDeleteResponses = + { + /** + * Successful Response + */ + 200: DeletedResourcesResponse; + }; + +export type deleteStagedResourcesApiV1PlusDiscoveryMonitorResultsDeleteResponse = + deleteStagedResourcesApiV1PlusDiscoveryMonitorResultsDeleteResponses[keyof deleteStagedResourcesApiV1PlusDiscoveryMonitorResultsDeleteResponses]; + +export type getMonitorResultsApiV1PlusDiscoveryMonitorResultsGetData = { + body?: never; + path?: never; + query?: { + /** + * Staged Resource Urn + */ + staged_resource_urn?: string | null; + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Child Diff Status + */ + child_diff_status?: Array | null; + /** + * Search + */ + search?: string | null; + /** + * Steward User Id + * + * Filter by steward user ID + */ + steward_user_id?: Array | null; + /** + * Monitor Config Id + */ + monitor_config_id?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/discovery-monitor/results"; +}; + +export type getMonitorResultsApiV1PlusDiscoveryMonitorResultsGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getMonitorResultsApiV1PlusDiscoveryMonitorResultsGetError = + getMonitorResultsApiV1PlusDiscoveryMonitorResultsGetErrors[keyof getMonitorResultsApiV1PlusDiscoveryMonitorResultsGetErrors]; + +export type getMonitorResultsApiV1PlusDiscoveryMonitorResultsGetResponses = { + /** + * Successful Response + */ + 200: Page_StagedResourceAPIResponse_; +}; + +export type getMonitorResultsApiV1PlusDiscoveryMonitorResultsGetResponse = + getMonitorResultsApiV1PlusDiscoveryMonitorResultsGetResponses[keyof getMonitorResultsApiV1PlusDiscoveryMonitorResultsGetResponses]; + +export type getMonitorFieldsApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsGetData = + { + body?: never; + path: { + /** + * Monitor Config Id + */ + monitor_config_id: string; + }; + query?: { + /** + * Ordering + * + * Sort the results by the specified columns. To sort in descending order, prefix the column name with '-'. Multiple columns can be specified by separating them with commas. Example: ?ordering=-updated_at,name Default: Results are sorted by the resource's 'urn' column in ascending order. + */ + ordering?: Array; + /** + * Staged Resource Urn + */ + staged_resource_urn?: Array | null; + /** + * Search + */ + search?: string | null; + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Data Category + */ + data_category?: Array | null; + /** + * Confidence Bucket + */ + confidence_bucket?: Array | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_id}/fields"; + }; + +export type getMonitorFieldsApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getMonitorFieldsApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsGetError = + getMonitorFieldsApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsGetErrors[keyof getMonitorFieldsApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsGetErrors]; + +export type getMonitorFieldsApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsGetResponses = + { + /** + * Successful Response + */ + 200: Page_DatastoreStagedResourceAPIResponse_; + }; + +export type getMonitorFieldsApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsGetResponse = + getMonitorFieldsApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsGetResponses[keyof getMonitorFieldsApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsGetResponses]; + +export type getMonitorTreeApiV1PlusDiscoveryMonitorMonitorConfigIdTreeGetData = + { + body?: never; + path: { + /** + * Monitor Config Id + */ + monitor_config_id: string; + }; + query?: { + /** + * Staged Resource Urn + * + * URN of the parent resource to get children for. If not provided, returns top-level resources. + */ + staged_resource_urn?: string | null; + /** + * Child Staged Resource Urns + * + * Filter to only return direct children with these URNs + */ + child_staged_resource_urns?: Array | null; + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Cursor + */ + cursor?: string | null; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_id}/tree"; + }; + +export type getMonitorTreeApiV1PlusDiscoveryMonitorMonitorConfigIdTreeGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getMonitorTreeApiV1PlusDiscoveryMonitorMonitorConfigIdTreeGetError = + getMonitorTreeApiV1PlusDiscoveryMonitorMonitorConfigIdTreeGetErrors[keyof getMonitorTreeApiV1PlusDiscoveryMonitorMonitorConfigIdTreeGetErrors]; + +export type getMonitorTreeApiV1PlusDiscoveryMonitorMonitorConfigIdTreeGetResponses = + { + /** + * Successful Response + */ + 200: CursorPage_DatastoreStagedResourceTreeAPIResponse_; + }; + +export type getMonitorTreeApiV1PlusDiscoveryMonitorMonitorConfigIdTreeGetResponse = + getMonitorTreeApiV1PlusDiscoveryMonitorMonitorConfigIdTreeGetResponses[keyof getMonitorTreeApiV1PlusDiscoveryMonitorMonitorConfigIdTreeGetResponses]; + +export type getMonitorTreeAncestorsDetailsApiV1PlusDiscoveryMonitorMonitorConfigIdTreeAncestorsStatusesGetData = + { + body?: never; + path: { + /** + * Monitor Config Id + */ + monitor_config_id: string; + }; + query?: { + /** + * Staged Resource Urn + * + * URN of the parent resource to get children for. If not provided, returns top-level resources. + */ + staged_resource_urn?: string | null; + /** + * Child Staged Resource Urns + * + * Filter to only return direct children with these URNs + */ + child_staged_resource_urns?: Array | null; + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Cursor + */ + cursor?: string | null; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_id}/tree/ancestors-statuses"; + }; + +export type getMonitorTreeAncestorsDetailsApiV1PlusDiscoveryMonitorMonitorConfigIdTreeAncestorsStatusesGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getMonitorTreeAncestorsDetailsApiV1PlusDiscoveryMonitorMonitorConfigIdTreeAncestorsStatusesGetError = + getMonitorTreeAncestorsDetailsApiV1PlusDiscoveryMonitorMonitorConfigIdTreeAncestorsStatusesGetErrors[keyof getMonitorTreeAncestorsDetailsApiV1PlusDiscoveryMonitorMonitorConfigIdTreeAncestorsStatusesGetErrors]; + +export type getMonitorTreeAncestorsDetailsApiV1PlusDiscoveryMonitorMonitorConfigIdTreeAncestorsStatusesGetResponses = + { + /** + * Response Get Monitor Tree Ancestors Details Api V1 Plus Discovery Monitor Monitor Config Id Tree Ancestors Statuses Get + * + * Successful Response + */ + 200: Array; + }; + +export type getMonitorTreeAncestorsDetailsApiV1PlusDiscoveryMonitorMonitorConfigIdTreeAncestorsStatusesGetResponse = + getMonitorTreeAncestorsDetailsApiV1PlusDiscoveryMonitorMonitorConfigIdTreeAncestorsStatusesGetResponses[keyof getMonitorTreeAncestorsDetailsApiV1PlusDiscoveryMonitorMonitorConfigIdTreeAncestorsStatusesGetResponses]; + +export type getAggregateMonitorResultsApiV1PlusDiscoveryMonitorAggregateResultsGetData = + { + body?: never; + path?: never; + query?: { + /** + * Monitor Type + * + * The types of monitors to include in the results + */ + monitor_type?: Array; + /** + * Include Confidence Buckets + * + * Whether to include a classification confidence breakdown per aggregate record + */ + include_confidence_buckets?: boolean; + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Child Diff Status + */ + child_diff_status?: Array | null; + /** + * Search + */ + search?: string | null; + /** + * Steward User Id + * + * Filter by steward user ID + */ + steward_user_id?: Array | null; + /** + * Monitor Config Id + */ + monitor_config_id?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/discovery-monitor/aggregate-results"; + }; + +export type getAggregateMonitorResultsApiV1PlusDiscoveryMonitorAggregateResultsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAggregateMonitorResultsApiV1PlusDiscoveryMonitorAggregateResultsGetError = + getAggregateMonitorResultsApiV1PlusDiscoveryMonitorAggregateResultsGetErrors[keyof getAggregateMonitorResultsApiV1PlusDiscoveryMonitorAggregateResultsGetErrors]; + +export type getAggregateMonitorResultsApiV1PlusDiscoveryMonitorAggregateResultsGetResponses = + { + /** + * Successful Response + */ + 200: Page_MonitorConfigStagedResourcesAggregateRecord_; + }; + +export type getAggregateMonitorResultsApiV1PlusDiscoveryMonitorAggregateResultsGetResponse = + getAggregateMonitorResultsApiV1PlusDiscoveryMonitorAggregateResultsGetResponses[keyof getAggregateMonitorResultsApiV1PlusDiscoveryMonitorAggregateResultsGetResponses]; + +export type getAggregateSystemResultsApiV1PlusDiscoveryMonitorSystemAggregateResultsGetData = + { + body?: never; + path?: never; + query?: { + /** + * Monitor Config Id + */ + monitor_config_id?: string | null; + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Child Diff Status + */ + child_diff_status?: Array | null; + /** + * Search + */ + search?: string | null; + /** + * Resolved System Id + */ + resolved_system_id?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/discovery-monitor/system-aggregate-results"; + }; + +export type getAggregateSystemResultsApiV1PlusDiscoveryMonitorSystemAggregateResultsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAggregateSystemResultsApiV1PlusDiscoveryMonitorSystemAggregateResultsGetError = + getAggregateSystemResultsApiV1PlusDiscoveryMonitorSystemAggregateResultsGetErrors[keyof getAggregateSystemResultsApiV1PlusDiscoveryMonitorSystemAggregateResultsGetErrors]; + +export type getAggregateSystemResultsApiV1PlusDiscoveryMonitorSystemAggregateResultsGetResponses = + { + /** + * Successful Response + */ + 200: Page_SystemStagedResourcesAggregateRecord_; + }; + +export type getAggregateSystemResultsApiV1PlusDiscoveryMonitorSystemAggregateResultsGetResponse = + getAggregateSystemResultsApiV1PlusDiscoveryMonitorSystemAggregateResultsGetResponses[keyof getAggregateSystemResultsApiV1PlusDiscoveryMonitorSystemAggregateResultsGetResponses]; + +export type deleteMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsDeleteData = + { + body?: never; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: { + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Resolved System Ids + */ + resolved_system_ids?: Array; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/results"; + }; + +export type deleteMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsDeleteError = + deleteMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsDeleteErrors[keyof deleteMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsDeleteErrors]; + +export type deleteMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsDeleteResponses = + { + /** + * Successful Response + */ + 200: DeletedResourcesResponse; + }; + +export type deleteMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsDeleteResponse = + deleteMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsDeleteResponses[keyof deleteMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsDeleteResponses]; + +export type updateMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsPatchData = + { + /** + * Staged Resource Updates + */ + body: Array; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/results"; + }; + +export type updateMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsPatchError = + updateMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsPatchErrors[keyof updateMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsPatchErrors]; + +export type updateMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsPatchResponses = + { + /** + * Response Update Monitor Results Api V1 Plus Discovery Monitor Monitor Config Key Results Patch + * + * Successful Response + */ + 200: Array; + }; + +export type updateMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsPatchResponse = + updateMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsPatchResponses[keyof updateMonitorResultsApiV1PlusDiscoveryMonitorMonitorConfigKeyResultsPatchResponses]; + +export type getStagedResourceConsentBreakdownApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnConsentGetData = + { + body?: never; + path: { + /** + * Staged Resource Urn + */ + staged_resource_urn: string; + }; + query?: { + /** + * Status + */ + status?: Array | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/discovery-monitor/staged_resource/{staged_resource_urn}/consent"; + }; + +export type getStagedResourceConsentBreakdownApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnConsentGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getStagedResourceConsentBreakdownApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnConsentGetError = + getStagedResourceConsentBreakdownApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnConsentGetErrors[keyof getStagedResourceConsentBreakdownApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnConsentGetErrors]; + +export type getStagedResourceConsentBreakdownApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnConsentGetResponses = + { + /** + * Successful Response + */ + 200: Page_ConsentBreakdown_; + }; + +export type getStagedResourceConsentBreakdownApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnConsentGetResponse = + getStagedResourceConsentBreakdownApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnConsentGetResponses[keyof getStagedResourceConsentBreakdownApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnConsentGetResponses]; + +export type confirmStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStagedResourceUrnConfirmPostData = + { + body?: never; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + /** + * Staged Resource Urn + */ + staged_resource_urn: string; + }; + query?: { + /** + * Start Classification + */ + start_classification?: boolean | null; + /** + * Promote Removals + */ + promote_removals?: boolean | null; + /** + * Classify Monitored Resources + */ + classify_monitored_resources?: boolean | null; + /** + * Unmute Children + */ + unmute_children?: boolean | null; + /** + * Diff Statuses To Classify + */ + diff_statuses_to_classify?: Array | null; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/{staged_resource_urn}/confirm"; + }; + +export type confirmStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStagedResourceUrnConfirmPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type confirmStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStagedResourceUrnConfirmPostError = + confirmStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStagedResourceUrnConfirmPostErrors[keyof confirmStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStagedResourceUrnConfirmPostErrors]; + +export type confirmStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStagedResourceUrnConfirmPostResponses = + { + /** + * Response Confirm Staged Resource Endpoint Api V1 Plus Discovery Monitor Monitor Config Key Staged Resource Urn Confirm Post + * + * Successful Response + */ + 200: ConfirmResourcesResponse | null; + }; + +export type confirmStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStagedResourceUrnConfirmPostResponse = + confirmStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStagedResourceUrnConfirmPostResponses[keyof confirmStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStagedResourceUrnConfirmPostResponses]; + +export type classifyStagedResourcesBulkEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyPostData = + { + body: BaseStagedResourcesRequest; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: { + /** + * Reclassify + * + * If True, include re-classifying fields that are already classified (but not reviewed or promoted/monitored) + */ + reclassify?: boolean | null; + /** + * Reclassify All + * + * If True, reclassify all child resources including those already classified, reviewed and promoted/monitored + */ + reclassify_all?: boolean | null; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/classify"; + }; + +export type classifyStagedResourcesBulkEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type classifyStagedResourcesBulkEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyPostError = + classifyStagedResourcesBulkEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyPostErrors[keyof classifyStagedResourcesBulkEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyPostErrors]; + +export type classifyStagedResourcesBulkEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyPostResponses = + { + /** + * Response Classify Staged Resources Bulk Endpoint Api V1 Plus Discovery Monitor Monitor Config Key Classify Post + * + * Successful Response + */ + 200: MonitorActionResponse | null; + }; + +export type classifyStagedResourcesBulkEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyPostResponse = + classifyStagedResourcesBulkEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyPostResponses[keyof classifyStagedResourcesBulkEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyPostResponses]; + +export type classifyWebsiteAssetsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyAssetsPostData = + { + /** + * Body + */ + body?: OptionalStagedResourcesRequest | null; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/classify-assets"; + }; + +export type classifyWebsiteAssetsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyAssetsPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type classifyWebsiteAssetsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyAssetsPostError = + classifyWebsiteAssetsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyAssetsPostErrors[keyof classifyWebsiteAssetsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyAssetsPostErrors]; + +export type classifyWebsiteAssetsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyAssetsPostResponses = + { + /** + * Successful Response + */ + 200: MonitorActionResponse; + }; + +export type classifyWebsiteAssetsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyAssetsPostResponse = + classifyWebsiteAssetsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyAssetsPostResponses[keyof classifyWebsiteAssetsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyClassifyAssetsPostResponses]; + +export type getWebsiteClassificationReportApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationReportGetData = + { + body?: never; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: { + /** + * Sample Size + * + * Number of sample classifications + */ + sample_size?: number; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/classification-report"; + }; + +export type getWebsiteClassificationReportApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationReportGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getWebsiteClassificationReportApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationReportGetError = + getWebsiteClassificationReportApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationReportGetErrors[keyof getWebsiteClassificationReportApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationReportGetErrors]; + +export type getWebsiteClassificationReportApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationReportGetResponses = + { + /** + * Successful Response + */ + 200: WebsiteClassificationReport; + }; + +export type getWebsiteClassificationReportApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationReportGetResponse = + getWebsiteClassificationReportApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationReportGetResponses[keyof getWebsiteClassificationReportApiV1PlusDiscoveryMonitorMonitorConfigKeyClassificationReportGetResponses]; + +export type muteStagedResourcesByMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyMutePostData = + { + body?: never; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: { + /** + * Resolved System Ids + */ + resolved_system_ids?: Array; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/mute"; + }; + +export type muteStagedResourcesByMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyMutePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type muteStagedResourcesByMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyMutePostError = + muteStagedResourcesByMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyMutePostErrors[keyof muteStagedResourcesByMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyMutePostErrors]; + +export type muteStagedResourcesByMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyMutePostResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type muteStagedResourceEndpointApiV1PlusDiscoveryMonitorMutePostData = { + /** + * Body + */ + body?: BaseStagedResourcesRequest | null; + path?: never; + query?: { + /** + * Staged Resource Urns + */ + staged_resource_urns?: Array; + }; + url: "/api/v1/plus/discovery-monitor/mute"; +}; + +export type muteStagedResourceEndpointApiV1PlusDiscoveryMonitorMutePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type muteStagedResourceEndpointApiV1PlusDiscoveryMonitorMutePostError = + muteStagedResourceEndpointApiV1PlusDiscoveryMonitorMutePostErrors[keyof muteStagedResourceEndpointApiV1PlusDiscoveryMonitorMutePostErrors]; + +export type muteStagedResourceEndpointApiV1PlusDiscoveryMonitorMutePostResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type unMuteStagedResourceEndpointApiV1PlusDiscoveryMonitorUnMutePostData = + { + /** + * Body + */ + body?: BaseStagedResourcesRequest | null; + path?: never; + query?: { + /** + * Staged Resource Urns + */ + staged_resource_urns?: Array; + }; + url: "/api/v1/plus/discovery-monitor/un-mute"; + }; + +export type unMuteStagedResourceEndpointApiV1PlusDiscoveryMonitorUnMutePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type unMuteStagedResourceEndpointApiV1PlusDiscoveryMonitorUnMutePostError = + unMuteStagedResourceEndpointApiV1PlusDiscoveryMonitorUnMutePostErrors[keyof unMuteStagedResourceEndpointApiV1PlusDiscoveryMonitorUnMutePostErrors]; + +export type unMuteStagedResourceEndpointApiV1PlusDiscoveryMonitorUnMutePostResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type recalculateAggregatedConsentApiV1PlusDiscoveryMonitorMonitorConfigKeyRecalculateConsentPostData = + { + body?: never; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: { + /** + * Staged Resource Urns + */ + staged_resource_urns?: Array; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/recalculate-consent"; + }; + +export type recalculateAggregatedConsentApiV1PlusDiscoveryMonitorMonitorConfigKeyRecalculateConsentPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type recalculateAggregatedConsentApiV1PlusDiscoveryMonitorMonitorConfigKeyRecalculateConsentPostError = + recalculateAggregatedConsentApiV1PlusDiscoveryMonitorMonitorConfigKeyRecalculateConsentPostErrors[keyof recalculateAggregatedConsentApiV1PlusDiscoveryMonitorMonitorConfigKeyRecalculateConsentPostErrors]; + +export type recalculateAggregatedConsentApiV1PlusDiscoveryMonitorMonitorConfigKeyRecalculateConsentPostResponses = + { + /** + * Successful Response + */ + 200: RecalculateConsentResponse; + }; + +export type recalculateAggregatedConsentApiV1PlusDiscoveryMonitorMonitorConfigKeyRecalculateConsentPostResponse = + recalculateAggregatedConsentApiV1PlusDiscoveryMonitorMonitorConfigKeyRecalculateConsentPostResponses[keyof recalculateAggregatedConsentApiV1PlusDiscoveryMonitorMonitorConfigKeyRecalculateConsentPostResponses]; + +export type promoteStagedResourcesByMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyPromotePostData = + { + body?: never; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: { + /** + * Resolved System Ids + */ + resolved_system_ids?: Array; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/promote"; + }; + +export type promoteStagedResourcesByMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyPromotePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type promoteStagedResourcesByMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyPromotePostError = + promoteStagedResourcesByMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyPromotePostErrors[keyof promoteStagedResourcesByMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyPromotePostErrors]; + +export type promoteStagedResourcesByMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyPromotePostResponses = + { + /** + * Successful Response + */ + 200: MonitorActionResponse; + }; + +export type promoteStagedResourcesByMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyPromotePostResponse = + promoteStagedResourcesByMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyPromotePostResponses[keyof promoteStagedResourcesByMonitorApiV1PlusDiscoveryMonitorMonitorConfigKeyPromotePostResponses]; + +export type promoteStagedResourceEndpointApiV1PlusDiscoveryMonitorPromotePostData = + { + body?: never; + path?: never; + query?: { + /** + * Staged Resource Urns + */ + staged_resource_urns?: Array; + }; + url: "/api/v1/plus/discovery-monitor/promote"; + }; + +export type promoteStagedResourceEndpointApiV1PlusDiscoveryMonitorPromotePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type promoteStagedResourceEndpointApiV1PlusDiscoveryMonitorPromotePostError = + promoteStagedResourceEndpointApiV1PlusDiscoveryMonitorPromotePostErrors[keyof promoteStagedResourceEndpointApiV1PlusDiscoveryMonitorPromotePostErrors]; + +export type promoteStagedResourceEndpointApiV1PlusDiscoveryMonitorPromotePostResponses = + { + /** + * Successful Response + */ + 200: MonitorActionResponse; + }; + +export type promoteStagedResourceEndpointApiV1PlusDiscoveryMonitorPromotePostResponse = + promoteStagedResourceEndpointApiV1PlusDiscoveryMonitorPromotePostResponses[keyof promoteStagedResourceEndpointApiV1PlusDiscoveryMonitorPromotePostResponses]; + +export type promoteRemovalStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyPromoteRemovalPostData = + { + body: BaseStagedResourcesRequest; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/promote-removal"; + }; + +export type promoteRemovalStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyPromoteRemovalPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type promoteRemovalStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyPromoteRemovalPostError = + promoteRemovalStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyPromoteRemovalPostErrors[keyof promoteRemovalStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyPromoteRemovalPostErrors]; + +export type promoteRemovalStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyPromoteRemovalPostResponses = + { + /** + * Successful Response + */ + 200: PromoteResourcesResponse; + }; + +export type promoteRemovalStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyPromoteRemovalPostResponse = + promoteRemovalStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyPromoteRemovalPostResponses[keyof promoteRemovalStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyPromoteRemovalPostResponses]; + +export type reviewStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyReviewPostData = + { + body: BaseStagedResourcesRequest; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/review"; + }; + +export type reviewStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyReviewPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type reviewStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyReviewPostError = + reviewStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyReviewPostErrors[keyof reviewStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyReviewPostErrors]; + +export type reviewStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyReviewPostResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type unreviewStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyUnreviewPostData = + { + body: BaseStagedResourcesRequest; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/unreview"; + }; + +export type unreviewStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyUnreviewPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type unreviewStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyUnreviewPostError = + unreviewStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyUnreviewPostErrors[keyof unreviewStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyUnreviewPostErrors]; + +export type unreviewStagedResourceEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyUnreviewPostResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type listDiscoveryMonitorsApiV1PlusDiscoveryMonitorGetData = { + body?: never; + path?: never; + query?: { + /** + * Connection Config Key + */ + connection_config_key?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/discovery-monitor"; +}; + +export type listDiscoveryMonitorsApiV1PlusDiscoveryMonitorGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type listDiscoveryMonitorsApiV1PlusDiscoveryMonitorGetError = + listDiscoveryMonitorsApiV1PlusDiscoveryMonitorGetErrors[keyof listDiscoveryMonitorsApiV1PlusDiscoveryMonitorGetErrors]; + +export type listDiscoveryMonitorsApiV1PlusDiscoveryMonitorGetResponses = { + /** + * Successful Response + */ + 200: Page_MonitorStatusResponse_; +}; + +export type listDiscoveryMonitorsApiV1PlusDiscoveryMonitorGetResponse = + listDiscoveryMonitorsApiV1PlusDiscoveryMonitorGetResponses[keyof listDiscoveryMonitorsApiV1PlusDiscoveryMonitorGetResponses]; + +export type upsertDiscoveryMonitorApiV1PlusDiscoveryMonitorPutData = { + body: EditableMonitorConfig; + path?: never; + query?: { + /** + * Validate Params + */ + validate_params?: boolean; + /** + * Validate Dbs + */ + validate_dbs?: boolean; + }; + url: "/api/v1/plus/discovery-monitor"; +}; + +export type upsertDiscoveryMonitorApiV1PlusDiscoveryMonitorPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type upsertDiscoveryMonitorApiV1PlusDiscoveryMonitorPutError = + upsertDiscoveryMonitorApiV1PlusDiscoveryMonitorPutErrors[keyof upsertDiscoveryMonitorApiV1PlusDiscoveryMonitorPutErrors]; + +export type upsertDiscoveryMonitorApiV1PlusDiscoveryMonitorPutResponses = { + /** + * Successful Response + */ + 200: MonitorConfig; +}; + +export type upsertDiscoveryMonitorApiV1PlusDiscoveryMonitorPutResponse = + upsertDiscoveryMonitorApiV1PlusDiscoveryMonitorPutResponses[keyof upsertDiscoveryMonitorApiV1PlusDiscoveryMonitorPutResponses]; + +export type deleteDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyDeleteData = + { + body?: never; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: { + /** + * Delete Staged Resources + * + * If True (default), all staged resources associated with this monitor will also be deleted. This action is irreversible. + */ + delete_staged_resources?: boolean; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}"; + }; + +export type deleteDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyDeleteError = + deleteDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyDeleteErrors[keyof deleteDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyDeleteErrors]; + +export type deleteDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyDeleteResponses = + { + /** + * Successful Response + */ + 200: DeletedResourcesResponse; + }; + +export type deleteDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyDeleteResponse = + deleteDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyDeleteResponses[keyof deleteDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyDeleteResponses]; + +export type getDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyGetData = + { + body?: never; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}"; + }; + +export type getDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyGetError = + getDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyGetErrors[keyof getDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyGetErrors]; + +export type getDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyGetResponses = + { + /** + * Successful Response + */ + 200: MonitorConfig; + }; + +export type getDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyGetResponse = + getDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyGetResponses[keyof getDiscoveryMonitorByKeyApiV1PlusDiscoveryMonitorMonitorConfigKeyGetResponses]; + +export type getMonitorDeletionImpactApiV1PlusDiscoveryMonitorMonitorConfigKeyDeletionImpactGetData = + { + body?: never; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/deletion-impact"; + }; + +export type getMonitorDeletionImpactApiV1PlusDiscoveryMonitorMonitorConfigKeyDeletionImpactGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getMonitorDeletionImpactApiV1PlusDiscoveryMonitorMonitorConfigKeyDeletionImpactGetError = + getMonitorDeletionImpactApiV1PlusDiscoveryMonitorMonitorConfigKeyDeletionImpactGetErrors[keyof getMonitorDeletionImpactApiV1PlusDiscoveryMonitorMonitorConfigKeyDeletionImpactGetErrors]; + +export type getMonitorDeletionImpactApiV1PlusDiscoveryMonitorMonitorConfigKeyDeletionImpactGetResponses = + { + /** + * Successful Response + */ + 200: MonitorDeletionImpact; + }; + +export type getMonitorDeletionImpactApiV1PlusDiscoveryMonitorMonitorConfigKeyDeletionImpactGetResponse = + getMonitorDeletionImpactApiV1PlusDiscoveryMonitorMonitorConfigKeyDeletionImpactGetResponses[keyof getMonitorDeletionImpactApiV1PlusDiscoveryMonitorMonitorConfigKeyDeletionImpactGetResponses]; + +export type getAllowedFieldActionsEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsAllowedActionsPostData = + { + /** + * Body + */ + body?: FilteredFieldActionRequest | null; + path: { + /** + * Monitor Config Id + */ + monitor_config_id: string; + }; + query?: { + /** + * Staged Resource Urn + */ + staged_resource_urn?: Array | null; + /** + * Search + */ + search?: string | null; + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Data Category + */ + data_category?: Array | null; + /** + * Confidence Bucket + */ + confidence_bucket?: Array | null; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_id}/fields/allowed-actions"; + }; + +export type getAllowedFieldActionsEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsAllowedActionsPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAllowedFieldActionsEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsAllowedActionsPostError = + getAllowedFieldActionsEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsAllowedActionsPostErrors[keyof getAllowedFieldActionsEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsAllowedActionsPostErrors]; + +export type getAllowedFieldActionsEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsAllowedActionsPostResponses = + { + /** + * Successful Response + */ + 200: AllowedActionsResponse; + }; + +export type getAllowedFieldActionsEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsAllowedActionsPostResponse = + getAllowedFieldActionsEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsAllowedActionsPostResponses[keyof getAllowedFieldActionsEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsAllowedActionsPostResponses]; + +export type filteredFieldActionEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsActionTypePostData = + { + /** + * Body + */ + body?: FilteredFieldActionRequest | null; + path: { + action_type: FieldActionType; + /** + * Monitor Config Id + */ + monitor_config_id: string; + }; + query?: { + /** + * Staged Resource Urn + */ + staged_resource_urn?: Array | null; + /** + * Search + */ + search?: string | null; + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Data Category + */ + data_category?: Array | null; + /** + * Confidence Bucket + */ + confidence_bucket?: Array | null; + }; + url: "/api/v1/plus/discovery-monitor/{monitor_config_id}/fields/{action_type}"; + }; + +export type filteredFieldActionEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsActionTypePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type filteredFieldActionEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsActionTypePostError = + filteredFieldActionEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsActionTypePostErrors[keyof filteredFieldActionEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsActionTypePostErrors]; + +export type filteredFieldActionEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsActionTypePostResponses = + { + /** + * Response Filtered Field Action Endpoint Api V1 Plus Discovery Monitor Monitor Config Id Fields Action Type Post + * + * Successful Response + */ + 200: MonitorActionResponse | ActionValidationErrorResponse; + }; + +export type filteredFieldActionEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsActionTypePostResponse = + filteredFieldActionEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsActionTypePostResponses[keyof filteredFieldActionEndpointApiV1PlusDiscoveryMonitorMonitorConfigIdFieldsActionTypePostResponses]; + +export type getMonitorStewardsApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsGetData = + { + body?: never; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/stewards"; + }; + +export type getMonitorStewardsApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getMonitorStewardsApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsGetError = + getMonitorStewardsApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsGetErrors[keyof getMonitorStewardsApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsGetErrors]; + +export type getMonitorStewardsApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsGetResponses = + { + /** + * Response Get Monitor Stewards Api V1 Plus Discovery Monitor Monitor Config Key Stewards Get + * + * Successful Response + */ + 200: Array; + }; + +export type getMonitorStewardsApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsGetResponse = + getMonitorStewardsApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsGetResponses[keyof getMonitorStewardsApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsGetResponses]; + +export type updateMonitorStewardsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsPutData = + { + body: UpdateMonitorStewardsRequest; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/stewards"; + }; + +export type updateMonitorStewardsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateMonitorStewardsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsPutError = + updateMonitorStewardsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsPutErrors[keyof updateMonitorStewardsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsPutErrors]; + +export type updateMonitorStewardsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsPutResponses = + { + /** + * Response Update Monitor Stewards Endpoint Api V1 Plus Discovery Monitor Monitor Config Key Stewards Put + * + * Successful Response + */ + 200: Array; + }; + +export type updateMonitorStewardsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsPutResponse = + updateMonitorStewardsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsPutResponses[keyof updateMonitorStewardsEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsPutResponses]; + +export type removeMonitorStewardEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsUserIdDeleteData = + { + body?: never; + path: { + /** + * User Id + */ + user_id: string; + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/{monitor_config_key}/stewards/{user_id}"; + }; + +export type removeMonitorStewardEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsUserIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type removeMonitorStewardEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsUserIdDeleteError = + removeMonitorStewardEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsUserIdDeleteErrors[keyof removeMonitorStewardEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsUserIdDeleteErrors]; + +export type removeMonitorStewardEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsUserIdDeleteResponses = + { + /** + * Response Remove Monitor Steward Endpoint Api V1 Plus Discovery Monitor Monitor Config Key Stewards User Id Delete + * + * Successful Response + */ + 200: { + [key: string]: string; + }; + }; + +export type removeMonitorStewardEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsUserIdDeleteResponse = + removeMonitorStewardEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsUserIdDeleteResponses[keyof removeMonitorStewardEndpointApiV1PlusDiscoveryMonitorMonitorConfigKeyStewardsUserIdDeleteResponses]; + +export type getIdentityProviderMonitorResultsApiV1PlusIdentityProviderMonitorsMonitorConfigIdResultsGetData = + { + body?: never; + path: { + /** + * Monitor Config Id + */ + monitor_config_id: string; + }; + query?: { + /** + * Search + */ + search?: string | null; + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Vendor Id + */ + vendor_id?: Array | null; + /** + * Data Uses + */ + data_uses?: Array | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/identity-provider-monitors/{monitor_config_id}/results"; + }; + +export type getIdentityProviderMonitorResultsApiV1PlusIdentityProviderMonitorsMonitorConfigIdResultsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getIdentityProviderMonitorResultsApiV1PlusIdentityProviderMonitorsMonitorConfigIdResultsGetError = + getIdentityProviderMonitorResultsApiV1PlusIdentityProviderMonitorsMonitorConfigIdResultsGetErrors[keyof getIdentityProviderMonitorResultsApiV1PlusIdentityProviderMonitorsMonitorConfigIdResultsGetErrors]; + +export type getIdentityProviderMonitorResultsApiV1PlusIdentityProviderMonitorsMonitorConfigIdResultsGetResponses = + { + /** + * Successful Response + */ + 200: Page_StagedResourceAPIResponse_; + }; + +export type getIdentityProviderMonitorResultsApiV1PlusIdentityProviderMonitorsMonitorConfigIdResultsGetResponse = + getIdentityProviderMonitorResultsApiV1PlusIdentityProviderMonitorsMonitorConfigIdResultsGetResponses[keyof getIdentityProviderMonitorResultsApiV1PlusIdentityProviderMonitorsMonitorConfigIdResultsGetResponses]; + +export type getIdpAllowedActionsEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsAllowedActionsPostData = + { + body: IDPMonitorBulkSelection; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: never; + url: "/api/v1/plus/identity-provider-monitors/{monitor_config_key}/results/allowed-actions"; + }; + +export type getIdpAllowedActionsEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsAllowedActionsPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getIdpAllowedActionsEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsAllowedActionsPostError = + getIdpAllowedActionsEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsAllowedActionsPostErrors[keyof getIdpAllowedActionsEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsAllowedActionsPostErrors]; + +export type getIdpAllowedActionsEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsAllowedActionsPostResponses = + { + /** + * Successful Response + */ + 200: IDPAllowedActionsResponse; + }; + +export type getIdpAllowedActionsEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsAllowedActionsPostResponse = + getIdpAllowedActionsEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsAllowedActionsPostResponses[keyof getIdpAllowedActionsEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsAllowedActionsPostResponses]; + +export type listIdentityProviderMonitorsApiV1PlusIdentityProviderMonitorsGetData = + { + body?: Params; + path?: never; + query?: never; + url: "/api/v1/plus/identity-provider-monitors"; + }; + +export type listIdentityProviderMonitorsApiV1PlusIdentityProviderMonitorsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type listIdentityProviderMonitorsApiV1PlusIdentityProviderMonitorsGetError = + listIdentityProviderMonitorsApiV1PlusIdentityProviderMonitorsGetErrors[keyof listIdentityProviderMonitorsApiV1PlusIdentityProviderMonitorsGetErrors]; + +export type listIdentityProviderMonitorsApiV1PlusIdentityProviderMonitorsGetResponses = + { + /** + * Successful Response + */ + 200: Page_MonitorStatusResponse_; + }; + +export type listIdentityProviderMonitorsApiV1PlusIdentityProviderMonitorsGetResponse = + listIdentityProviderMonitorsApiV1PlusIdentityProviderMonitorsGetResponses[keyof listIdentityProviderMonitorsApiV1PlusIdentityProviderMonitorsGetResponses]; + +export type createIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsPostData = + { + body: IdentityProviderMonitorConfig; + path?: never; + query?: never; + url: "/api/v1/plus/identity-provider-monitors"; + }; + +export type createIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsPostError = + createIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsPostErrors[keyof createIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsPostErrors]; + +export type createIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsPostResponses = + { + /** + * Successful Response + */ + 200: MonitorStatusResponse; + }; + +export type createIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsPostResponse = + createIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsPostResponses[keyof createIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsPostResponses]; + +export type executeIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsMonitorConfigKeyExecutePostData = + { + body?: never; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: never; + url: "/api/v1/plus/identity-provider-monitors/{monitor_config_key}/execute"; + }; + +export type executeIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsMonitorConfigKeyExecutePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type executeIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsMonitorConfigKeyExecutePostError = + executeIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsMonitorConfigKeyExecutePostErrors[keyof executeIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsMonitorConfigKeyExecutePostErrors]; + +export type executeIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsMonitorConfigKeyExecutePostResponses = + { + /** + * Successful Response + */ + 200: MonitorExecutionRequestResponse; + }; + +export type executeIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsMonitorConfigKeyExecutePostResponse = + executeIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsMonitorConfigKeyExecutePostResponses[keyof executeIdentityProviderMonitorApiV1PlusIdentityProviderMonitorsMonitorConfigKeyExecutePostResponses]; + +export type promoteStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPromotePostData = + { + body?: never; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + /** + * Urn + */ + urn: string; + }; + query?: { + /** + * Organization Fides Key + * + * Organization fides_key to assign to the created System. If not provided, will use default_organization or derive from connection config. + */ + organization_fides_key?: string | null; + }; + url: "/api/v1/plus/identity-provider-monitors/{monitor_config_key}/results/{urn}/promote"; + }; + +export type promoteStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPromotePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type promoteStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPromotePostError = + promoteStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPromotePostErrors[keyof promoteStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPromotePostErrors]; + +export type promoteStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPromotePostResponses = + { + /** + * Successful Response + */ + 200: PromoteResponse; + }; + +export type promoteStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPromotePostResponse = + promoteStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPromotePostResponses[keyof promoteStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPromotePostResponses]; + +export type idpBulkActionEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsActionTypePostData = + { + body: IDPMonitorBulkSelection; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + action_type: IDPActionType; + }; + query?: { + /** + * Organization Fides Key + * + * Organization fides_key (only used for promote action) + */ + organization_fides_key?: string | null; + }; + url: "/api/v1/plus/identity-provider-monitors/{monitor_config_key}/results/{action_type}"; + }; + +export type idpBulkActionEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsActionTypePostErrors = + { + /** + * Action not allowed for selected resources + */ + 400: unknown; + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type idpBulkActionEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsActionTypePostError = + idpBulkActionEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsActionTypePostErrors[keyof idpBulkActionEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsActionTypePostErrors]; + +export type idpBulkActionEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsActionTypePostResponses = + { + /** + * Response Idp Bulk Action Endpoint Api V1 Plus Identity Provider Monitors Monitor Config Key Results Action Type Post + * + * Successful Response + */ + 200: IDPBulkActionResponse | IDPActionValidationErrorResponse; + }; + +export type idpBulkActionEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsActionTypePostResponse = + idpBulkActionEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsActionTypePostResponses[keyof idpBulkActionEndpointApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsActionTypePostResponses]; + +export type resetEndpointCachesApiV1PlusEndpointCacheResetPostData = { + body?: never; + path?: never; + query?: { + /** + * Cache Keys + */ + cache_keys?: Array; + }; + url: "/api/v1/plus/endpoint-cache/reset"; +}; + +export type resetEndpointCachesApiV1PlusEndpointCacheResetPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type resetEndpointCachesApiV1PlusEndpointCacheResetPostError = + resetEndpointCachesApiV1PlusEndpointCacheResetPostErrors[keyof resetEndpointCachesApiV1PlusEndpointCacheResetPostErrors]; + +export type resetEndpointCachesApiV1PlusEndpointCacheResetPostResponses = { + /** + * Response Reset Endpoint Caches Api V1 Plus Endpoint Cache Reset Post + * + * Successful Response + */ + 200: { + [key: string]: Array; + }; +}; + +export type resetEndpointCachesApiV1PlusEndpointCacheResetPostResponse = + resetEndpointCachesApiV1PlusEndpointCacheResetPostResponses[keyof resetEndpointCachesApiV1PlusEndpointCacheResetPostResponses]; + +export type requestOtpForExternalLoginApiV1PlusExternalLoginRequestOtpPostData = + { + body: ExternalLoginOTPRequest; + path?: never; + query?: never; + url: "/api/v1/plus/external-login/request-otp"; + }; + +export type requestOtpForExternalLoginApiV1PlusExternalLoginRequestOtpPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type requestOtpForExternalLoginApiV1PlusExternalLoginRequestOtpPostError = + requestOtpForExternalLoginApiV1PlusExternalLoginRequestOtpPostErrors[keyof requestOtpForExternalLoginApiV1PlusExternalLoginRequestOtpPostErrors]; + +export type requestOtpForExternalLoginApiV1PlusExternalLoginRequestOtpPostResponses = + { + /** + * Successful Response + */ + 200: ExternalLoginOTPResponse; + }; + +export type requestOtpForExternalLoginApiV1PlusExternalLoginRequestOtpPostResponse = + requestOtpForExternalLoginApiV1PlusExternalLoginRequestOtpPostResponses[keyof requestOtpForExternalLoginApiV1PlusExternalLoginRequestOtpPostResponses]; + +export type verifyOtpForExternalLoginApiV1PlusExternalLoginVerifyOtpPostData = { + body: ExternalLoginVerifyRequest; + path?: never; + query?: { + /** + * Config Path Override + */ + config_path_override?: string; + /** + * Verbose + */ + verbose?: boolean; + }; + url: "/api/v1/plus/external-login/verify-otp"; +}; + +export type verifyOtpForExternalLoginApiV1PlusExternalLoginVerifyOtpPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type verifyOtpForExternalLoginApiV1PlusExternalLoginVerifyOtpPostError = + verifyOtpForExternalLoginApiV1PlusExternalLoginVerifyOtpPostErrors[keyof verifyOtpForExternalLoginApiV1PlusExternalLoginVerifyOtpPostErrors]; + +export type verifyOtpForExternalLoginApiV1PlusExternalLoginVerifyOtpPostResponses = + { + /** + * Successful Response + */ + 200: UserLoginResponse; + }; + +export type verifyOtpForExternalLoginApiV1PlusExternalLoginVerifyOtpPostResponse = + verifyOtpForExternalLoginApiV1PlusExternalLoginVerifyOtpPostResponses[keyof verifyOtpForExternalLoginApiV1PlusExternalLoginVerifyOtpPostResponses]; + +export type createExternalUserApiV1PlusExternalUserPostData = { + body: ExternalUserCreateRequest; + path?: never; + query?: never; + url: "/api/v1/plus/external-user"; +}; + +export type createExternalUserApiV1PlusExternalUserPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createExternalUserApiV1PlusExternalUserPostError = + createExternalUserApiV1PlusExternalUserPostErrors[keyof createExternalUserApiV1PlusExternalUserPostErrors]; + +export type createExternalUserApiV1PlusExternalUserPostResponses = { + /** + * Successful Response + */ + 201: UserCreateResponse; +}; + +export type createExternalUserApiV1PlusExternalUserPostResponse = + createExternalUserApiV1PlusExternalUserPostResponses[keyof createExternalUserApiV1PlusExternalUserPostResponses]; + +export type getFidesCloudConfigApiV1PlusFidesCloudGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/fides-cloud"; +}; + +export type getFidesCloudConfigApiV1PlusFidesCloudGetResponses = { + /** + * Successful Response + */ + 200: CloudConfig; +}; + +export type getFidesCloudConfigApiV1PlusFidesCloudGetResponse = + getFidesCloudConfigApiV1PlusFidesCloudGetResponses[keyof getFidesCloudConfigApiV1PlusFidesCloudGetResponses]; + +export type putFidesCloudConfigApiV1PlusFidesCloudPutData = { + body: CloudConfig; + path?: never; + query?: never; + url: "/api/v1/plus/fides-cloud"; +}; + +export type putFidesCloudConfigApiV1PlusFidesCloudPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type putFidesCloudConfigApiV1PlusFidesCloudPutError = + putFidesCloudConfigApiV1PlusFidesCloudPutErrors[keyof putFidesCloudConfigApiV1PlusFidesCloudPutErrors]; + +export type putFidesCloudConfigApiV1PlusFidesCloudPutResponses = { + /** + * Successful Response + */ + 200: CloudConfig; +}; + +export type putFidesCloudConfigApiV1PlusFidesCloudPutResponse = + putFidesCloudConfigApiV1PlusFidesCloudPutResponses[keyof putFidesCloudConfigApiV1PlusFidesCloudPutResponses]; + +export type vendorListApiV1PlusGvlVendorListJsonGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/gvl/vendor-list.json"; +}; + +export type vendorListApiV1PlusGvlVendorListJsonGetResponses = { + /** + * Response Vendor List Api V1 Plus Gvl Vendor List Json Get + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type vendorListApiV1PlusGvlVendorListJsonGetResponse = + vendorListApiV1PlusGvlVendorListJsonGetResponses[keyof vendorListApiV1PlusGvlVendorListJsonGetResponses]; + +export type reloadVendorListApiV1PlusGvlReloadPostData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/gvl/reload"; +}; + +export type reloadVendorListApiV1PlusGvlReloadPostResponses = { + /** + * Response Reload Vendor List Api V1 Plus Gvl Reload Post + * + * Successful Response + */ + 200: { + [key: string]: string; + }; +}; + +export type reloadVendorListApiV1PlusGvlReloadPostResponse = + reloadVendorListApiV1PlusGvlReloadPostResponses[keyof reloadVendorListApiV1PlusGvlReloadPostResponses]; + +export type listLanguagesApiV1PlusLanguagesGetData = { + body?: never; + path?: never; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/languages"; +}; + +export type listLanguagesApiV1PlusLanguagesGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type listLanguagesApiV1PlusLanguagesGetError = + listLanguagesApiV1PlusLanguagesGetErrors[keyof listLanguagesApiV1PlusLanguagesGetErrors]; + +export type listLanguagesApiV1PlusLanguagesGetResponses = { + /** + * Successful Response + */ + 200: Page_Language_; +}; + +export type listLanguagesApiV1PlusLanguagesGetResponse = + listLanguagesApiV1PlusLanguagesGetResponses[keyof listLanguagesApiV1PlusLanguagesGetResponses]; + +export type getLocationsRegulationsApiV1PlusLocationsGetData = { + body?: never; + path?: never; + query?: { + /** + * Only Country Locations + */ + only_country_locations?: boolean; + }; + url: "/api/v1/plus/locations"; +}; + +export type getLocationsRegulationsApiV1PlusLocationsGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getLocationsRegulationsApiV1PlusLocationsGetError = + getLocationsRegulationsApiV1PlusLocationsGetErrors[keyof getLocationsRegulationsApiV1PlusLocationsGetErrors]; + +export type getLocationsRegulationsApiV1PlusLocationsGetResponses = { + /** + * Successful Response + */ + 200: LocationRegulationResponse; +}; + +export type getLocationsRegulationsApiV1PlusLocationsGetResponse = + getLocationsRegulationsApiV1PlusLocationsGetResponses[keyof getLocationsRegulationsApiV1PlusLocationsGetResponses]; + +export type patchLocationRegulationSelectionsApiV1PlusLocationsPatchData = { + body: LocationRegulationSelections; + path?: never; + query?: never; + url: "/api/v1/plus/locations"; +}; + +export type patchLocationRegulationSelectionsApiV1PlusLocationsPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type patchLocationRegulationSelectionsApiV1PlusLocationsPatchError = + patchLocationRegulationSelectionsApiV1PlusLocationsPatchErrors[keyof patchLocationRegulationSelectionsApiV1PlusLocationsPatchErrors]; + +export type patchLocationRegulationSelectionsApiV1PlusLocationsPatchResponses = + { + /** + * Successful Response + */ + 200: LocationRegulationResponse; + }; + +export type patchLocationRegulationSelectionsApiV1PlusLocationsPatchResponse = + patchLocationRegulationSelectionsApiV1PlusLocationsPatchResponses[keyof patchLocationRegulationSelectionsApiV1PlusLocationsPatchResponses]; + +export type listConnectionManualFieldsApiV1PlusConnectionConnectionKeyManualFieldsGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: { + /** + * Request Type + */ + request_type?: ManualFieldRequestType | null; + }; + url: "/api/v1/plus/connection/{connection_key}/manual-fields"; + }; + +export type listConnectionManualFieldsApiV1PlusConnectionConnectionKeyManualFieldsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type listConnectionManualFieldsApiV1PlusConnectionConnectionKeyManualFieldsGetError = + listConnectionManualFieldsApiV1PlusConnectionConnectionKeyManualFieldsGetErrors[keyof listConnectionManualFieldsApiV1PlusConnectionConnectionKeyManualFieldsGetErrors]; + +export type listConnectionManualFieldsApiV1PlusConnectionConnectionKeyManualFieldsGetResponses = + { + /** + * Response List Connection Manual Fields Api V1 Plus Connection Connection Key Manual Fields Get + * + * Successful Response + */ + 200: Array; + }; + +export type listConnectionManualFieldsApiV1PlusConnectionConnectionKeyManualFieldsGetResponse = + listConnectionManualFieldsApiV1PlusConnectionConnectionKeyManualFieldsGetResponses[keyof listConnectionManualFieldsApiV1PlusConnectionConnectionKeyManualFieldsGetResponses]; + +export type deleteManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdDeleteData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + /** + * Manual Field Id + */ + manual_field_id: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/manual-field/{manual_field_id}"; + }; + +export type deleteManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdDeleteError = + deleteManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdDeleteErrors[keyof deleteManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdDeleteErrors]; + +export type deleteManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deleteManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdDeleteResponse = + deleteManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdDeleteResponses[keyof deleteManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdDeleteResponses]; + +export type getManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + /** + * Manual Field Id + */ + manual_field_id: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/manual-field/{manual_field_id}"; + }; + +export type getManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdGetError = + getManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdGetErrors[keyof getManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdGetErrors]; + +export type getManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdGetResponses = + { + /** + * Successful Response + */ + 200: ManualFieldResponse; + }; + +export type getManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdGetResponse = + getManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdGetResponses[keyof getManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdGetResponses]; + +export type updateManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdPutData = + { + body: ManualFieldUpdate; + path: { + /** + * Connection Key + */ + connection_key: string; + /** + * Manual Field Id + */ + manual_field_id: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/manual-field/{manual_field_id}"; + }; + +export type updateManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdPutError = + updateManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdPutErrors[keyof updateManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdPutErrors]; + +export type updateManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdPutResponses = + { + /** + * Successful Response + */ + 200: ManualFieldResponse; + }; + +export type updateManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdPutResponse = + updateManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdPutResponses[keyof updateManualFieldApiV1PlusConnectionConnectionKeyManualFieldManualFieldIdPutResponses]; + +export type createManualFieldApiV1PlusConnectionConnectionKeyManualFieldPostData = + { + body: ManualFieldCreate; + path: { + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/connection/{connection_key}/manual-field"; + }; + +export type createManualFieldApiV1PlusConnectionConnectionKeyManualFieldPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createManualFieldApiV1PlusConnectionConnectionKeyManualFieldPostError = + createManualFieldApiV1PlusConnectionConnectionKeyManualFieldPostErrors[keyof createManualFieldApiV1PlusConnectionConnectionKeyManualFieldPostErrors]; + +export type createManualFieldApiV1PlusConnectionConnectionKeyManualFieldPostResponses = + { + /** + * Successful Response + */ + 201: ManualFieldResponse; + }; + +export type createManualFieldApiV1PlusConnectionConnectionKeyManualFieldPostResponse = + createManualFieldApiV1PlusConnectionConnectionKeyManualFieldPostResponses[keyof createManualFieldApiV1PlusConnectionConnectionKeyManualFieldPostResponses]; + +export type searchManualFieldsApiV1PlusManualFieldsGetData = { + body?: never; + path?: never; + query?: { + /** + * Status + */ + status?: ManualFieldStatus | null; + /** + * Request Type + */ + request_type?: ManualFieldRequestType | null; + /** + * System Name + */ + system_name?: string | null; + /** + * Assigned User Id + */ + assigned_user_id?: string | null; + /** + * Privacy Request Id + */ + privacy_request_id?: string | null; + /** + * Include Full Submission Details + */ + include_full_submission_details?: boolean; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/manual-fields"; +}; + +export type searchManualFieldsApiV1PlusManualFieldsGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type searchManualFieldsApiV1PlusManualFieldsGetError = + searchManualFieldsApiV1PlusManualFieldsGetErrors[keyof searchManualFieldsApiV1PlusManualFieldsGetErrors]; + +export type searchManualFieldsApiV1PlusManualFieldsGetResponses = { + /** + * Successful Response + */ + 200: ManualFieldSearchResponse; +}; + +export type searchManualFieldsApiV1PlusManualFieldsGetResponse = + searchManualFieldsApiV1PlusManualFieldsGetResponses[keyof searchManualFieldsApiV1PlusManualFieldsGetResponses]; + +export type exportManualFieldsApiV1PlusManualFieldsExportPostData = { + body: ManualTaskExportRequest; + path?: never; + query?: { + /** + * Status + */ + status?: ManualFieldStatus | null; + /** + * Request Type + */ + request_type?: ManualFieldRequestType | null; + /** + * System Name + */ + system_name?: string | null; + /** + * Assigned User Id + */ + assigned_user_id?: string | null; + /** + * Privacy Request Id + */ + privacy_request_id?: string | null; + }; + url: "/api/v1/plus/manual-fields/export"; +}; + +export type exportManualFieldsApiV1PlusManualFieldsExportPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type exportManualFieldsApiV1PlusManualFieldsExportPostError = + exportManualFieldsApiV1PlusManualFieldsExportPostErrors[keyof exportManualFieldsApiV1PlusManualFieldsExportPostErrors]; + +export type exportManualFieldsApiV1PlusManualFieldsExportPostResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type getPropertySpecificMessagingTemplatesSummaryApiV1PlusMessagingTemplatesSummaryGetData = + { + body?: never; + path?: never; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/messaging/templates/summary"; + }; + +export type getPropertySpecificMessagingTemplatesSummaryApiV1PlusMessagingTemplatesSummaryGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getPropertySpecificMessagingTemplatesSummaryApiV1PlusMessagingTemplatesSummaryGetError = + getPropertySpecificMessagingTemplatesSummaryApiV1PlusMessagingTemplatesSummaryGetErrors[keyof getPropertySpecificMessagingTemplatesSummaryApiV1PlusMessagingTemplatesSummaryGetErrors]; + +export type getPropertySpecificMessagingTemplatesSummaryApiV1PlusMessagingTemplatesSummaryGetResponses = + { + /** + * Successful Response + */ + 200: Page_MessagingTemplateWithPropertiesSummary_; + }; + +export type getPropertySpecificMessagingTemplatesSummaryApiV1PlusMessagingTemplatesSummaryGetResponse = + getPropertySpecificMessagingTemplatesSummaryApiV1PlusMessagingTemplatesSummaryGetResponses[keyof getPropertySpecificMessagingTemplatesSummaryApiV1PlusMessagingTemplatesSummaryGetResponses]; + +export type createPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateTypePostData = + { + body: MessagingTemplateWithPropertiesBodyParams; + path: { + template_type: MessagingActionType; + }; + query?: never; + url: "/api/v1/plus/messaging/templates/{template_type}"; + }; + +export type createPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateTypePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateTypePostError = + createPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateTypePostErrors[keyof createPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateTypePostErrors]; + +export type createPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateTypePostResponses = + { + /** + * Response Create Property Specific Messaging Template Api V1 Plus Messaging Templates Template Type Post + * + * Successful Response + */ + 200: MessagingTemplateWithPropertiesDetail | null; + }; + +export type createPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateTypePostResponse = + createPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateTypePostResponses[keyof createPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateTypePostResponses]; + +export type patchPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPatchData = + { + body: MessagingTemplateWithPropertiesPatchBodyParams; + path: { + /** + * Template Id + */ + template_id: string; + }; + query?: never; + url: "/api/v1/plus/messaging/templates/{template_id}"; + }; + +export type patchPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type patchPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPatchError = + patchPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPatchErrors[keyof patchPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPatchErrors]; + +export type patchPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPatchResponses = + { + /** + * Response Patch Property Specific Messaging Template Api V1 Plus Messaging Templates Template Id Patch + * + * Successful Response + */ + 200: MessagingTemplateWithPropertiesDetail | null; + }; + +export type patchPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPatchResponse = + patchPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPatchResponses[keyof patchPropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPatchResponses]; + +export type updatePropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPutData = + { + body: MessagingTemplateWithPropertiesBodyParams; + path: { + /** + * Template Id + */ + template_id: string; + }; + query?: never; + url: "/api/v1/plus/messaging/templates/{template_id}"; + }; + +export type updatePropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updatePropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPutError = + updatePropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPutErrors[keyof updatePropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPutErrors]; + +export type updatePropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPutResponses = + { + /** + * Response Update Property Specific Messaging Template Api V1 Plus Messaging Templates Template Id Put + * + * Successful Response + */ + 200: MessagingTemplateWithPropertiesDetail | null; + }; + +export type updatePropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPutResponse = + updatePropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPutResponses[keyof updatePropertySpecificMessagingTemplateApiV1PlusMessagingTemplatesTemplateIdPutResponses]; + +export type listSharedMonitorConfigsApiV1PlusSharedMonitorConfigGetData = { + body?: never; + path?: never; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/shared-monitor-config"; +}; + +export type listSharedMonitorConfigsApiV1PlusSharedMonitorConfigGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type listSharedMonitorConfigsApiV1PlusSharedMonitorConfigGetError = + listSharedMonitorConfigsApiV1PlusSharedMonitorConfigGetErrors[keyof listSharedMonitorConfigsApiV1PlusSharedMonitorConfigGetErrors]; + +export type listSharedMonitorConfigsApiV1PlusSharedMonitorConfigGetResponses = { + /** + * Successful Response + */ + 200: Page_SharedMonitorConfig_; +}; + +export type listSharedMonitorConfigsApiV1PlusSharedMonitorConfigGetResponse = + listSharedMonitorConfigsApiV1PlusSharedMonitorConfigGetResponses[keyof listSharedMonitorConfigsApiV1PlusSharedMonitorConfigGetResponses]; + +export type createSharedMonitorConfigApiV1PlusSharedMonitorConfigPostData = { + body: SharedMonitorConfig; + path?: never; + query?: never; + url: "/api/v1/plus/shared-monitor-config"; +}; + +export type createSharedMonitorConfigApiV1PlusSharedMonitorConfigPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createSharedMonitorConfigApiV1PlusSharedMonitorConfigPostError = + createSharedMonitorConfigApiV1PlusSharedMonitorConfigPostErrors[keyof createSharedMonitorConfigApiV1PlusSharedMonitorConfigPostErrors]; + +export type createSharedMonitorConfigApiV1PlusSharedMonitorConfigPostResponses = + { + /** + * Successful Response + */ + 200: SharedMonitorConfig; + }; + +export type createSharedMonitorConfigApiV1PlusSharedMonitorConfigPostResponse = + createSharedMonitorConfigApiV1PlusSharedMonitorConfigPostResponses[keyof createSharedMonitorConfigApiV1PlusSharedMonitorConfigPostResponses]; + +export type deleteSharedMonitorConfigApiV1PlusSharedMonitorConfigSharedConfigIdDeleteData = + { + body?: never; + path: { + /** + * Shared Config Id + */ + shared_config_id: string; + }; + query?: never; + url: "/api/v1/plus/shared-monitor-config/{shared_config_id}"; + }; + +export type deleteSharedMonitorConfigApiV1PlusSharedMonitorConfigSharedConfigIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteSharedMonitorConfigApiV1PlusSharedMonitorConfigSharedConfigIdDeleteError = + deleteSharedMonitorConfigApiV1PlusSharedMonitorConfigSharedConfigIdDeleteErrors[keyof deleteSharedMonitorConfigApiV1PlusSharedMonitorConfigSharedConfigIdDeleteErrors]; + +export type deleteSharedMonitorConfigApiV1PlusSharedMonitorConfigSharedConfigIdDeleteResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getSharedMonitorConfigByIdApiV1PlusSharedMonitorConfigSharedConfigIdGetData = + { + body?: never; + path: { + /** + * Shared Config Id + */ + shared_config_id: string; + }; + query?: never; + url: "/api/v1/plus/shared-monitor-config/{shared_config_id}"; + }; + +export type getSharedMonitorConfigByIdApiV1PlusSharedMonitorConfigSharedConfigIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getSharedMonitorConfigByIdApiV1PlusSharedMonitorConfigSharedConfigIdGetError = + getSharedMonitorConfigByIdApiV1PlusSharedMonitorConfigSharedConfigIdGetErrors[keyof getSharedMonitorConfigByIdApiV1PlusSharedMonitorConfigSharedConfigIdGetErrors]; + +export type getSharedMonitorConfigByIdApiV1PlusSharedMonitorConfigSharedConfigIdGetResponses = + { + /** + * Successful Response + */ + 200: SharedMonitorConfig; + }; + +export type getSharedMonitorConfigByIdApiV1PlusSharedMonitorConfigSharedConfigIdGetResponse = + getSharedMonitorConfigByIdApiV1PlusSharedMonitorConfigSharedConfigIdGetResponses[keyof getSharedMonitorConfigByIdApiV1PlusSharedMonitorConfigSharedConfigIdGetResponses]; + +export type updateSharedMonitorConfigApiV1PlusSharedMonitorConfigSharedConfigIdPutData = + { + body: SharedMonitorConfig; + path: { + /** + * Shared Config Id + */ + shared_config_id: string; + }; + query?: never; + url: "/api/v1/plus/shared-monitor-config/{shared_config_id}"; + }; + +export type updateSharedMonitorConfigApiV1PlusSharedMonitorConfigSharedConfigIdPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateSharedMonitorConfigApiV1PlusSharedMonitorConfigSharedConfigIdPutError = + updateSharedMonitorConfigApiV1PlusSharedMonitorConfigSharedConfigIdPutErrors[keyof updateSharedMonitorConfigApiV1PlusSharedMonitorConfigSharedConfigIdPutErrors]; + +export type updateSharedMonitorConfigApiV1PlusSharedMonitorConfigSharedConfigIdPutResponses = + { + /** + * Successful Response + */ + 200: SharedMonitorConfig; + }; + +export type updateSharedMonitorConfigApiV1PlusSharedMonitorConfigSharedConfigIdPutResponse = + updateSharedMonitorConfigApiV1PlusSharedMonitorConfigSharedConfigIdPutResponses[keyof updateSharedMonitorConfigApiV1PlusSharedMonitorConfigSharedConfigIdPutResponses]; + +export type listSimpleOpenidProvidersApiV1PlusOpenidProviderSimpleGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/openid-provider/simple"; +}; + +export type listSimpleOpenidProvidersApiV1PlusOpenidProviderSimpleGetResponses = + { + /** + * Response List Simple Openid Providers Api V1 Plus Openid Provider Simple Get + * + * Successful Response + */ + 200: Array; + }; + +export type listSimpleOpenidProvidersApiV1PlusOpenidProviderSimpleGetResponse = + listSimpleOpenidProvidersApiV1PlusOpenidProviderSimpleGetResponses[keyof listSimpleOpenidProvidersApiV1PlusOpenidProviderSimpleGetResponses]; + +export type listOpenidProvidersApiV1PlusOpenidProviderGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/openid-provider"; +}; + +export type listOpenidProvidersApiV1PlusOpenidProviderGetResponses = { + /** + * Response List Openid Providers Api V1 Plus Openid Provider Get + * + * Successful Response + */ + 200: Array; +}; + +export type listOpenidProvidersApiV1PlusOpenidProviderGetResponse = + listOpenidProvidersApiV1PlusOpenidProviderGetResponses[keyof listOpenidProvidersApiV1PlusOpenidProviderGetResponses]; + +export type createOpenidProviderApiV1PlusOpenidProviderPostData = { + body: OpenIDProviderCreate; + path?: never; + query?: never; + url: "/api/v1/plus/openid-provider"; +}; + +export type createOpenidProviderApiV1PlusOpenidProviderPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createOpenidProviderApiV1PlusOpenidProviderPostError = + createOpenidProviderApiV1PlusOpenidProviderPostErrors[keyof createOpenidProviderApiV1PlusOpenidProviderPostErrors]; + +export type createOpenidProviderApiV1PlusOpenidProviderPostResponses = { + /** + * Successful Response + */ + 201: OpenIDProvider; +}; + +export type createOpenidProviderApiV1PlusOpenidProviderPostResponse = + createOpenidProviderApiV1PlusOpenidProviderPostResponses[keyof createOpenidProviderApiV1PlusOpenidProviderPostResponses]; + +export type deleteOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierDeleteData = + { + body?: never; + path: { + /** + * Openid Provider Identifier + */ + openid_provider_identifier: string; + }; + query?: never; + url: "/api/v1/plus/openid-provider/{openid_provider_identifier}"; + }; + +export type deleteOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierDeleteError = + deleteOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierDeleteErrors[keyof deleteOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierDeleteErrors]; + +export type deleteOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierDeleteResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type detailOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierGetData = + { + body?: never; + path: { + /** + * Openid Provider Identifier + */ + openid_provider_identifier: string; + }; + query?: never; + url: "/api/v1/plus/openid-provider/{openid_provider_identifier}"; + }; + +export type detailOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type detailOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierGetError = + detailOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierGetErrors[keyof detailOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierGetErrors]; + +export type detailOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierGetResponses = + { + /** + * Successful Response + */ + 200: OpenIDProvider; + }; + +export type detailOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierGetResponse = + detailOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierGetResponses[keyof detailOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierGetResponses]; + +export type updateOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierPatchData = + { + body: OpenIDProviderCreate; + path: { + /** + * Openid Provider Identifier + */ + openid_provider_identifier: string; + }; + query?: never; + url: "/api/v1/plus/openid-provider/{openid_provider_identifier}"; + }; + +export type updateOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierPatchError = + updateOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierPatchErrors[keyof updateOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierPatchErrors]; + +export type updateOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierPatchResponses = + { + /** + * Successful Response + */ + 200: OpenIDProvider; + }; + +export type updateOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierPatchResponse = + updateOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierPatchResponses[keyof updateOpenidProviderApiV1PlusOpenidProviderOpenidProviderIdentifierPatchResponses]; + +export type authorizeApiV1PlusOpenidProviderIdentifierAuthorizeGetData = { + body?: never; + path: { + /** + * Identifier + */ + identifier: string; + }; + query?: never; + url: "/api/v1/plus/openid-provider/{identifier}/authorize"; +}; + +export type authorizeApiV1PlusOpenidProviderIdentifierAuthorizeGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type authorizeApiV1PlusOpenidProviderIdentifierAuthorizeGetError = + authorizeApiV1PlusOpenidProviderIdentifierAuthorizeGetErrors[keyof authorizeApiV1PlusOpenidProviderIdentifierAuthorizeGetErrors]; + +export type authorizeApiV1PlusOpenidProviderIdentifierAuthorizeGetResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type callbackApiV1PlusOpenidProviderIdentifierCallbackGetData = { + body?: never; + path: { + /** + * Identifier + */ + identifier: string; + }; + query: { + /** + * Code + */ + code: string; + /** + * State + */ + state: string; + /** + * Config Path Override + */ + config_path_override?: string; + /** + * Verbose + */ + verbose?: boolean; + }; + url: "/api/v1/plus/openid-provider/{identifier}/callback"; +}; + +export type callbackApiV1PlusOpenidProviderIdentifierCallbackGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type callbackApiV1PlusOpenidProviderIdentifierCallbackGetError = + callbackApiV1PlusOpenidProviderIdentifierCallbackGetErrors[keyof callbackApiV1PlusOpenidProviderIdentifierCallbackGetErrors]; + +export type callbackApiV1PlusOpenidProviderIdentifierCallbackGetResponses = { + /** + * Successful Response + */ + 200: UserLoginResponse; +}; + +export type callbackApiV1PlusOpenidProviderIdentifierCallbackGetResponse = + callbackApiV1PlusOpenidProviderIdentifierCallbackGetResponses[keyof callbackApiV1PlusOpenidProviderIdentifierCallbackGetResponses]; + +export type getPrivacyCenterConfigApiV1PlusPrivacyCenterConfigGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/privacy-center-config"; +}; + +export type getPrivacyCenterConfigApiV1PlusPrivacyCenterConfigGetResponses = { + /** + * Successful Response + */ + 200: PartialPrivacyCenterConfig; +}; + +export type getPrivacyCenterConfigApiV1PlusPrivacyCenterConfigGetResponse = + getPrivacyCenterConfigApiV1PlusPrivacyCenterConfigGetResponses[keyof getPrivacyCenterConfigApiV1PlusPrivacyCenterConfigGetResponses]; + +export type updatePrivacyCenterConfigApiV1PlusPrivacyCenterConfigPutData = { + body: PartialPrivacyCenterConfig; + path?: never; + query?: never; + url: "/api/v1/plus/privacy-center-config"; +}; + +export type updatePrivacyCenterConfigApiV1PlusPrivacyCenterConfigPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updatePrivacyCenterConfigApiV1PlusPrivacyCenterConfigPutError = + updatePrivacyCenterConfigApiV1PlusPrivacyCenterConfigPutErrors[keyof updatePrivacyCenterConfigApiV1PlusPrivacyCenterConfigPutErrors]; + +export type updatePrivacyCenterConfigApiV1PlusPrivacyCenterConfigPutResponses = + { + /** + * Successful Response + */ + 200: PartialPrivacyCenterConfig; + }; + +export type updatePrivacyCenterConfigApiV1PlusPrivacyCenterConfigPutResponse = + updatePrivacyCenterConfigApiV1PlusPrivacyCenterConfigPutResponses[keyof updatePrivacyCenterConfigApiV1PlusPrivacyCenterConfigPutResponses]; + +export type getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentGetData = + { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/attachment"; + }; + +export type getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentGetError = + getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentGetErrors[keyof getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentGetErrors]; + +export type getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentGetResponses = + { + /** + * Successful Response + */ + 200: Page_AttachmentResponse_; + }; + +export type getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentGetResponse = + getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentGetResponses[keyof getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentGetResponses]; + +export type createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentPostData = + { + body: Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__attachment_post; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/attachment"; + }; + +export type createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentPostError = + createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentPostErrors[keyof createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentPostErrors]; + +export type createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentPostResponses = + { + /** + * Successful Response + */ + 201: AttachmentResponse; + }; + +export type createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentPostResponse = + createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentPostResponses[keyof createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentPostResponses]; + +export type deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentAttachmentIdDeleteData = + { + body?: never; + path: { + /** + * Attachment Id + */ + attachment_id: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/attachment/{attachment_id}"; + }; + +export type deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentAttachmentIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentAttachmentIdDeleteError = + deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentAttachmentIdDeleteErrors[keyof deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentAttachmentIdDeleteErrors]; + +export type deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentAttachmentIdDeleteResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentAttachmentIdGetData = + { + body?: never; + path: { + /** + * Attachment Id + */ + attachment_id: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/attachment/{attachment_id}"; + }; + +export type getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentAttachmentIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentAttachmentIdGetError = + getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentAttachmentIdGetErrors[keyof getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentAttachmentIdGetErrors]; + +export type getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentAttachmentIdGetResponses = + { + /** + * Successful Response + */ + 200: AttachmentResponse; + }; + +export type getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentAttachmentIdGetResponse = + getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentAttachmentIdGetResponses[keyof getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAttachmentAttachmentIdGetResponses]; + +export type getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdCommentGetData = { + body?: never; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/comment"; +}; + +export type getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdCommentGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdCommentGetError = + getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdCommentGetErrors[keyof getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdCommentGetErrors]; + +export type getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdCommentGetResponses = + { + /** + * Successful Response + */ + 200: Page_CommentResponse_; + }; + +export type getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdCommentGetResponse = + getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdCommentGetResponses[keyof getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdCommentGetResponses]; + +export type createCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentPostData = + { + body: Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__comment_post; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/comment"; + }; + +export type createCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentPostError = + createCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentPostErrors[keyof createCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentPostErrors]; + +export type createCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentPostResponses = + { + /** + * Successful Response + */ + 201: CommentResponse; + }; + +export type createCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentPostResponse = + createCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentPostResponses[keyof createCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentPostResponses]; + +export type addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentPostData = + { + body: Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__comment__comment_id__attachment_post; + path: { + /** + * Comment Id + */ + comment_id: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/comment/{comment_id}/attachment"; + }; + +export type addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentPostError = + addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentPostErrors[keyof addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentPostErrors]; + +export type addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentPostResponses = + { + /** + * Successful Response + */ + 201: CommentResponse; + }; + +export type addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentPostResponse = + addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentPostResponses[keyof addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentPostResponses]; + +export type getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdGetData = + { + body?: never; + path: { + /** + * Comment Id + */ + comment_id: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/comment/{comment_id}"; + }; + +export type getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdGetError = + getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdGetErrors[keyof getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdGetErrors]; + +export type getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdGetResponses = + { + /** + * Successful Response + */ + 200: CommentResponse; + }; + +export type getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdGetResponse = + getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdGetResponses[keyof getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdGetResponses]; + +export type deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentAttachmentIdDeleteData = + { + body?: never; + path: { + /** + * Comment Id + */ + comment_id: string; + /** + * Attachment Id + */ + attachment_id: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/comment/{comment_id}/attachment/{attachment_id}"; + }; + +export type deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentAttachmentIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentAttachmentIdDeleteError = + deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentAttachmentIdDeleteErrors[keyof deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentAttachmentIdDeleteErrors]; + +export type deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentAttachmentIdDeleteResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentAttachmentIdGetData = + { + body?: never; + path: { + /** + * Comment Id + */ + comment_id: string; + /** + * Attachment Id + */ + attachment_id: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/comment/{comment_id}/attachment/{attachment_id}"; + }; + +export type getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentAttachmentIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentAttachmentIdGetError = + getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentAttachmentIdGetErrors[keyof getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentAttachmentIdGetErrors]; + +export type getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentAttachmentIdGetResponses = + { + /** + * Successful Response + */ + 200: AttachmentResponse; + }; + +export type getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentAttachmentIdGetResponse = + getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentAttachmentIdGetResponses[keyof getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdCommentCommentIdAttachmentAttachmentIdGetResponses]; + +export type getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/access_manual_webhook/{connection_key}/attachment"; + }; + +export type getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentGetError = + getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentGetErrors[keyof getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentGetErrors]; + +export type getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentGetResponses = + { + /** + * Successful Response + */ + 200: Page_AttachmentResponse_; + }; + +export type getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentGetResponse = + getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentGetResponses[keyof getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentGetResponses]; + +export type createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentPostData = + { + body: Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__attachment_post; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/access_manual_webhook/{connection_key}/attachment"; + }; + +export type createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentPostError = + createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentPostErrors[keyof createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentPostErrors]; + +export type createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentPostResponses = + { + /** + * Successful Response + */ + 201: AttachmentResponse; + }; + +export type createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentPostResponse = + createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentPostResponses[keyof createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentPostResponses]; + +export type deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentAttachmentIdDeleteData = + { + body?: never; + path: { + /** + * Attachment Id + */ + attachment_id: string; + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/access_manual_webhook/{connection_key}/attachment/{attachment_id}"; + }; + +export type deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentAttachmentIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentAttachmentIdDeleteError = + deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentAttachmentIdDeleteErrors[keyof deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentAttachmentIdDeleteErrors]; + +export type deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentAttachmentIdDeleteResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentAttachmentIdGetData = + { + body?: never; + path: { + /** + * Attachment Id + */ + attachment_id: string; + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/access_manual_webhook/{connection_key}/attachment/{attachment_id}"; + }; + +export type getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentAttachmentIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentAttachmentIdGetError = + getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentAttachmentIdGetErrors[keyof getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentAttachmentIdGetErrors]; + +export type getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentAttachmentIdGetResponses = + { + /** + * Successful Response + */ + 200: AttachmentResponse; + }; + +export type getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentAttachmentIdGetResponse = + getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentAttachmentIdGetResponses[keyof getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyAttachmentAttachmentIdGetResponses]; + +export type getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/access_manual_webhook/{connection_key}/comment"; + }; + +export type getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentGetError = + getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentGetErrors[keyof getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentGetErrors]; + +export type getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentGetResponses = + { + /** + * Successful Response + */ + 200: Page_CommentResponse_; + }; + +export type getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentGetResponse = + getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentGetResponses[keyof getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentGetResponses]; + +export type createCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentPostData = + { + body: Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment_post; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/access_manual_webhook/{connection_key}/comment"; + }; + +export type createCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentPostError = + createCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentPostErrors[keyof createCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentPostErrors]; + +export type createCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentPostResponses = + { + /** + * Successful Response + */ + 201: CommentResponse; + }; + +export type createCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentPostResponse = + createCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentPostResponses[keyof createCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentPostResponses]; + +export type addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentPostData = + { + body: Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__access_manual_webhook__connection_key__comment__comment_id__attachment_post; + path: { + /** + * Comment Id + */ + comment_id: string; + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/access_manual_webhook/{connection_key}/comment/{comment_id}/attachment"; + }; + +export type addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentPostError = + addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentPostErrors[keyof addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentPostErrors]; + +export type addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentPostResponses = + { + /** + * Successful Response + */ + 201: CommentResponse; + }; + +export type addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentPostResponse = + addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentPostResponses[keyof addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentPostResponses]; + +export type getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdGetData = + { + body?: never; + path: { + /** + * Comment Id + */ + comment_id: string; + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/access_manual_webhook/{connection_key}/comment/{comment_id}"; + }; + +export type getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdGetError = + getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdGetErrors[keyof getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdGetErrors]; + +export type getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdGetResponses = + { + /** + * Successful Response + */ + 200: CommentResponse; + }; + +export type getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdGetResponse = + getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdGetResponses[keyof getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdGetResponses]; + +export type deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdDeleteData = + { + body?: never; + path: { + /** + * Comment Id + */ + comment_id: string; + /** + * Attachment Id + */ + attachment_id: string; + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/access_manual_webhook/{connection_key}/comment/{comment_id}/attachment/{attachment_id}"; + }; + +export type deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdDeleteError = + deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdDeleteErrors[keyof deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdDeleteErrors]; + +export type deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdDeleteResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetData = + { + body?: never; + path: { + /** + * Comment Id + */ + comment_id: string; + /** + * Attachment Id + */ + attachment_id: string; + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/access_manual_webhook/{connection_key}/comment/{comment_id}/attachment/{attachment_id}"; + }; + +export type getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetError = + getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetErrors[keyof getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetErrors]; + +export type getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetResponses = + { + /** + * Successful Response + */ + 200: AttachmentResponse; + }; + +export type getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetResponse = + getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetResponses[keyof getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdAccessManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetResponses]; + +export type getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/erasure_manual_webhook/{connection_key}/attachment"; + }; + +export type getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentGetError = + getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentGetErrors[keyof getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentGetErrors]; + +export type getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentGetResponses = + { + /** + * Successful Response + */ + 200: Page_AttachmentResponse_; + }; + +export type getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentGetResponse = + getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentGetResponses[keyof getAttachmentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentGetResponses]; + +export type createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentPostData = + { + body: Body_create_attachment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__attachment_post; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/erasure_manual_webhook/{connection_key}/attachment"; + }; + +export type createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentPostError = + createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentPostErrors[keyof createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentPostErrors]; + +export type createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentPostResponses = + { + /** + * Successful Response + */ + 201: AttachmentResponse; + }; + +export type createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentPostResponse = + createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentPostResponses[keyof createAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentPostResponses]; + +export type deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentAttachmentIdDeleteData = + { + body?: never; + path: { + /** + * Attachment Id + */ + attachment_id: string; + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/erasure_manual_webhook/{connection_key}/attachment/{attachment_id}"; + }; + +export type deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentAttachmentIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentAttachmentIdDeleteError = + deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentAttachmentIdDeleteErrors[keyof deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentAttachmentIdDeleteErrors]; + +export type deleteAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentAttachmentIdDeleteResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentAttachmentIdGetData = + { + body?: never; + path: { + /** + * Attachment Id + */ + attachment_id: string; + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/erasure_manual_webhook/{connection_key}/attachment/{attachment_id}"; + }; + +export type getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentAttachmentIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentAttachmentIdGetError = + getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentAttachmentIdGetErrors[keyof getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentAttachmentIdGetErrors]; + +export type getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentAttachmentIdGetResponses = + { + /** + * Successful Response + */ + 200: AttachmentResponse; + }; + +export type getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentAttachmentIdGetResponse = + getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentAttachmentIdGetResponses[keyof getAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyAttachmentAttachmentIdGetResponses]; + +export type getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentGetData = + { + body?: never; + path: { + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/erasure_manual_webhook/{connection_key}/comment"; + }; + +export type getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentGetError = + getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentGetErrors[keyof getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentGetErrors]; + +export type getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentGetResponses = + { + /** + * Successful Response + */ + 200: Page_CommentResponse_; + }; + +export type getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentGetResponse = + getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentGetResponses[keyof getCommentsApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentGetResponses]; + +export type createCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentPostData = + { + body: Body_create_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment_post; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + /** + * Connection Key + */ + connection_key: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/erasure_manual_webhook/{connection_key}/comment"; + }; + +export type createCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentPostError = + createCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentPostErrors[keyof createCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentPostErrors]; + +export type createCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentPostResponses = + { + /** + * Successful Response + */ + 201: CommentResponse; + }; + +export type createCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentPostResponse = + createCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentPostResponses[keyof createCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentPostResponses]; + +export type addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentPostData = + { + body: Body_add_attachments_to_comment_api_v1_plus_privacy_request__privacy_request_id__erasure_manual_webhook__connection_key__comment__comment_id__attachment_post; + path: { + /** + * Comment Id + */ + comment_id: string; + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/erasure_manual_webhook/{connection_key}/comment/{comment_id}/attachment"; + }; + +export type addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentPostError = + addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentPostErrors[keyof addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentPostErrors]; + +export type addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentPostResponses = + { + /** + * Successful Response + */ + 201: CommentResponse; + }; + +export type addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentPostResponse = + addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentPostResponses[keyof addAttachmentsToCommentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentPostResponses]; + +export type getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdGetData = + { + body?: never; + path: { + /** + * Comment Id + */ + comment_id: string; + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/erasure_manual_webhook/{connection_key}/comment/{comment_id}"; + }; + +export type getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdGetError = + getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdGetErrors[keyof getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdGetErrors]; + +export type getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdGetResponses = + { + /** + * Successful Response + */ + 200: CommentResponse; + }; + +export type getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdGetResponse = + getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdGetResponses[keyof getCommentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdGetResponses]; + +export type deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdDeleteData = + { + body?: never; + path: { + /** + * Comment Id + */ + comment_id: string; + /** + * Attachment Id + */ + attachment_id: string; + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/erasure_manual_webhook/{connection_key}/comment/{comment_id}/attachment/{attachment_id}"; + }; + +export type deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdDeleteError = + deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdDeleteErrors[keyof deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdDeleteErrors]; + +export type deleteCommentAttachmentApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdDeleteResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetData = + { + body?: never; + path: { + /** + * Comment Id + */ + comment_id: string; + /** + * Attachment Id + */ + attachment_id: string; + /** + * Connection Key + */ + connection_key: string; + /** + * Privacy Request Id + */ + privacy_request_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-request/{privacy_request_id}/erasure_manual_webhook/{connection_key}/comment/{comment_id}/attachment/{attachment_id}"; + }; + +export type getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetError = + getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetErrors[keyof getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetErrors]; + +export type getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetResponses = + { + /** + * Successful Response + */ + 200: AttachmentResponse; + }; + +export type getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetResponse = + getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetResponses[keyof getCommentAttachmentByIdApiV1PlusPrivacyRequestPrivacyRequestIdErasureManualWebhookConnectionKeyCommentCommentIdAttachmentAttachmentIdGetResponses]; + +export type getPropertiesApiV1PlusPropertiesGetData = { + body?: never; + path?: never; + query?: { + /** + * Search + */ + search?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/properties"; +}; + +export type getPropertiesApiV1PlusPropertiesGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getPropertiesApiV1PlusPropertiesGetError = + getPropertiesApiV1PlusPropertiesGetErrors[keyof getPropertiesApiV1PlusPropertiesGetErrors]; + +export type getPropertiesApiV1PlusPropertiesGetResponses = { + /** + * Successful Response + */ + 200: Page_Property_; +}; + +export type getPropertiesApiV1PlusPropertiesGetResponse = + getPropertiesApiV1PlusPropertiesGetResponses[keyof getPropertiesApiV1PlusPropertiesGetResponses]; + +export type deletePropertyByIdApiV1PlusPropertyPropertyIdDeleteData = { + body?: never; + path: { + /** + * Property Id + */ + property_id: string; + }; + query?: never; + url: "/api/v1/plus/property/{property_id}"; +}; + +export type deletePropertyByIdApiV1PlusPropertyPropertyIdDeleteErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deletePropertyByIdApiV1PlusPropertyPropertyIdDeleteError = + deletePropertyByIdApiV1PlusPropertyPropertyIdDeleteErrors[keyof deletePropertyByIdApiV1PlusPropertyPropertyIdDeleteErrors]; + +export type deletePropertyByIdApiV1PlusPropertyPropertyIdDeleteResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type getPropertyByIdApiV1PlusPropertyPropertyIdGetData = { + body?: never; + path: { + /** + * Property Id + */ + property_id: string; + }; + query?: never; + url: "/api/v1/plus/property/{property_id}"; +}; + +export type getPropertyByIdApiV1PlusPropertyPropertyIdGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getPropertyByIdApiV1PlusPropertyPropertyIdGetError = + getPropertyByIdApiV1PlusPropertyPropertyIdGetErrors[keyof getPropertyByIdApiV1PlusPropertyPropertyIdGetErrors]; + +export type getPropertyByIdApiV1PlusPropertyPropertyIdGetResponses = { + /** + * Successful Response + */ + 200: Property; +}; + +export type getPropertyByIdApiV1PlusPropertyPropertyIdGetResponse = + getPropertyByIdApiV1PlusPropertyPropertyIdGetResponses[keyof getPropertyByIdApiV1PlusPropertyPropertyIdGetResponses]; + +export type updatePropertyByIdApiV1PlusPropertyPropertyIdPutData = { + body: PropertyCreate; + path: { + /** + * Property Id + */ + property_id: string; + }; + query?: never; + url: "/api/v1/plus/property/{property_id}"; +}; + +export type updatePropertyByIdApiV1PlusPropertyPropertyIdPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updatePropertyByIdApiV1PlusPropertyPropertyIdPutError = + updatePropertyByIdApiV1PlusPropertyPropertyIdPutErrors[keyof updatePropertyByIdApiV1PlusPropertyPropertyIdPutErrors]; + +export type updatePropertyByIdApiV1PlusPropertyPropertyIdPutResponses = { + /** + * Successful Response + */ + 200: Property; +}; + +export type updatePropertyByIdApiV1PlusPropertyPropertyIdPutResponse = + updatePropertyByIdApiV1PlusPropertyPropertyIdPutResponses[keyof updatePropertyByIdApiV1PlusPropertyPropertyIdPutResponses]; + +export type getPropertyByPathApiV1PlusPropertyGetData = { + body?: never; + path?: never; + query: { + /** + * Path + */ + path: string; + /** + * Location + */ + location?: string | null; + }; + url: "/api/v1/plus/property"; +}; + +export type getPropertyByPathApiV1PlusPropertyGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getPropertyByPathApiV1PlusPropertyGetError = + getPropertyByPathApiV1PlusPropertyGetErrors[keyof getPropertyByPathApiV1PlusPropertyGetErrors]; + +export type getPropertyByPathApiV1PlusPropertyGetResponses = { + /** + * Successful Response + */ + 200: PublicPropertyResponse; +}; + +export type getPropertyByPathApiV1PlusPropertyGetResponse = + getPropertyByPathApiV1PlusPropertyGetResponses[keyof getPropertyByPathApiV1PlusPropertyGetResponses]; + +export type createPropertyApiV1PlusPropertyPostData = { + body: PropertyCreate; + path?: never; + query?: never; + url: "/api/v1/plus/property"; +}; + +export type createPropertyApiV1PlusPropertyPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createPropertyApiV1PlusPropertyPostError = + createPropertyApiV1PlusPropertyPostErrors[keyof createPropertyApiV1PlusPropertyPostErrors]; + +export type createPropertyApiV1PlusPropertyPostResponses = { + /** + * Successful Response + */ + 200: Property; +}; + +export type createPropertyApiV1PlusPropertyPostResponse = + createPropertyApiV1PlusPropertyPostResponses[keyof createPropertyApiV1PlusPropertyPostResponses]; + +export type bulkAssignPropertiesToDatasetsApiV1PlusDatasetPropertiesBulkAssignPostData = + { + body: BulkPropertyAssignment; + path?: never; + query?: never; + url: "/api/v1/plus/dataset-properties/bulk-assign"; + }; + +export type bulkAssignPropertiesToDatasetsApiV1PlusDatasetPropertiesBulkAssignPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type bulkAssignPropertiesToDatasetsApiV1PlusDatasetPropertiesBulkAssignPostError = + bulkAssignPropertiesToDatasetsApiV1PlusDatasetPropertiesBulkAssignPostErrors[keyof bulkAssignPropertiesToDatasetsApiV1PlusDatasetPropertiesBulkAssignPostErrors]; + +export type bulkAssignPropertiesToDatasetsApiV1PlusDatasetPropertiesBulkAssignPostResponses = + { + /** + * Successful Response + */ + 200: BulkDatasetPropertyResponse; + }; + +export type bulkAssignPropertiesToDatasetsApiV1PlusDatasetPropertiesBulkAssignPostResponse = + bulkAssignPropertiesToDatasetsApiV1PlusDatasetPropertiesBulkAssignPostResponses[keyof bulkAssignPropertiesToDatasetsApiV1PlusDatasetPropertiesBulkAssignPostResponses]; + +export type bulkRemovePropertiesFromDatasetsApiV1PlusDatasetPropertiesBulkRemovePostData = + { + body: BulkPropertyRemoval; + path?: never; + query?: never; + url: "/api/v1/plus/dataset-properties/bulk-remove"; + }; + +export type bulkRemovePropertiesFromDatasetsApiV1PlusDatasetPropertiesBulkRemovePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type bulkRemovePropertiesFromDatasetsApiV1PlusDatasetPropertiesBulkRemovePostError = + bulkRemovePropertiesFromDatasetsApiV1PlusDatasetPropertiesBulkRemovePostErrors[keyof bulkRemovePropertiesFromDatasetsApiV1PlusDatasetPropertiesBulkRemovePostErrors]; + +export type bulkRemovePropertiesFromDatasetsApiV1PlusDatasetPropertiesBulkRemovePostResponses = + { + /** + * Successful Response + */ + 200: BulkDatasetPropertyResponse; + }; + +export type bulkRemovePropertiesFromDatasetsApiV1PlusDatasetPropertiesBulkRemovePostResponse = + bulkRemovePropertiesFromDatasetsApiV1PlusDatasetPropertiesBulkRemovePostResponses[keyof bulkRemovePropertiesFromDatasetsApiV1PlusDatasetPropertiesBulkRemovePostResponses]; + +export type resolvePropertyNamesApiV1PlusDatasetPropertiesResolveNamesPostData = + { + body: PropertyNameResolutionRequest; + path?: never; + query?: never; + url: "/api/v1/plus/dataset-properties/resolve-names"; + }; + +export type resolvePropertyNamesApiV1PlusDatasetPropertiesResolveNamesPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type resolvePropertyNamesApiV1PlusDatasetPropertiesResolveNamesPostError = + resolvePropertyNamesApiV1PlusDatasetPropertiesResolveNamesPostErrors[keyof resolvePropertyNamesApiV1PlusDatasetPropertiesResolveNamesPostErrors]; + +export type resolvePropertyNamesApiV1PlusDatasetPropertiesResolveNamesPostResponses = + { + /** + * Successful Response + */ + 200: PropertyNameResolutionResponse; + }; + +export type resolvePropertyNamesApiV1PlusDatasetPropertiesResolveNamesPostResponse = + resolvePropertyNamesApiV1PlusDatasetPropertiesResolveNamesPostResponses[keyof resolvePropertyNamesApiV1PlusDatasetPropertiesResolveNamesPostResponses]; + +export type getCustomFieldLocationsApiV1PlusCustomFieldsLocationsGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/custom-fields/locations"; +}; + +export type getCustomFieldLocationsApiV1PlusCustomFieldsLocationsGetResponses = + { + /** + * Response Get Custom Field Locations Api V1 Plus Custom Fields Locations Get + * + * Successful Response + */ + 200: Array; + }; + +export type getCustomFieldLocationsApiV1PlusCustomFieldsLocationsGetResponse = + getCustomFieldLocationsApiV1PlusCustomFieldsLocationsGetResponses[keyof getCustomFieldLocationsApiV1PlusCustomFieldsLocationsGetResponses]; + +export type rapidConsentReportingApiV1PlusConsentReportingGetData = { + body?: never; + path?: never; + query?: { + /** + * Created Gt + */ + created_gt?: string | null; + /** + * Created Lt + */ + created_lt?: string | null; + /** + * Property Id + */ + property_id?: string | null; + }; + url: "/api/v1/plus/consent_reporting"; +}; + +export type rapidConsentReportingApiV1PlusConsentReportingGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type rapidConsentReportingApiV1PlusConsentReportingGetError = + rapidConsentReportingApiV1PlusConsentReportingGetErrors[keyof rapidConsentReportingApiV1PlusConsentReportingGetErrors]; + +export type rapidConsentReportingApiV1PlusConsentReportingGetResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type getSystemHistoryApiV1PlusSystemFidesKeyHistoryGetData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/system/{fides_key}/history"; +}; + +export type getSystemHistoryApiV1PlusSystemFidesKeyHistoryGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getSystemHistoryApiV1PlusSystemFidesKeyHistoryGetError = + getSystemHistoryApiV1PlusSystemFidesKeyHistoryGetErrors[keyof getSystemHistoryApiV1PlusSystemFidesKeyHistoryGetErrors]; + +export type getSystemHistoryApiV1PlusSystemFidesKeyHistoryGetResponses = { + /** + * Successful Response + */ + 200: Page_SystemHistoryResponse_; +}; + +export type getSystemHistoryApiV1PlusSystemFidesKeyHistoryGetResponse = + getSystemHistoryApiV1PlusSystemFidesKeyHistoryGetResponses[keyof getSystemHistoryApiV1PlusSystemFidesKeyHistoryGetResponses]; + +export type instantiateConnectionFromTemplateExtendedApiV1PlusSystemFidesKeyConnectionInstantiateConnectorTemplateTypePostData = + { + body: SaasConnectionTemplateValuesExtended; + path: { + /** + * Fides Key + */ + fides_key: string; + /** + * Connector Template Type + */ + connector_template_type: string; + }; + query?: never; + url: "/api/v1/plus/system/{fides_key}/connection/instantiate/{connector_template_type}"; + }; + +export type instantiateConnectionFromTemplateExtendedApiV1PlusSystemFidesKeyConnectionInstantiateConnectorTemplateTypePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type instantiateConnectionFromTemplateExtendedApiV1PlusSystemFidesKeyConnectionInstantiateConnectorTemplateTypePostError = + instantiateConnectionFromTemplateExtendedApiV1PlusSystemFidesKeyConnectionInstantiateConnectorTemplateTypePostErrors[keyof instantiateConnectionFromTemplateExtendedApiV1PlusSystemFidesKeyConnectionInstantiateConnectorTemplateTypePostErrors]; + +export type instantiateConnectionFromTemplateExtendedApiV1PlusSystemFidesKeyConnectionInstantiateConnectorTemplateTypePostResponses = + { + /** + * Successful Response + */ + 200: SaasConnectionTemplateResponse; + }; + +export type instantiateConnectionFromTemplateExtendedApiV1PlusSystemFidesKeyConnectionInstantiateConnectorTemplateTypePostResponse = + instantiateConnectionFromTemplateExtendedApiV1PlusSystemFidesKeyConnectionInstantiateConnectorTemplateTypePostResponses[keyof instantiateConnectionFromTemplateExtendedApiV1PlusSystemFidesKeyConnectionInstantiateConnectorTemplateTypePostResponses]; + +export type patchConnectionsExtendedApiV1PlusSystemFidesKeyConnectionPatchData = + { + /** + * Configs + */ + body: Array; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/plus/system/{fides_key}/connection"; + }; + +export type patchConnectionsExtendedApiV1PlusSystemFidesKeyConnectionPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type patchConnectionsExtendedApiV1PlusSystemFidesKeyConnectionPatchError = + patchConnectionsExtendedApiV1PlusSystemFidesKeyConnectionPatchErrors[keyof patchConnectionsExtendedApiV1PlusSystemFidesKeyConnectionPatchErrors]; + +export type patchConnectionsExtendedApiV1PlusSystemFidesKeyConnectionPatchResponses = + { + /** + * Successful Response + */ + 200: BulkPutConnectionConfiguration; + }; + +export type patchConnectionsExtendedApiV1PlusSystemFidesKeyConnectionPatchResponse = + patchConnectionsExtendedApiV1PlusSystemFidesKeyConnectionPatchResponses[keyof patchConnectionsExtendedApiV1PlusSystemFidesKeyConnectionPatchResponses]; + +export type systemPurposeSummaryApiV1PlusSystemFidesKeyPurposeSummaryGetData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/plus/system/{fides_key}/purpose-summary"; +}; + +export type systemPurposeSummaryApiV1PlusSystemFidesKeyPurposeSummaryGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type systemPurposeSummaryApiV1PlusSystemFidesKeyPurposeSummaryGetError = + systemPurposeSummaryApiV1PlusSystemFidesKeyPurposeSummaryGetErrors[keyof systemPurposeSummaryApiV1PlusSystemFidesKeyPurposeSummaryGetErrors]; + +export type systemPurposeSummaryApiV1PlusSystemFidesKeyPurposeSummaryGetResponses = + { + /** + * Successful Response + */ + 200: SystemPurposeSummary; + }; + +export type systemPurposeSummaryApiV1PlusSystemFidesKeyPurposeSummaryGetResponse = + systemPurposeSummaryApiV1PlusSystemFidesKeyPurposeSummaryGetResponses[keyof systemPurposeSummaryApiV1PlusSystemFidesKeyPurposeSummaryGetResponses]; + +export type consentManagementReportApiV1PlusSystemConsentManagementReportGetData = + { + body?: never; + path?: never; + query?: { + /** + * Search + */ + search?: string | null; + /** + * Purposes + */ + purposes?: Array | null; + /** + * Special Purposes + */ + special_purposes?: Array | null; + /** + * Data Uses + */ + data_uses?: Array | null; + /** + * Legal Bases + */ + legal_bases?: Array | null; + /** + * Consent Category + */ + consent_category?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/system/consent-management/report"; + }; + +export type consentManagementReportApiV1PlusSystemConsentManagementReportGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type consentManagementReportApiV1PlusSystemConsentManagementReportGetError = + consentManagementReportApiV1PlusSystemConsentManagementReportGetErrors[keyof consentManagementReportApiV1PlusSystemConsentManagementReportGetErrors]; + +export type consentManagementReportApiV1PlusSystemConsentManagementReportGetResponses = + { + /** + * Successful Response + */ + 200: Page_SystemSummary_; + }; + +export type consentManagementReportApiV1PlusSystemConsentManagementReportGetResponse = + consentManagementReportApiV1PlusSystemConsentManagementReportGetResponses[keyof consentManagementReportApiV1PlusSystemConsentManagementReportGetResponses]; + +export type decodeTcStringForMobileApiV1PlusTcfDecodeMobileGetData = { + body?: never; + path?: never; + query: { + /** + * Fides String + */ + fides_string: string; + }; + url: "/api/v1/plus/tcf/decode_mobile"; +}; + +export type decodeTcStringForMobileApiV1PlusTcfDecodeMobileGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type decodeTcStringForMobileApiV1PlusTcfDecodeMobileGetError = + decodeTcStringForMobileApiV1PlusTcfDecodeMobileGetErrors[keyof decodeTcStringForMobileApiV1PlusTcfDecodeMobileGetErrors]; + +export type decodeTcStringForMobileApiV1PlusTcfDecodeMobileGetResponses = { + /** + * Successful Response + */ + 200: TCDecode; +}; + +export type decodeTcStringForMobileApiV1PlusTcfDecodeMobileGetResponse = + decodeTcStringForMobileApiV1PlusTcfDecodeMobileGetResponses[keyof decodeTcStringForMobileApiV1PlusTcfDecodeMobileGetResponses]; + +export type getTcfPurposeOverridesApiV1PlusTcfPurposeOverridesGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/tcf/purpose_overrides"; +}; + +export type getTcfPurposeOverridesApiV1PlusTcfPurposeOverridesGetResponses = { + /** + * Response Get Tcf Purpose Overrides Api V1 Plus Tcf Purpose Overrides Get + * + * Successful Response + */ + 200: Array; +}; + +export type getTcfPurposeOverridesApiV1PlusTcfPurposeOverridesGetResponse = + getTcfPurposeOverridesApiV1PlusTcfPurposeOverridesGetResponses[keyof getTcfPurposeOverridesApiV1PlusTcfPurposeOverridesGetResponses]; + +export type patchTcfPurposeOverridesApiV1PlusTcfPurposeOverridesPatchData = { + /** + * Data + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/plus/tcf/purpose_overrides"; +}; + +export type patchTcfPurposeOverridesApiV1PlusTcfPurposeOverridesPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type patchTcfPurposeOverridesApiV1PlusTcfPurposeOverridesPatchError = + patchTcfPurposeOverridesApiV1PlusTcfPurposeOverridesPatchErrors[keyof patchTcfPurposeOverridesApiV1PlusTcfPurposeOverridesPatchErrors]; + +export type patchTcfPurposeOverridesApiV1PlusTcfPurposeOverridesPatchResponses = + { + /** + * Response Patch Tcf Purpose Overrides Api V1 Plus Tcf Purpose Overrides Patch + * + * Successful Response + */ + 200: Array; + }; + +export type patchTcfPurposeOverridesApiV1PlusTcfPurposeOverridesPatchResponse = + patchTcfPurposeOverridesApiV1PlusTcfPurposeOverridesPatchResponses[keyof patchTcfPurposeOverridesApiV1PlusTcfPurposeOverridesPatchResponses]; + +export type listTcfConfigurationsApiV1PlusTcfConfigurationsGetData = { + body?: never; + path?: never; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/tcf/configurations"; +}; + +export type listTcfConfigurationsApiV1PlusTcfConfigurationsGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type listTcfConfigurationsApiV1PlusTcfConfigurationsGetError = + listTcfConfigurationsApiV1PlusTcfConfigurationsGetErrors[keyof listTcfConfigurationsApiV1PlusTcfConfigurationsGetErrors]; + +export type listTcfConfigurationsApiV1PlusTcfConfigurationsGetResponses = { + /** + * Successful Response + */ + 200: Page_TCFConfigurationResponse_; +}; + +export type listTcfConfigurationsApiV1PlusTcfConfigurationsGetResponse = + listTcfConfigurationsApiV1PlusTcfConfigurationsGetResponses[keyof listTcfConfigurationsApiV1PlusTcfConfigurationsGetResponses]; + +export type createTcfConfigurationApiV1PlusTcfConfigurationsPostData = { + body: TCFConfigurationRequest; + path?: never; + query?: never; + url: "/api/v1/plus/tcf/configurations"; +}; + +export type createTcfConfigurationApiV1PlusTcfConfigurationsPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createTcfConfigurationApiV1PlusTcfConfigurationsPostError = + createTcfConfigurationApiV1PlusTcfConfigurationsPostErrors[keyof createTcfConfigurationApiV1PlusTcfConfigurationsPostErrors]; + +export type createTcfConfigurationApiV1PlusTcfConfigurationsPostResponses = { + /** + * Successful Response + */ + 201: TCFConfigurationResponse; +}; + +export type createTcfConfigurationApiV1PlusTcfConfigurationsPostResponse = + createTcfConfigurationApiV1PlusTcfConfigurationsPostResponses[keyof createTcfConfigurationApiV1PlusTcfConfigurationsPostResponses]; + +export type deleteTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdDeleteData = + { + body?: never; + path: { + /** + * Configuration Id + */ + configuration_id: string; + }; + query?: never; + url: "/api/v1/plus/tcf/configurations/{configuration_id}"; + }; + +export type deleteTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdDeleteError = + deleteTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdDeleteErrors[keyof deleteTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdDeleteErrors]; + +export type deleteTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deleteTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdDeleteResponse = + deleteTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdDeleteResponses[keyof deleteTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdDeleteResponses]; + +export type getTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdGetData = + { + body?: never; + path: { + /** + * Configuration Id + */ + configuration_id: string; + }; + query?: never; + url: "/api/v1/plus/tcf/configurations/{configuration_id}"; + }; + +export type getTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdGetError = + getTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdGetErrors[keyof getTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdGetErrors]; + +export type getTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdGetResponses = + { + /** + * Successful Response + */ + 200: TCFConfigurationDetail; + }; + +export type getTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdGetResponse = + getTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdGetResponses[keyof getTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdGetResponses]; + +export type updateTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdPatchData = + { + body: TCFConfigurationRequest; + path: { + /** + * Configuration Id + */ + configuration_id: string; + }; + query?: never; + url: "/api/v1/plus/tcf/configurations/{configuration_id}"; + }; + +export type updateTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdPatchError = + updateTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdPatchErrors[keyof updateTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdPatchErrors]; + +export type updateTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdPatchResponses = + { + /** + * Successful Response + */ + 200: TCFConfigurationResponse; + }; + +export type updateTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdPatchResponse = + updateTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdPatchResponses[keyof updateTcfConfigurationApiV1PlusTcfConfigurationsConfigurationIdPatchResponses]; + +export type getAllRestrictionsForPurposeApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsGetData = + { + body?: never; + path: { + /** + * Configuration Id + */ + configuration_id: string; + }; + query?: { + /** + * Purpose Id + */ + purpose_id?: number | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/tcf/configurations/{configuration_id}/publisher_restrictions"; + }; + +export type getAllRestrictionsForPurposeApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAllRestrictionsForPurposeApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsGetError = + getAllRestrictionsForPurposeApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsGetErrors[keyof getAllRestrictionsForPurposeApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsGetErrors]; + +export type getAllRestrictionsForPurposeApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsGetResponses = + { + /** + * Successful Response + */ + 200: Page_TCFPublisherRestrictionResponse_; + }; + +export type getAllRestrictionsForPurposeApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsGetResponse = + getAllRestrictionsForPurposeApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsGetResponses[keyof getAllRestrictionsForPurposeApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsGetResponses]; + +export type createTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsPostData = + { + body: TCFPublisherRestrictionRequest; + path: { + /** + * Configuration Id + */ + configuration_id: string; + }; + query?: never; + url: "/api/v1/plus/tcf/configurations/{configuration_id}/publisher_restrictions"; + }; + +export type createTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsPostError = + createTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsPostErrors[keyof createTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsPostErrors]; + +export type createTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsPostResponses = + { + /** + * Successful Response + */ + 201: fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRestrictionResponse; + }; + +export type createTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsPostResponse = + createTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsPostResponses[keyof createTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsPostResponses]; + +export type deleteTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdDeleteData = + { + body?: never; + path: { + /** + * Restriction Id + */ + restriction_id: string; + /** + * Configuration Id + */ + configuration_id: string; + }; + query?: never; + url: "/api/v1/plus/tcf/configurations/{configuration_id}/publisher_restrictions/{restriction_id}"; + }; + +export type deleteTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdDeleteError = + deleteTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdDeleteErrors[keyof deleteTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdDeleteErrors]; + +export type deleteTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deleteTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdDeleteResponse = + deleteTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdDeleteResponses[keyof deleteTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdDeleteResponses]; + +export type getTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdGetData = + { + body?: never; + path: { + /** + * Restriction Id + */ + restriction_id: string; + /** + * Configuration Id + */ + configuration_id: string; + }; + query?: never; + url: "/api/v1/plus/tcf/configurations/{configuration_id}/publisher_restrictions/{restriction_id}"; + }; + +export type getTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdGetError = + getTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdGetErrors[keyof getTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdGetErrors]; + +export type getTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdGetResponses = + { + /** + * Successful Response + */ + 200: fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRestrictionResponse; + }; + +export type getTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdGetResponse = + getTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdGetResponses[keyof getTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdGetResponses]; + +export type updateTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdPatchData = + { + body: TCFPublisherRestrictionUpdateRequest; + path: { + /** + * Restriction Id + */ + restriction_id: string; + /** + * Configuration Id + */ + configuration_id: string; + }; + query?: never; + url: "/api/v1/plus/tcf/configurations/{configuration_id}/publisher_restrictions/{restriction_id}"; + }; + +export type updateTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdPatchError = + updateTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdPatchErrors[keyof updateTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdPatchErrors]; + +export type updateTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdPatchResponses = + { + /** + * Successful Response + */ + 200: fidesplus__api__schemas__tcf_publisher_restrictions__TCFPublisherRestrictionResponse; + }; + +export type updateTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdPatchResponse = + updateTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdPatchResponses[keyof updateTcfPublisherRestrictionApiV1PlusTcfConfigurationsConfigurationIdPublisherRestrictionsRestrictionIdPatchResponses]; + +export type getWebsiteMonitorResourcesFilterValuesApiV1PlusFiltersWebsiteMonitorResourcesGetData = + { + body?: never; + path?: never; + query: { + /** + * Monitor Config Id + */ + monitor_config_id: string; + /** + * Resource Type + */ + resource_type?: Array | null; + /** + * Locations + */ + locations?: Array | null; + /** + * Consent Aggregated + */ + consent_aggregated?: Array | null; + /** + * Data Uses + */ + data_uses?: Array | null; + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Child Diff Status + */ + child_diff_status?: Array | null; + /** + * Search + */ + search?: string | null; + /** + * Resolved System Id + */ + resolved_system_id?: string | null; + }; + url: "/api/v1/plus/filters/website_monitor_resources"; + }; + +export type getWebsiteMonitorResourcesFilterValuesApiV1PlusFiltersWebsiteMonitorResourcesGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getWebsiteMonitorResourcesFilterValuesApiV1PlusFiltersWebsiteMonitorResourcesGetError = + getWebsiteMonitorResourcesFilterValuesApiV1PlusFiltersWebsiteMonitorResourcesGetErrors[keyof getWebsiteMonitorResourcesFilterValuesApiV1PlusFiltersWebsiteMonitorResourcesGetErrors]; + +export type getWebsiteMonitorResourcesFilterValuesApiV1PlusFiltersWebsiteMonitorResourcesGetResponses = + { + /** + * Successful Response + */ + 200: WebsiteMonitorResourcesFilters; + }; + +export type getWebsiteMonitorResourcesFilterValuesApiV1PlusFiltersWebsiteMonitorResourcesGetResponse = + getWebsiteMonitorResourcesFilterValuesApiV1PlusFiltersWebsiteMonitorResourcesGetResponses[keyof getWebsiteMonitorResourcesFilterValuesApiV1PlusFiltersWebsiteMonitorResourcesGetResponses]; + +export type getDatastoreMonitorResourcesFilterValuesApiV1PlusFiltersDatastoreMonitorResourcesGetData = + { + body?: never; + path?: never; + query: { + /** + * Monitor Config Id + */ + monitor_config_id: string; + /** + * Staged Resource Urn + */ + staged_resource_urn?: Array | null; + /** + * Search + */ + search?: string | null; + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Data Category + */ + data_category?: Array | null; + /** + * Confidence Bucket + */ + confidence_bucket?: Array | null; + }; + url: "/api/v1/plus/filters/datastore_monitor_resources"; + }; + +export type getDatastoreMonitorResourcesFilterValuesApiV1PlusFiltersDatastoreMonitorResourcesGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getDatastoreMonitorResourcesFilterValuesApiV1PlusFiltersDatastoreMonitorResourcesGetError = + getDatastoreMonitorResourcesFilterValuesApiV1PlusFiltersDatastoreMonitorResourcesGetErrors[keyof getDatastoreMonitorResourcesFilterValuesApiV1PlusFiltersDatastoreMonitorResourcesGetErrors]; + +export type getDatastoreMonitorResourcesFilterValuesApiV1PlusFiltersDatastoreMonitorResourcesGetResponses = + { + /** + * Successful Response + */ + 200: DatastoreMonitorResourcesDynamicFilters; + }; + +export type getDatastoreMonitorResourcesFilterValuesApiV1PlusFiltersDatastoreMonitorResourcesGetResponse = + getDatastoreMonitorResourcesFilterValuesApiV1PlusFiltersDatastoreMonitorResourcesGetResponses[keyof getDatastoreMonitorResourcesFilterValuesApiV1PlusFiltersDatastoreMonitorResourcesGetResponses]; + +export type getIdpMonitorResourcesFilterValuesApiV1PlusFiltersIdpMonitorResourcesGetData = + { + body?: never; + path?: never; + query: { + /** + * Monitor Config Id + */ + monitor_config_id: string; + /** + * Search + */ + search?: string | null; + /** + * Diff Status + */ + diff_status?: Array | null; + /** + * Vendor Id + */ + vendor_id?: Array | null; + /** + * Data Uses + */ + data_uses?: Array | null; + }; + url: "/api/v1/plus/filters/idp_monitor_resources"; + }; + +export type getIdpMonitorResourcesFilterValuesApiV1PlusFiltersIdpMonitorResourcesGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getIdpMonitorResourcesFilterValuesApiV1PlusFiltersIdpMonitorResourcesGetError = + getIdpMonitorResourcesFilterValuesApiV1PlusFiltersIdpMonitorResourcesGetErrors[keyof getIdpMonitorResourcesFilterValuesApiV1PlusFiltersIdpMonitorResourcesGetErrors]; + +export type getIdpMonitorResourcesFilterValuesApiV1PlusFiltersIdpMonitorResourcesGetResponses = + { + /** + * Successful Response + */ + 200: IDPMonitorResourcesDynamicFilters; + }; + +export type getIdpMonitorResourcesFilterValuesApiV1PlusFiltersIdpMonitorResourcesGetResponse = + getIdpMonitorResourcesFilterValuesApiV1PlusFiltersIdpMonitorResourcesGetResponses[keyof getIdpMonitorResourcesFilterValuesApiV1PlusFiltersIdpMonitorResourcesGetResponses]; + +export type getSystemVendorsApiV1PlusDictionarySystemVendorsGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/dictionary/system-vendors"; +}; + +export type getSystemVendorsApiV1PlusDictionarySystemVendorsGetResponses = { + /** + * Response Get System Vendors Api V1 Plus Dictionary System Vendors Get + * + * Successful Response + */ + 200: Array<{ + [key: string]: boolean | string; + }>; +}; + +export type getSystemVendorsApiV1PlusDictionarySystemVendorsGetResponse = + getSystemVendorsApiV1PlusDictionarySystemVendorsGetResponses[keyof getSystemVendorsApiV1PlusDictionarySystemVendorsGetResponses]; + +export type postSystemVendorsApiV1PlusDictionarySystemVendorsPostData = { + body: VendorIds; + path?: never; + query?: never; + url: "/api/v1/plus/dictionary/system-vendors"; +}; + +export type postSystemVendorsApiV1PlusDictionarySystemVendorsPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type postSystemVendorsApiV1PlusDictionarySystemVendorsPostError = + postSystemVendorsApiV1PlusDictionarySystemVendorsPostErrors[keyof postSystemVendorsApiV1PlusDictionarySystemVendorsPostErrors]; + +export type postSystemVendorsApiV1PlusDictionarySystemVendorsPostResponses = { + /** + * Response Post System Vendors Api V1 Plus Dictionary System Vendors Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type postSystemVendorsApiV1PlusDictionarySystemVendorsPostResponse = + postSystemVendorsApiV1PlusDictionarySystemVendorsPostResponses[keyof postSystemVendorsApiV1PlusDictionarySystemVendorsPostResponses]; + +export type createCookieAssetsBySystemKeysApiV1PlusDictionarySystemVendorsCookieAssetsPostData = + { + /** + * System Keys + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/plus/dictionary/system-vendors/cookie-assets"; + }; + +export type createCookieAssetsBySystemKeysApiV1PlusDictionarySystemVendorsCookieAssetsPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createCookieAssetsBySystemKeysApiV1PlusDictionarySystemVendorsCookieAssetsPostError = + createCookieAssetsBySystemKeysApiV1PlusDictionarySystemVendorsCookieAssetsPostErrors[keyof createCookieAssetsBySystemKeysApiV1PlusDictionarySystemVendorsCookieAssetsPostErrors]; + +export type createCookieAssetsBySystemKeysApiV1PlusDictionarySystemVendorsCookieAssetsPostResponses = + { + /** + * Response Create Cookie Assets By System Keys Api V1 Plus Dictionary System Vendors Cookie Assets Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; + }; + +export type createCookieAssetsBySystemKeysApiV1PlusDictionarySystemVendorsCookieAssetsPostResponse = + createCookieAssetsBySystemKeysApiV1PlusDictionarySystemVendorsCookieAssetsPostResponses[keyof createCookieAssetsBySystemKeysApiV1PlusDictionarySystemVendorsCookieAssetsPostResponses]; + +export type reloadCompassCacheApiV1PlusDictionaryReloadCachePostData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/dictionary/reload-cache"; +}; + +export type reloadCompassCacheApiV1PlusDictionaryReloadCachePostResponses = { + /** + * Response Reload Compass Cache Api V1 Plus Dictionary Reload Cache Post + * + * Successful Response + */ + 200: { + [key: string]: string; + }; +}; + +export type reloadCompassCacheApiV1PlusDictionaryReloadCachePostResponse = + reloadCompassCacheApiV1PlusDictionaryReloadCachePostResponses[keyof reloadCompassCacheApiV1PlusDictionaryReloadCachePostResponses]; + +export type triggerCompassSystemSyncApiV1PlusDictionaryCompassGvlSystemSyncPostData = + { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/dictionary/compass-gvl-system-sync"; + }; + +export type triggerCompassSystemSyncApiV1PlusDictionaryCompassGvlSystemSyncPostResponses = + { + /** + * Response Trigger Compass System Sync Api V1 Plus Dictionary Compass Gvl System Sync Post + * + * Successful Response + */ + 200: { + [key: string]: string; + }; + }; + +export type triggerCompassSystemSyncApiV1PlusDictionaryCompassGvlSystemSyncPostResponse = + triggerCompassSystemSyncApiV1PlusDictionaryCompassGvlSystemSyncPostResponses[keyof triggerCompassSystemSyncApiV1PlusDictionaryCompassGvlSystemSyncPostResponses]; + +export type getTaxonomyHistoryApiV1PlusTaxonomiesTaxonomyTypeHistoryGetData = { + body?: never; + path: { + /** + * Taxonomy Type + */ + taxonomy_type: string; + }; + query?: { + /** + * Event Type + * + * Filter by event type(s) + */ + event_type?: Array | null; + /** + * Status + * + * Filter by status + */ + status?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/taxonomies/{taxonomy_type}/history"; +}; + +export type getTaxonomyHistoryApiV1PlusTaxonomiesTaxonomyTypeHistoryGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getTaxonomyHistoryApiV1PlusTaxonomiesTaxonomyTypeHistoryGetError = + getTaxonomyHistoryApiV1PlusTaxonomiesTaxonomyTypeHistoryGetErrors[keyof getTaxonomyHistoryApiV1PlusTaxonomiesTaxonomyTypeHistoryGetErrors]; + +export type getTaxonomyHistoryApiV1PlusTaxonomiesTaxonomyTypeHistoryGetResponses = + { + /** + * Successful Response + */ + 200: Page_EventAuditResponse_; + }; + +export type getTaxonomyHistoryApiV1PlusTaxonomiesTaxonomyTypeHistoryGetResponse = + getTaxonomyHistoryApiV1PlusTaxonomiesTaxonomyTypeHistoryGetResponses[keyof getTaxonomyHistoryApiV1PlusTaxonomiesTaxonomyTypeHistoryGetResponses]; + +export type getDefaultPolicyConfigEndpointApiV1PlusDsrPolicyDefaultGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/dsr/policy/default"; +}; + +export type getDefaultPolicyConfigEndpointApiV1PlusDsrPolicyDefaultGetResponses = + { + /** + * Successful Response + */ + 200: DefaultPolicyConfigResponse; + }; + +export type getDefaultPolicyConfigEndpointApiV1PlusDsrPolicyDefaultGetResponse = + getDefaultPolicyConfigEndpointApiV1PlusDsrPolicyDefaultGetResponses[keyof getDefaultPolicyConfigEndpointApiV1PlusDsrPolicyDefaultGetResponses]; + +export type setDefaultPolicyConfigApiV1PlusDsrPolicyDefaultPutData = { + body: DefaultPolicyConfigRequest; + path?: never; + query?: never; + url: "/api/v1/plus/dsr/policy/default"; +}; + +export type setDefaultPolicyConfigApiV1PlusDsrPolicyDefaultPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type setDefaultPolicyConfigApiV1PlusDsrPolicyDefaultPutError = + setDefaultPolicyConfigApiV1PlusDsrPolicyDefaultPutErrors[keyof setDefaultPolicyConfigApiV1PlusDsrPolicyDefaultPutErrors]; + +export type setDefaultPolicyConfigApiV1PlusDsrPolicyDefaultPutResponses = { + /** + * Successful Response + */ + 200: DefaultPolicyConfigResponse; +}; + +export type setDefaultPolicyConfigApiV1PlusDsrPolicyDefaultPutResponse = + setDefaultPolicyConfigApiV1PlusDsrPolicyDefaultPutResponses[keyof setDefaultPolicyConfigApiV1PlusDsrPolicyDefaultPutResponses]; + +export type getPolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsGetData = { + body?: never; + path: { + /** + * Policy Key + */ + policy_key: string; + }; + query?: never; + url: "/api/v1/plus/dsr/policy/{policy_key}/conditions"; +}; + +export type getPolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getPolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsGetError = + getPolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsGetErrors[keyof getPolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsGetErrors]; + +export type getPolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsGetResponses = + { + /** + * Successful Response + */ + 200: PolicyConditionResponse; + }; + +export type getPolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsGetResponse = + getPolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsGetResponses[keyof getPolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsGetResponses]; + +export type replacePolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsPutData = + { + body: PolicyConditionRequest; + path: { + /** + * Policy Key + */ + policy_key: string; + }; + query?: never; + url: "/api/v1/plus/dsr/policy/{policy_key}/conditions"; + }; + +export type replacePolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type replacePolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsPutError = + replacePolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsPutErrors[keyof replacePolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsPutErrors]; + +export type replacePolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsPutResponses = + { + /** + * Successful Response + */ + 200: PolicyConditionResponse; + }; + +export type replacePolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsPutResponse = + replacePolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsPutResponses[keyof replacePolicyConditionsApiV1PlusDsrPolicyPolicyKeyConditionsPutResponses]; + +export type getPrivacyAssessmentConfigApiV1PlusPrivacyAssessmentsConfigGetData = + { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/privacy-assessments/config"; + }; + +export type getPrivacyAssessmentConfigApiV1PlusPrivacyAssessmentsConfigGetResponses = + { + /** + * Successful Response + */ + 200: PrivacyAssessmentConfigResponse; + }; + +export type getPrivacyAssessmentConfigApiV1PlusPrivacyAssessmentsConfigGetResponse = + getPrivacyAssessmentConfigApiV1PlusPrivacyAssessmentsConfigGetResponses[keyof getPrivacyAssessmentConfigApiV1PlusPrivacyAssessmentsConfigGetResponses]; + +export type updatePrivacyAssessmentConfigApiV1PlusPrivacyAssessmentsConfigPutData = + { + body: PrivacyAssessmentConfigUpdate; + path?: never; + query?: never; + url: "/api/v1/plus/privacy-assessments/config"; + }; + +export type updatePrivacyAssessmentConfigApiV1PlusPrivacyAssessmentsConfigPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updatePrivacyAssessmentConfigApiV1PlusPrivacyAssessmentsConfigPutError = + updatePrivacyAssessmentConfigApiV1PlusPrivacyAssessmentsConfigPutErrors[keyof updatePrivacyAssessmentConfigApiV1PlusPrivacyAssessmentsConfigPutErrors]; + +export type updatePrivacyAssessmentConfigApiV1PlusPrivacyAssessmentsConfigPutResponses = + { + /** + * Successful Response + */ + 200: PrivacyAssessmentConfigResponse; + }; + +export type updatePrivacyAssessmentConfigApiV1PlusPrivacyAssessmentsConfigPutResponse = + updatePrivacyAssessmentConfigApiV1PlusPrivacyAssessmentsConfigPutResponses[keyof updatePrivacyAssessmentConfigApiV1PlusPrivacyAssessmentsConfigPutResponses]; + +export type getPrivacyAssessmentConfigDefaultsApiV1PlusPrivacyAssessmentsConfigDefaultsGetData = + { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/privacy-assessments/config/defaults"; + }; + +export type getPrivacyAssessmentConfigDefaultsApiV1PlusPrivacyAssessmentsConfigDefaultsGetResponses = + { + /** + * Successful Response + */ + 200: PrivacyAssessmentConfigDefaults; + }; + +export type getPrivacyAssessmentConfigDefaultsApiV1PlusPrivacyAssessmentsConfigDefaultsGetResponse = + getPrivacyAssessmentConfigDefaultsApiV1PlusPrivacyAssessmentsConfigDefaultsGetResponses[keyof getPrivacyAssessmentConfigDefaultsApiV1PlusPrivacyAssessmentsConfigDefaultsGetResponses]; + +export type listTemplatesApiV1PlusPrivacyAssessmentsTemplatesGetData = { + body?: never; + path?: never; + query?: { + /** + * Active Only + */ + active_only?: boolean; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/privacy-assessments/templates"; +}; + +export type listTemplatesApiV1PlusPrivacyAssessmentsTemplatesGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type listTemplatesApiV1PlusPrivacyAssessmentsTemplatesGetError = + listTemplatesApiV1PlusPrivacyAssessmentsTemplatesGetErrors[keyof listTemplatesApiV1PlusPrivacyAssessmentsTemplatesGetErrors]; + +export type listTemplatesApiV1PlusPrivacyAssessmentsTemplatesGetResponses = { + /** + * Successful Response + */ + 200: Page_TemplateResponse_; +}; + +export type listTemplatesApiV1PlusPrivacyAssessmentsTemplatesGetResponse = + listTemplatesApiV1PlusPrivacyAssessmentsTemplatesGetResponses[keyof listTemplatesApiV1PlusPrivacyAssessmentsTemplatesGetResponses]; + +export type getTemplateApiV1PlusPrivacyAssessmentsTemplatesTemplateIdGetData = { + body?: never; + path: { + /** + * Template Id + */ + template_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-assessments/templates/{template_id}"; +}; + +export type getTemplateApiV1PlusPrivacyAssessmentsTemplatesTemplateIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getTemplateApiV1PlusPrivacyAssessmentsTemplatesTemplateIdGetError = + getTemplateApiV1PlusPrivacyAssessmentsTemplatesTemplateIdGetErrors[keyof getTemplateApiV1PlusPrivacyAssessmentsTemplatesTemplateIdGetErrors]; + +export type getTemplateApiV1PlusPrivacyAssessmentsTemplatesTemplateIdGetResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireToneGetData = + { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/privacy-assessments/questionnaire/tone"; + }; + +export type getQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireToneGetResponses = + { + /** + * Successful Response + */ + 200: ToneResponse; + }; + +export type getQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireToneGetResponse = + getQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireToneGetResponses[keyof getQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireToneGetResponses]; + +export type updateQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireTonePutData = + { + body: ToneUpdate; + path?: never; + query?: never; + url: "/api/v1/plus/privacy-assessments/questionnaire/tone"; + }; + +export type updateQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireTonePutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireTonePutError = + updateQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireTonePutErrors[keyof updateQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireTonePutErrors]; + +export type updateQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireTonePutResponses = + { + /** + * Successful Response + */ + 200: ToneResponse; + }; + +export type updateQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireTonePutResponse = + updateQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireTonePutResponses[keyof updateQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireTonePutResponses]; + +export type resetQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireToneResetPostData = + { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/privacy-assessments/questionnaire/tone/reset"; + }; + +export type resetQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireToneResetPostResponses = + { + /** + * Successful Response + */ + 200: ToneResponse; + }; + +export type resetQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireToneResetPostResponse = + resetQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireToneResetPostResponses[keyof resetQuestionnaireToneApiV1PlusPrivacyAssessmentsQuestionnaireToneResetPostResponses]; + +export type listAssessmentsApiV1PlusPrivacyAssessmentsGetData = { + body?: never; + path?: never; + query?: { + /** + * Status + */ + status?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/privacy-assessments"; +}; + +export type listAssessmentsApiV1PlusPrivacyAssessmentsGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type listAssessmentsApiV1PlusPrivacyAssessmentsGetError = + listAssessmentsApiV1PlusPrivacyAssessmentsGetErrors[keyof listAssessmentsApiV1PlusPrivacyAssessmentsGetErrors]; + +export type listAssessmentsApiV1PlusPrivacyAssessmentsGetResponses = { + /** + * Successful Response + */ + 200: Page_AssessmentResponse_; +}; + +export type listAssessmentsApiV1PlusPrivacyAssessmentsGetResponse = + listAssessmentsApiV1PlusPrivacyAssessmentsGetResponses[keyof listAssessmentsApiV1PlusPrivacyAssessmentsGetResponses]; + +export type createAssessmentApiV1PlusPrivacyAssessmentsPostData = { + body: CreateAssessmentTaskRequest; + path?: never; + query?: never; + url: "/api/v1/plus/privacy-assessments"; +}; + +export type createAssessmentApiV1PlusPrivacyAssessmentsPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createAssessmentApiV1PlusPrivacyAssessmentsPostError = + createAssessmentApiV1PlusPrivacyAssessmentsPostErrors[keyof createAssessmentApiV1PlusPrivacyAssessmentsPostErrors]; + +export type createAssessmentApiV1PlusPrivacyAssessmentsPostResponses = { + /** + * Successful Response + */ + 202: CreateAssessmentTaskResponse; +}; + +export type createAssessmentApiV1PlusPrivacyAssessmentsPostResponse = + createAssessmentApiV1PlusPrivacyAssessmentsPostResponses[keyof createAssessmentApiV1PlusPrivacyAssessmentsPostResponses]; + +export type listTasksApiV1PlusPrivacyAssessmentsTasksGetData = { + body?: never; + path?: never; + query?: { + /** + * Status + */ + status?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/privacy-assessments/tasks"; +}; + +export type listTasksApiV1PlusPrivacyAssessmentsTasksGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type listTasksApiV1PlusPrivacyAssessmentsTasksGetError = + listTasksApiV1PlusPrivacyAssessmentsTasksGetErrors[keyof listTasksApiV1PlusPrivacyAssessmentsTasksGetErrors]; + +export type listTasksApiV1PlusPrivacyAssessmentsTasksGetResponses = { + /** + * Successful Response + */ + 200: Page_AssessmentTaskResponse_; +}; + +export type listTasksApiV1PlusPrivacyAssessmentsTasksGetResponse = + listTasksApiV1PlusPrivacyAssessmentsTasksGetResponses[keyof listTasksApiV1PlusPrivacyAssessmentsTasksGetResponses]; + +export type getTaskApiV1PlusPrivacyAssessmentsTasksTaskIdGetData = { + body?: never; + path: { + /** + * Task Id + */ + task_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-assessments/tasks/{task_id}"; +}; + +export type getTaskApiV1PlusPrivacyAssessmentsTasksTaskIdGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getTaskApiV1PlusPrivacyAssessmentsTasksTaskIdGetError = + getTaskApiV1PlusPrivacyAssessmentsTasksTaskIdGetErrors[keyof getTaskApiV1PlusPrivacyAssessmentsTasksTaskIdGetErrors]; + +export type getTaskApiV1PlusPrivacyAssessmentsTasksTaskIdGetResponses = { + /** + * Successful Response + */ + 200: AssessmentTaskResponse; +}; + +export type getTaskApiV1PlusPrivacyAssessmentsTasksTaskIdGetResponse = + getTaskApiV1PlusPrivacyAssessmentsTasksTaskIdGetResponses[keyof getTaskApiV1PlusPrivacyAssessmentsTasksTaskIdGetResponses]; + +export type retryTaskApiV1PlusPrivacyAssessmentsTasksTaskIdRetryPostData = { + body?: never; + path: { + /** + * Task Id + */ + task_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-assessments/tasks/{task_id}/retry"; +}; + +export type retryTaskApiV1PlusPrivacyAssessmentsTasksTaskIdRetryPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type retryTaskApiV1PlusPrivacyAssessmentsTasksTaskIdRetryPostError = + retryTaskApiV1PlusPrivacyAssessmentsTasksTaskIdRetryPostErrors[keyof retryTaskApiV1PlusPrivacyAssessmentsTasksTaskIdRetryPostErrors]; + +export type retryTaskApiV1PlusPrivacyAssessmentsTasksTaskIdRetryPostResponses = + { + /** + * Successful Response + */ + 202: CreateAssessmentTaskResponse; + }; + +export type retryTaskApiV1PlusPrivacyAssessmentsTasksTaskIdRetryPostResponse = + retryTaskApiV1PlusPrivacyAssessmentsTasksTaskIdRetryPostResponses[keyof retryTaskApiV1PlusPrivacyAssessmentsTasksTaskIdRetryPostResponses]; + +export type deleteAssessmentApiV1PlusPrivacyAssessmentsAssessmentIdDeleteData = + { + body?: never; + path: { + /** + * Assessment Id + */ + assessment_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-assessments/{assessment_id}"; + }; + +export type deleteAssessmentApiV1PlusPrivacyAssessmentsAssessmentIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteAssessmentApiV1PlusPrivacyAssessmentsAssessmentIdDeleteError = + deleteAssessmentApiV1PlusPrivacyAssessmentsAssessmentIdDeleteErrors[keyof deleteAssessmentApiV1PlusPrivacyAssessmentsAssessmentIdDeleteErrors]; + +export type deleteAssessmentApiV1PlusPrivacyAssessmentsAssessmentIdDeleteResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getAssessmentApiV1PlusPrivacyAssessmentsAssessmentIdGetData = { + body?: never; + path: { + /** + * Assessment Id + */ + assessment_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-assessments/{assessment_id}"; +}; + +export type getAssessmentApiV1PlusPrivacyAssessmentsAssessmentIdGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getAssessmentApiV1PlusPrivacyAssessmentsAssessmentIdGetError = + getAssessmentApiV1PlusPrivacyAssessmentsAssessmentIdGetErrors[keyof getAssessmentApiV1PlusPrivacyAssessmentsAssessmentIdGetErrors]; + +export type getAssessmentApiV1PlusPrivacyAssessmentsAssessmentIdGetResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type getAssessmentEvidenceApiV1PlusPrivacyAssessmentsAssessmentIdQuestionGroupsQuestionGroupIdEvidenceGetData = + { + body?: never; + path: { + /** + * Assessment Id + */ + assessment_id: string; + /** + * Question Group Id + */ + question_group_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-assessments/{assessment_id}/question-groups/{question_group_id}/evidence"; + }; + +export type getAssessmentEvidenceApiV1PlusPrivacyAssessmentsAssessmentIdQuestionGroupsQuestionGroupIdEvidenceGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAssessmentEvidenceApiV1PlusPrivacyAssessmentsAssessmentIdQuestionGroupsQuestionGroupIdEvidenceGetError = + getAssessmentEvidenceApiV1PlusPrivacyAssessmentsAssessmentIdQuestionGroupsQuestionGroupIdEvidenceGetErrors[keyof getAssessmentEvidenceApiV1PlusPrivacyAssessmentsAssessmentIdQuestionGroupsQuestionGroupIdEvidenceGetErrors]; + +export type getAssessmentEvidenceApiV1PlusPrivacyAssessmentsAssessmentIdQuestionGroupsQuestionGroupIdEvidenceGetResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type updateAnswerApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdPutData = + { + body: UpdateAnswerRequest; + path: { + /** + * Assessment Id + */ + assessment_id: string; + /** + * Question Id + */ + question_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-assessments/{assessment_id}/questions/{question_id}"; + }; + +export type updateAnswerApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateAnswerApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdPutError = + updateAnswerApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdPutErrors[keyof updateAnswerApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdPutErrors]; + +export type updateAnswerApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdPutResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getAnswerHistoryApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdHistoryGetData = + { + body?: never; + path: { + /** + * Assessment Id + */ + assessment_id: string; + /** + * Question Id + */ + question_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-assessments/{assessment_id}/questions/{question_id}/history"; + }; + +export type getAnswerHistoryApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdHistoryGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAnswerHistoryApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdHistoryGetError = + getAnswerHistoryApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdHistoryGetErrors[keyof getAnswerHistoryApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdHistoryGetErrors]; + +export type getAnswerHistoryApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdHistoryGetResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type revertAnswerApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdRevertPostData = + { + body: RevertAnswerRequest; + path: { + /** + * Assessment Id + */ + assessment_id: string; + /** + * Question Id + */ + question_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-assessments/{assessment_id}/questions/{question_id}/revert"; + }; + +export type revertAnswerApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdRevertPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type revertAnswerApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdRevertPostError = + revertAnswerApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdRevertPostErrors[keyof revertAnswerApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdRevertPostErrors]; + +export type revertAnswerApiV1PlusPrivacyAssessmentsAssessmentIdQuestionsQuestionIdRevertPostResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getAuditLogApiV1PlusPrivacyAssessmentsAssessmentIdAuditLogGetData = + { + body?: never; + path: { + /** + * Assessment Id + */ + assessment_id: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/plus/privacy-assessments/{assessment_id}/audit-log"; + }; + +export type getAuditLogApiV1PlusPrivacyAssessmentsAssessmentIdAuditLogGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getAuditLogApiV1PlusPrivacyAssessmentsAssessmentIdAuditLogGetError = + getAuditLogApiV1PlusPrivacyAssessmentsAssessmentIdAuditLogGetErrors[keyof getAuditLogApiV1PlusPrivacyAssessmentsAssessmentIdAuditLogGetErrors]; + +export type getAuditLogApiV1PlusPrivacyAssessmentsAssessmentIdAuditLogGetResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type getQuestionnaireStatusApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireGetData = + { + body?: never; + path: { + /** + * Assessment Id + */ + assessment_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-assessments/{assessment_id}/questionnaire"; + }; + +export type getQuestionnaireStatusApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getQuestionnaireStatusApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireGetError = + getQuestionnaireStatusApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireGetErrors[keyof getQuestionnaireStatusApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireGetErrors]; + +export type getQuestionnaireStatusApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireGetResponses = + { + /** + * Successful Response + */ + 200: QuestionnaireStatusResponse; + }; + +export type getQuestionnaireStatusApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireGetResponse = + getQuestionnaireStatusApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireGetResponses[keyof getQuestionnaireStatusApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireGetResponses]; + +export type sendQuestionnaireApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnairePostData = + { + body: SendQuestionnaireRequest; + path: { + /** + * Assessment Id + */ + assessment_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-assessments/{assessment_id}/questionnaire"; + }; + +export type sendQuestionnaireApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnairePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type sendQuestionnaireApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnairePostError = + sendQuestionnaireApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnairePostErrors[keyof sendQuestionnaireApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnairePostErrors]; + +export type sendQuestionnaireApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnairePostResponses = + { + /** + * Successful Response + */ + 201: SendQuestionnaireResponse; + }; + +export type sendQuestionnaireApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnairePostResponse = + sendQuestionnaireApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnairePostResponses[keyof sendQuestionnaireApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnairePostResponses]; + +export type sendQuestionnaireReminderApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireRemindersPostData = + { + body?: SendReminderRequest; + path: { + /** + * Assessment Id + */ + assessment_id: string; + }; + query?: never; + url: "/api/v1/plus/privacy-assessments/{assessment_id}/questionnaire/reminders"; + }; + +export type sendQuestionnaireReminderApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireRemindersPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type sendQuestionnaireReminderApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireRemindersPostError = + sendQuestionnaireReminderApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireRemindersPostErrors[keyof sendQuestionnaireReminderApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireRemindersPostErrors]; + +export type sendQuestionnaireReminderApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireRemindersPostResponses = + { + /** + * Successful Response + */ + 201: SendReminderResponse; + }; + +export type sendQuestionnaireReminderApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireRemindersPostResponse = + sendQuestionnaireReminderApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireRemindersPostResponses[keyof sendQuestionnaireReminderApiV1PlusPrivacyAssessmentsAssessmentIdQuestionnaireRemindersPostResponses]; + +export type downloadAssessmentPdfApiV1PlusPrivacyAssessmentsAssessmentIdPdfGetData = + { + body?: never; + path: { + /** + * Assessment Id + */ + assessment_id: string; + }; + query?: { + /** + * Export Mode + * + * Export mode: 'internal' includes all details (status, risk, evidence); 'external' includes only questions and answers for signing + */ + export_mode?: "internal" | "external"; + }; + url: "/api/v1/plus/privacy-assessments/{assessment_id}/pdf"; + }; + +export type downloadAssessmentPdfApiV1PlusPrivacyAssessmentsAssessmentIdPdfGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type downloadAssessmentPdfApiV1PlusPrivacyAssessmentsAssessmentIdPdfGetError = + downloadAssessmentPdfApiV1PlusPrivacyAssessmentsAssessmentIdPdfGetErrors[keyof downloadAssessmentPdfApiV1PlusPrivacyAssessmentsAssessmentIdPdfGetErrors]; + +export type downloadAssessmentPdfApiV1PlusPrivacyAssessmentsAssessmentIdPdfGetResponses = + { + /** + * Successful Response + */ + 200: unknown; + }; + +export type triggerSeedApiV1PlusSeedPostData = { + body: SeedRequest; + path?: never; + query?: never; + url: "/api/v1/plus/seed"; +}; + +export type triggerSeedApiV1PlusSeedPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type triggerSeedApiV1PlusSeedPostError = + triggerSeedApiV1PlusSeedPostErrors[keyof triggerSeedApiV1PlusSeedPostErrors]; + +export type triggerSeedApiV1PlusSeedPostResponses = { + /** + * Successful Response + */ + 202: SeedResponse; +}; + +export type triggerSeedApiV1PlusSeedPostResponse = + triggerSeedApiV1PlusSeedPostResponses[keyof triggerSeedApiV1PlusSeedPostResponses]; + +export type getSeedStatusApiV1PlusSeedStatusExecutionIdGetData = { + body?: never; + path: { + /** + * Execution Id + */ + execution_id: string; + }; + query?: never; + url: "/api/v1/plus/seed/status/{execution_id}"; +}; + +export type getSeedStatusApiV1PlusSeedStatusExecutionIdGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getSeedStatusApiV1PlusSeedStatusExecutionIdGetError = + getSeedStatusApiV1PlusSeedStatusExecutionIdGetErrors[keyof getSeedStatusApiV1PlusSeedStatusExecutionIdGetErrors]; + +export type getSeedStatusApiV1PlusSeedStatusExecutionIdGetResponses = { + /** + * Successful Response + */ + 200: SeedStatusResponse; +}; + +export type getSeedStatusApiV1PlusSeedStatusExecutionIdGetResponse = + getSeedStatusApiV1PlusSeedStatusExecutionIdGetResponses[keyof getSeedStatusApiV1PlusSeedStatusExecutionIdGetResponses]; + +export type getLatestSeedStatusApiV1PlusSeedStatusGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/seed/status"; +}; + +export type getLatestSeedStatusApiV1PlusSeedStatusGetResponses = { + /** + * Response Get Latest Seed Status Api V1 Plus Seed Status Get + * + * Successful Response + */ + 200: SeedStatusResponse | null; +}; + +export type getLatestSeedStatusApiV1PlusSeedStatusGetResponse = + getLatestSeedStatusApiV1PlusSeedStatusGetResponses[keyof getLatestSeedStatusApiV1PlusSeedStatusGetResponses]; + +export type generateTestStagedResourcesApiV1PlusDiscoveryMonitorDevMonitorConfigKeyGenerateTestDataPostData = + { + body: GenerateTestDataRequest; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/dev/{monitor_config_key}/generate-test-data"; + }; + +export type generateTestStagedResourcesApiV1PlusDiscoveryMonitorDevMonitorConfigKeyGenerateTestDataPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type generateTestStagedResourcesApiV1PlusDiscoveryMonitorDevMonitorConfigKeyGenerateTestDataPostError = + generateTestStagedResourcesApiV1PlusDiscoveryMonitorDevMonitorConfigKeyGenerateTestDataPostErrors[keyof generateTestStagedResourcesApiV1PlusDiscoveryMonitorDevMonitorConfigKeyGenerateTestDataPostErrors]; + +export type generateTestStagedResourcesApiV1PlusDiscoveryMonitorDevMonitorConfigKeyGenerateTestDataPostResponses = + { + /** + * Response Generate Test Staged Resources Api V1 Plus Discovery Monitor Dev Monitor Config Key Generate Test Data Post + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; + }; + +export type generateTestStagedResourcesApiV1PlusDiscoveryMonitorDevMonitorConfigKeyGenerateTestDataPostResponse = + generateTestStagedResourcesApiV1PlusDiscoveryMonitorDevMonitorConfigKeyGenerateTestDataPostResponses[keyof generateTestStagedResourcesApiV1PlusDiscoveryMonitorDevMonitorConfigKeyGenerateTestDataPostResponses]; + +export type llmChatApiV1PlusLlmChatPostData = { + body: LLMChatRequest; + path?: never; + query?: never; + url: "/api/v1/plus/llm/chat"; +}; + +export type llmChatApiV1PlusLlmChatPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type llmChatApiV1PlusLlmChatPostError = + llmChatApiV1PlusLlmChatPostErrors[keyof llmChatApiV1PlusLlmChatPostErrors]; + +export type llmChatApiV1PlusLlmChatPostResponses = { + /** + * Successful Response + */ + 200: unknown; +}; + +export type testClassifyApiV1PlusLlmClassifyPostData = { + body: LLMClassifyRequest; + path?: never; + query?: never; + url: "/api/v1/plus/llm/classify"; +}; + +export type testClassifyApiV1PlusLlmClassifyPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type testClassifyApiV1PlusLlmClassifyPostError = + testClassifyApiV1PlusLlmClassifyPostErrors[keyof testClassifyApiV1PlusLlmClassifyPostErrors]; + +export type testClassifyApiV1PlusLlmClassifyPostResponses = { + /** + * Successful Response + */ + 200: ClassifyResult; +}; + +export type testClassifyApiV1PlusLlmClassifyPostResponse = + testClassifyApiV1PlusLlmClassifyPostResponses[keyof testClassifyApiV1PlusLlmClassifyPostResponses]; + +export type classifyDryRunApiV1PlusLlmClassifyDryrunPostData = { + body: LLMClassifyRequest; + path?: never; + query?: never; + url: "/api/v1/plus/llm/classify/dryrun"; +}; + +export type classifyDryRunApiV1PlusLlmClassifyDryrunPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type classifyDryRunApiV1PlusLlmClassifyDryrunPostError = + classifyDryRunApiV1PlusLlmClassifyDryrunPostErrors[keyof classifyDryRunApiV1PlusLlmClassifyDryrunPostErrors]; + +export type classifyDryRunApiV1PlusLlmClassifyDryrunPostResponses = { + /** + * Successful Response + */ + 200: string; +}; + +export type classifyDryRunApiV1PlusLlmClassifyDryrunPostResponse = + classifyDryRunApiV1PlusLlmClassifyDryrunPostResponses[keyof classifyDryRunApiV1PlusLlmClassifyDryrunPostResponses]; + +export type listPromptsApiV1PlusPromptExplorerPromptsGetData = { + body?: never; + path?: never; + query?: { + /** + * Category + */ + category?: PromptCategory | null; + }; + url: "/api/v1/plus/prompt-explorer/prompts"; +}; + +export type listPromptsApiV1PlusPromptExplorerPromptsGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type listPromptsApiV1PlusPromptExplorerPromptsGetError = + listPromptsApiV1PlusPromptExplorerPromptsGetErrors[keyof listPromptsApiV1PlusPromptExplorerPromptsGetErrors]; + +export type listPromptsApiV1PlusPromptExplorerPromptsGetResponses = { + /** + * Response List Prompts Api V1 Plus Prompt Explorer Prompts Get + * + * Successful Response + */ + 200: Array; +}; + +export type listPromptsApiV1PlusPromptExplorerPromptsGetResponse = + listPromptsApiV1PlusPromptExplorerPromptsGetResponses[keyof listPromptsApiV1PlusPromptExplorerPromptsGetResponses]; + +export type getPromptApiV1PlusPromptExplorerPromptsPromptIdGetData = { + body?: never; + path: { + /** + * Prompt Id + */ + prompt_id: string; + }; + query?: never; + url: "/api/v1/plus/prompt-explorer/prompts/{prompt_id}"; +}; + +export type getPromptApiV1PlusPromptExplorerPromptsPromptIdGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getPromptApiV1PlusPromptExplorerPromptsPromptIdGetError = + getPromptApiV1PlusPromptExplorerPromptsPromptIdGetErrors[keyof getPromptApiV1PlusPromptExplorerPromptsPromptIdGetErrors]; + +export type getPromptApiV1PlusPromptExplorerPromptsPromptIdGetResponses = { + /** + * Successful Response + */ + 200: PromptInfo; +}; + +export type getPromptApiV1PlusPromptExplorerPromptsPromptIdGetResponse = + getPromptApiV1PlusPromptExplorerPromptsPromptIdGetResponses[keyof getPromptApiV1PlusPromptExplorerPromptsPromptIdGetResponses]; + +export type getPromptTemplateApiV1PlusPromptExplorerPromptsPromptIdTemplateGetData = + { + body?: never; + path: { + /** + * Prompt Id + */ + prompt_id: string; + }; + query?: never; + url: "/api/v1/plus/prompt-explorer/prompts/{prompt_id}/template"; + }; + +export type getPromptTemplateApiV1PlusPromptExplorerPromptsPromptIdTemplateGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getPromptTemplateApiV1PlusPromptExplorerPromptsPromptIdTemplateGetError = + getPromptTemplateApiV1PlusPromptExplorerPromptsPromptIdTemplateGetErrors[keyof getPromptTemplateApiV1PlusPromptExplorerPromptsPromptIdTemplateGetErrors]; + +export type getPromptTemplateApiV1PlusPromptExplorerPromptsPromptIdTemplateGetResponses = + { + /** + * Successful Response + */ + 200: string; + }; + +export type getPromptTemplateApiV1PlusPromptExplorerPromptsPromptIdTemplateGetResponse = + getPromptTemplateApiV1PlusPromptExplorerPromptsPromptIdTemplateGetResponses[keyof getPromptTemplateApiV1PlusPromptExplorerPromptsPromptIdTemplateGetResponses]; + +export type listDataSectionsApiV1PlusPromptExplorerDataSectionsGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/prompt-explorer/data-sections"; +}; + +export type listDataSectionsApiV1PlusPromptExplorerDataSectionsGetResponses = { + /** + * Response List Data Sections Api V1 Plus Prompt Explorer Data Sections Get + * + * Successful Response + */ + 200: Array<{ + [key: string]: string; + }>; +}; + +export type listDataSectionsApiV1PlusPromptExplorerDataSectionsGetResponse = + listDataSectionsApiV1PlusPromptExplorerDataSectionsGetResponses[keyof listDataSectionsApiV1PlusPromptExplorerDataSectionsGetResponses]; + +export type listAssessmentsApiV1PlusPromptExplorerAssessmentsGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/prompt-explorer/assessments"; +}; + +export type listAssessmentsApiV1PlusPromptExplorerAssessmentsGetResponses = { + /** + * Response List Assessments Api V1 Plus Prompt Explorer Assessments Get + * + * Successful Response + */ + 200: Array<{ + [key: string]: unknown; + }>; +}; + +export type listAssessmentsApiV1PlusPromptExplorerAssessmentsGetResponse = + listAssessmentsApiV1PlusPromptExplorerAssessmentsGetResponses[keyof listAssessmentsApiV1PlusPromptExplorerAssessmentsGetResponses]; + +export type listTemplatesApiV1PlusPromptExplorerTemplatesGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/plus/prompt-explorer/templates"; +}; + +export type listTemplatesApiV1PlusPromptExplorerTemplatesGetResponses = { + /** + * Response List Templates Api V1 Plus Prompt Explorer Templates Get + * + * Successful Response + */ + 200: Array<{ + [key: string]: unknown; + }>; +}; + +export type listTemplatesApiV1PlusPromptExplorerTemplatesGetResponse = + listTemplatesApiV1PlusPromptExplorerTemplatesGetResponses[keyof listTemplatesApiV1PlusPromptExplorerTemplatesGetResponses]; + +export type getTemplateQuestionsApiV1PlusPromptExplorerTemplatesTemplateKeyQuestionsGetData = + { + body?: never; + path: { + /** + * Template Key + */ + template_key: string; + }; + query?: never; + url: "/api/v1/plus/prompt-explorer/templates/{template_key}/questions"; + }; + +export type getTemplateQuestionsApiV1PlusPromptExplorerTemplatesTemplateKeyQuestionsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getTemplateQuestionsApiV1PlusPromptExplorerTemplatesTemplateKeyQuestionsGetError = + getTemplateQuestionsApiV1PlusPromptExplorerTemplatesTemplateKeyQuestionsGetErrors[keyof getTemplateQuestionsApiV1PlusPromptExplorerTemplatesTemplateKeyQuestionsGetErrors]; + +export type getTemplateQuestionsApiV1PlusPromptExplorerTemplatesTemplateKeyQuestionsGetResponses = + { + /** + * Response Get Template Questions Api V1 Plus Prompt Explorer Templates Template Key Questions Get + * + * Successful Response + */ + 200: Array<{ + [key: string]: unknown; + }>; + }; + +export type getTemplateQuestionsApiV1PlusPromptExplorerTemplatesTemplateKeyQuestionsGetResponse = + getTemplateQuestionsApiV1PlusPromptExplorerTemplatesTemplateKeyQuestionsGetResponses[keyof getTemplateQuestionsApiV1PlusPromptExplorerTemplatesTemplateKeyQuestionsGetResponses]; + +export type renderPromptApiV1PlusPromptExplorerRenderPostData = { + body: RenderPromptRequest; + path?: never; + query?: never; + url: "/api/v1/plus/prompt-explorer/render"; +}; + +export type renderPromptApiV1PlusPromptExplorerRenderPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type renderPromptApiV1PlusPromptExplorerRenderPostError = + renderPromptApiV1PlusPromptExplorerRenderPostErrors[keyof renderPromptApiV1PlusPromptExplorerRenderPostErrors]; + +export type renderPromptApiV1PlusPromptExplorerRenderPostResponses = { + /** + * Successful Response + */ + 200: RenderPromptResponse; +}; + +export type renderPromptApiV1PlusPromptExplorerRenderPostResponse = + renderPromptApiV1PlusPromptExplorerRenderPostResponses[keyof renderPromptApiV1PlusPromptExplorerRenderPostResponses]; + +export type executePromptApiV1PlusPromptExplorerExecutePostData = { + body: ExecutePromptRequest; + path?: never; + query?: never; + url: "/api/v1/plus/prompt-explorer/execute"; +}; + +export type executePromptApiV1PlusPromptExplorerExecutePostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type executePromptApiV1PlusPromptExplorerExecutePostError = + executePromptApiV1PlusPromptExplorerExecutePostErrors[keyof executePromptApiV1PlusPromptExplorerExecutePostErrors]; + +export type executePromptApiV1PlusPromptExplorerExecutePostResponses = { + /** + * Successful Response + */ + 200: ExecutePromptResponse; +}; + +export type executePromptApiV1PlusPromptExplorerExecutePostResponse = + executePromptApiV1PlusPromptExplorerExecutePostResponses[keyof executePromptApiV1PlusPromptExplorerExecutePostResponses]; + +export type getPrivacyExperienceMetaApiV1PrivacyExperienceMetaGetData = { + body?: never; + path?: never; + query: { + /** + * Region + */ + region: string; + /** + * Component + */ + component?: ComponentType | null; + /** + * Show Disabled + */ + show_disabled?: boolean | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/privacy-experience-meta"; +}; + +export type getPrivacyExperienceMetaApiV1PrivacyExperienceMetaGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getPrivacyExperienceMetaApiV1PrivacyExperienceMetaGetError = + getPrivacyExperienceMetaApiV1PrivacyExperienceMetaGetErrors[keyof getPrivacyExperienceMetaApiV1PrivacyExperienceMetaGetErrors]; + +export type getPrivacyExperienceMetaApiV1PrivacyExperienceMetaGetResponses = { + /** + * Successful Response + */ + 200: Page_PrivacyExperienceMetaResponse_; +}; + +export type getPrivacyExperienceMetaApiV1PrivacyExperienceMetaGetResponse = + getPrivacyExperienceMetaApiV1PrivacyExperienceMetaGetResponses[keyof getPrivacyExperienceMetaApiV1PrivacyExperienceMetaGetResponses]; + +export type privacyExperienceListApiV1PrivacyExperienceGetData = { + body?: never; + path?: never; + query: { + /** + * Show Disabled + */ + show_disabled?: boolean | null; + /** + * Region + */ + region: string; + /** + * Component + */ + component?: ComponentType | null; + /** + * Has Notices + */ + has_notices?: boolean | null; + /** + * Systems Applicable + */ + systems_applicable?: boolean | null; + /** + * Filter By Framework + */ + filter_by_framework?: boolean | null; + /** + * Include Gvl + */ + include_gvl?: boolean | null; + /** + * Include Meta + */ + include_meta?: boolean | null; + /** + * Property Id + */ + property_id?: string | null; + /** + * Exclude Gvl Languages + */ + exclude_gvl_languages?: boolean | null; + /** + * Minimal Tcf + */ + minimal_tcf?: boolean | null; + /** + * Include Non Applicable Notices + */ + include_non_applicable_notices?: boolean | null; + /** + * Exclude Notice Assets By Systems + */ + exclude_notice_assets_by_systems?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/privacy-experience"; +}; + +export type privacyExperienceListApiV1PrivacyExperienceGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type privacyExperienceListApiV1PrivacyExperienceGetError = + privacyExperienceListApiV1PrivacyExperienceGetErrors[keyof privacyExperienceListApiV1PrivacyExperienceGetErrors]; + +export type privacyExperienceListApiV1PrivacyExperienceGetResponses = { + /** + * Successful Response + */ + 200: Page_Union_PrivacyExperienceResponse__TCFBannerExperienceMinimalResponse__; +}; + +export type privacyExperienceListApiV1PrivacyExperienceGetResponse = + privacyExperienceListApiV1PrivacyExperienceGetResponses[keyof privacyExperienceListApiV1PrivacyExperienceGetResponses]; + +export type privacyExperienceTranslationsApiV1PrivacyExperienceGvlTranslationsGetData = + { + body?: never; + path?: never; + query?: { + /** + * Language + */ + language?: Array | null; + }; + url: "/api/v1/privacy-experience/gvl/translations"; + }; + +export type privacyExperienceTranslationsApiV1PrivacyExperienceGvlTranslationsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type privacyExperienceTranslationsApiV1PrivacyExperienceGvlTranslationsGetError = + privacyExperienceTranslationsApiV1PrivacyExperienceGvlTranslationsGetErrors[keyof privacyExperienceTranslationsApiV1PrivacyExperienceGvlTranslationsGetErrors]; + +export type privacyExperienceTranslationsApiV1PrivacyExperienceGvlTranslationsGetResponses = + { + /** + * Response Privacy Experience Translations Api V1 Privacy Experience Gvl Translations Get + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; + }; + +export type privacyExperienceTranslationsApiV1PrivacyExperienceGvlTranslationsGetResponse = + privacyExperienceTranslationsApiV1PrivacyExperienceGvlTranslationsGetResponses[keyof privacyExperienceTranslationsApiV1PrivacyExperienceGvlTranslationsGetResponses]; + +export type clearPrivacyExperienceDbCacheApiV1PrivacyExperienceDbCacheDeleteData = + { + body?: never; + path?: never; + query?: never; + url: "/api/v1/privacy-experience/db-cache"; + }; + +export type clearPrivacyExperienceDbCacheApiV1PrivacyExperienceDbCacheDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type clearPrivacyExperienceDbCacheApiV1PrivacyExperienceDbCacheDeleteResponse = + clearPrivacyExperienceDbCacheApiV1PrivacyExperienceDbCacheDeleteResponses[keyof clearPrivacyExperienceDbCacheApiV1PrivacyExperienceDbCacheDeleteResponses]; + +export type refreshPrivacyExperienceDbCacheApiV1PrivacyExperienceDbCacheRefreshPostData = + { + body?: never; + path?: never; + query?: { + /** + * Force Refresh + */ + force_refresh?: boolean | null; + }; + url: "/api/v1/privacy-experience/db-cache/refresh"; + }; + +export type refreshPrivacyExperienceDbCacheApiV1PrivacyExperienceDbCacheRefreshPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type refreshPrivacyExperienceDbCacheApiV1PrivacyExperienceDbCacheRefreshPostError = + refreshPrivacyExperienceDbCacheApiV1PrivacyExperienceDbCacheRefreshPostErrors[keyof refreshPrivacyExperienceDbCacheApiV1PrivacyExperienceDbCacheRefreshPostErrors]; + +export type refreshPrivacyExperienceDbCacheApiV1PrivacyExperienceDbCacheRefreshPostResponses = + { + /** + * Response Refresh Privacy Experience Db Cache Api V1 Privacy Experience Db Cache Refresh Post + * + * Successful Response + */ + 200: { + [key: string]: string; + }; + }; + +export type refreshPrivacyExperienceDbCacheApiV1PrivacyExperienceDbCacheRefreshPostResponse = + refreshPrivacyExperienceDbCacheApiV1PrivacyExperienceDbCacheRefreshPostResponses[keyof refreshPrivacyExperienceDbCacheApiV1PrivacyExperienceDbCacheRefreshPostResponses]; + +export type getPrivacyExperienceCacheKeysApiV1PrivacyExperienceCacheKeysGetData = + { + body?: never; + path?: never; + query?: { + /** + * Readonly Cache + */ + readonly_cache?: boolean | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/privacy-experience/cache/keys"; + }; + +export type getPrivacyExperienceCacheKeysApiV1PrivacyExperienceCacheKeysGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getPrivacyExperienceCacheKeysApiV1PrivacyExperienceCacheKeysGetError = + getPrivacyExperienceCacheKeysApiV1PrivacyExperienceCacheKeysGetErrors[keyof getPrivacyExperienceCacheKeysApiV1PrivacyExperienceCacheKeysGetErrors]; + +export type getPrivacyExperienceCacheKeysApiV1PrivacyExperienceCacheKeysGetResponses = + { + /** + * Successful Response + */ + 200: Page_str_; + }; + +export type getPrivacyExperienceCacheKeysApiV1PrivacyExperienceCacheKeysGetResponse = + getPrivacyExperienceCacheKeysApiV1PrivacyExperienceCacheKeysGetResponses[keyof getPrivacyExperienceCacheKeysApiV1PrivacyExperienceCacheKeysGetResponses]; + +export type deletePrivacyExperienceCacheLockApiV1PrivacyExperienceCacheLockDeleteData = + { + body?: never; + path?: never; + query?: never; + url: "/api/v1/privacy-experience/cache/lock"; + }; + +export type deletePrivacyExperienceCacheLockApiV1PrivacyExperienceCacheLockDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deletePrivacyExperienceCacheLockApiV1PrivacyExperienceCacheLockDeleteResponse = + deletePrivacyExperienceCacheLockApiV1PrivacyExperienceCacheLockDeleteResponses[keyof deletePrivacyExperienceCacheLockApiV1PrivacyExperienceCacheLockDeleteResponses]; + +export type getPrivacyExperienceCacheLockApiV1PrivacyExperienceCacheLockGetData = + { + body?: never; + path?: never; + query?: never; + url: "/api/v1/privacy-experience/cache/lock"; + }; + +export type getPrivacyExperienceCacheLockApiV1PrivacyExperienceCacheLockGetResponses = + { + /** + * Response Get Privacy Experience Cache Lock Api V1 Privacy Experience Cache Lock Get + * + * Successful Response + */ + 200: { + [key: string]: boolean; + }; + }; + +export type getPrivacyExperienceCacheLockApiV1PrivacyExperienceCacheLockGetResponse = + getPrivacyExperienceCacheLockApiV1PrivacyExperienceCacheLockGetResponses[keyof getPrivacyExperienceCacheLockApiV1PrivacyExperienceCacheLockGetResponses]; + +export type refreshPrivacyExperienceCacheApiV1PrivacyExperienceCacheRefreshPostData = + { + body?: never; + path?: never; + query?: { + /** + * Force Refresh + */ + force_refresh?: boolean | null; + }; + url: "/api/v1/privacy-experience/cache/refresh"; + }; + +export type refreshPrivacyExperienceCacheApiV1PrivacyExperienceCacheRefreshPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type refreshPrivacyExperienceCacheApiV1PrivacyExperienceCacheRefreshPostError = + refreshPrivacyExperienceCacheApiV1PrivacyExperienceCacheRefreshPostErrors[keyof refreshPrivacyExperienceCacheApiV1PrivacyExperienceCacheRefreshPostErrors]; + +export type refreshPrivacyExperienceCacheApiV1PrivacyExperienceCacheRefreshPostResponses = + { + /** + * Response Refresh Privacy Experience Cache Api V1 Privacy Experience Cache Refresh Post + * + * Successful Response + */ + 200: { + [key: string]: string; + }; + }; + +export type refreshPrivacyExperienceCacheApiV1PrivacyExperienceCacheRefreshPostResponse = + refreshPrivacyExperienceCacheApiV1PrivacyExperienceCacheRefreshPostResponses[keyof refreshPrivacyExperienceCacheApiV1PrivacyExperienceCacheRefreshPostResponses]; + +export type deletePrivacyExperienceCacheApiV1PrivacyExperienceCacheDeleteData = + { + body?: never; + path?: never; + query?: never; + url: "/api/v1/privacy-experience/cache"; + }; + +export type deletePrivacyExperienceCacheApiV1PrivacyExperienceCacheDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deletePrivacyExperienceCacheApiV1PrivacyExperienceCacheDeleteResponse = + deletePrivacyExperienceCacheApiV1PrivacyExperienceCacheDeleteResponses[keyof deletePrivacyExperienceCacheApiV1PrivacyExperienceCacheDeleteResponses]; + +export type deletePrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdDeleteData = + { + body?: never; + path: { + /** + * Experience Config Id + */ + experience_config_id: string; + }; + query?: never; + url: "/api/v1/privacy-experience/cache/keys/{experience_config_id}"; + }; + +export type deletePrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deletePrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdDeleteError = + deletePrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdDeleteErrors[keyof deletePrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdDeleteErrors]; + +export type deletePrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deletePrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdDeleteResponse = + deletePrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdDeleteResponses[keyof deletePrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdDeleteResponses]; + +export type getPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdGetData = + { + body?: never; + path: { + /** + * Experience Config Id + */ + experience_config_id: string; + }; + query?: { + /** + * Readonly Cache + */ + readonly_cache?: boolean | null; + }; + url: "/api/v1/privacy-experience/cache/keys/{experience_config_id}"; + }; + +export type getPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdGetError = + getPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdGetErrors[keyof getPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdGetErrors]; + +export type getPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdGetResponses = + { + /** + * Response Get Privacy Experience Cache Key Detail Api V1 Privacy Experience Cache Keys Experience Config Id Get + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; + }; + +export type getPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdGetResponse = + getPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdGetResponses[keyof getPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdGetResponses]; + +export type refreshPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdRefreshPostData = + { + body?: never; + path: { + /** + * Experience Config Id + */ + experience_config_id: string; + }; + query?: never; + url: "/api/v1/privacy-experience/cache/keys/{experience_config_id}/refresh"; + }; + +export type refreshPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdRefreshPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type refreshPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdRefreshPostError = + refreshPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdRefreshPostErrors[keyof refreshPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdRefreshPostErrors]; + +export type refreshPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdRefreshPostResponses = + { + /** + * Response Refresh Privacy Experience Cache Key Detail Api V1 Privacy Experience Cache Keys Experience Config Id Refresh Post + * + * Successful Response + */ + 200: { + [key: string]: string; + }; + }; + +export type refreshPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdRefreshPostResponse = + refreshPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdRefreshPostResponses[keyof refreshPrivacyExperienceCacheKeyDetailApiV1PrivacyExperienceCacheKeysExperienceConfigIdRefreshPostResponses]; + +export type getCurrentPrivacyPreferencesByFilterApiV1CurrentPrivacyPreferencesGetData = + { + body?: never; + path?: never; + query?: { + /** + * Property Id + */ + property_id?: string | null; + /** + * Email + */ + email?: string | null; + /** + * Phone Number + */ + phone_number?: string | null; + /** + * Fides User Device Id + */ + fides_user_device_id?: string | null; + /** + * External Id + */ + external_id?: string | null; + /** + * Notice Id + */ + notice_id?: string | null; + }; + url: "/api/v1/current-privacy-preferences"; + }; + +export type getCurrentPrivacyPreferencesByFilterApiV1CurrentPrivacyPreferencesGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getCurrentPrivacyPreferencesByFilterApiV1CurrentPrivacyPreferencesGetError = + getCurrentPrivacyPreferencesByFilterApiV1CurrentPrivacyPreferencesGetErrors[keyof getCurrentPrivacyPreferencesByFilterApiV1CurrentPrivacyPreferencesGetErrors]; + +export type getCurrentPrivacyPreferencesByFilterApiV1CurrentPrivacyPreferencesGetResponses = + { + /** + * Successful Response + */ + 200: PreferencesSavedExtended; + }; + +export type getCurrentPrivacyPreferencesByFilterApiV1CurrentPrivacyPreferencesGetResponse = + getCurrentPrivacyPreferencesByFilterApiV1CurrentPrivacyPreferencesGetResponses[keyof getCurrentPrivacyPreferencesByFilterApiV1CurrentPrivacyPreferencesGetResponses]; + +export type getHistoricalConsentReportApiV1HistoricalPrivacyPreferencesGetData = + { + body?: never; + path?: never; + query?: { + /** + * Request Timestamp Gt + */ + request_timestamp_gt?: string | null; + /** + * Request Timestamp Lt + */ + request_timestamp_lt?: string | null; + /** + * Property Id + */ + property_id?: string | null; + /** + * External Id + */ + external_id?: string | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number | null; + /** + * Include Total + */ + include_total?: boolean | null; + }; + url: "/api/v1/historical-privacy-preferences"; + }; + +export type getHistoricalConsentReportApiV1HistoricalPrivacyPreferencesGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getHistoricalConsentReportApiV1HistoricalPrivacyPreferencesGetError = + getHistoricalConsentReportApiV1HistoricalPrivacyPreferencesGetErrors[keyof getHistoricalConsentReportApiV1HistoricalPrivacyPreferencesGetErrors]; + +export type getHistoricalConsentReportApiV1HistoricalPrivacyPreferencesGetResponses = + { + /** + * Historical privacy preferences report + */ + 200: ConditionalTotalPage_ConsentReportingSchema_; + }; + +export type getHistoricalConsentReportApiV1HistoricalPrivacyPreferencesGetResponse = + getHistoricalConsentReportApiV1HistoricalPrivacyPreferencesGetResponses[keyof getHistoricalConsentReportApiV1HistoricalPrivacyPreferencesGetResponses]; + +export type consentRequestVerifyForPrivacyPreferencesApiV1ConsentRequestConsentRequestIdVerifyForPrivacyPreferencesPostData = + { + body: VerificationCode; + path: { + /** + * Consent Request Id + */ + consent_request_id: string; + }; + query?: { + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/consent-request/{consent_request_id}/verify-for-privacy-preferences"; + }; + +export type consentRequestVerifyForPrivacyPreferencesApiV1ConsentRequestConsentRequestIdVerifyForPrivacyPreferencesPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type consentRequestVerifyForPrivacyPreferencesApiV1ConsentRequestConsentRequestIdVerifyForPrivacyPreferencesPostError = + consentRequestVerifyForPrivacyPreferencesApiV1ConsentRequestConsentRequestIdVerifyForPrivacyPreferencesPostErrors[keyof consentRequestVerifyForPrivacyPreferencesApiV1ConsentRequestConsentRequestIdVerifyForPrivacyPreferencesPostErrors]; + +export type consentRequestVerifyForPrivacyPreferencesApiV1ConsentRequestConsentRequestIdVerifyForPrivacyPreferencesPostResponses = + { + /** + * Successful Response + */ + 200: PreferencesSaved; + }; + +export type consentRequestVerifyForPrivacyPreferencesApiV1ConsentRequestConsentRequestIdVerifyForPrivacyPreferencesPostResponse = + consentRequestVerifyForPrivacyPreferencesApiV1ConsentRequestConsentRequestIdVerifyForPrivacyPreferencesPostResponses[keyof consentRequestVerifyForPrivacyPreferencesApiV1ConsentRequestConsentRequestIdVerifyForPrivacyPreferencesPostResponses]; + +export type savePrivacyPreferencesWithVerifiedIdentityApiV1ConsentRequestConsentRequestIdPrivacyPreferencesPatchData = + { + body: PrivacyPreferencesRequest; + path: { + /** + * Consent Request Id + */ + consent_request_id: string; + }; + query?: { + /** + * Validate + */ + validate?: boolean; + }; + url: "/api/v1/consent-request/{consent_request_id}/privacy-preferences"; + }; + +export type savePrivacyPreferencesWithVerifiedIdentityApiV1ConsentRequestConsentRequestIdPrivacyPreferencesPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type savePrivacyPreferencesWithVerifiedIdentityApiV1ConsentRequestConsentRequestIdPrivacyPreferencesPatchError = + savePrivacyPreferencesWithVerifiedIdentityApiV1ConsentRequestConsentRequestIdPrivacyPreferencesPatchErrors[keyof savePrivacyPreferencesWithVerifiedIdentityApiV1ConsentRequestConsentRequestIdPrivacyPreferencesPatchErrors]; + +export type savePrivacyPreferencesWithVerifiedIdentityApiV1ConsentRequestConsentRequestIdPrivacyPreferencesPatchResponses = + { + /** + * Successful Response + */ + 200: PreferencesSaved; + }; + +export type savePrivacyPreferencesWithVerifiedIdentityApiV1ConsentRequestConsentRequestIdPrivacyPreferencesPatchResponse = + savePrivacyPreferencesWithVerifiedIdentityApiV1ConsentRequestConsentRequestIdPrivacyPreferencesPatchResponses[keyof savePrivacyPreferencesWithVerifiedIdentityApiV1ConsentRequestConsentRequestIdPrivacyPreferencesPatchResponses]; + +export type savePrivacyPreferencesApiV1PrivacyPreferencesPatchData = { + body: UnverifiedPrivacyPreferencesRequest; + path?: never; + query?: { + /** + * Validate + */ + validate?: boolean; + }; + url: "/api/v1/privacy-preferences"; +}; + +export type savePrivacyPreferencesApiV1PrivacyPreferencesPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type savePrivacyPreferencesApiV1PrivacyPreferencesPatchError = + savePrivacyPreferencesApiV1PrivacyPreferencesPatchErrors[keyof savePrivacyPreferencesApiV1PrivacyPreferencesPatchErrors]; + +export type savePrivacyPreferencesApiV1PrivacyPreferencesPatchResponses = { + /** + * Successful Response + */ + 200: PreferencesSaved; +}; + +export type savePrivacyPreferencesApiV1PrivacyPreferencesPatchResponse = + savePrivacyPreferencesApiV1PrivacyPreferencesPatchResponses[keyof savePrivacyPreferencesApiV1PrivacyPreferencesPatchResponses]; + +export type savePrivacyPreferencesPreVerifiedApiV1PrivacyPreferencesPreVerifiedPatchData = + { + body: PreVerifiedPrivacyPreferencesRequest; + path?: never; + query?: { + /** + * Validate + */ + validate?: boolean; + }; + url: "/api/v1/privacy-preferences/pre-verified"; + }; + +export type savePrivacyPreferencesPreVerifiedApiV1PrivacyPreferencesPreVerifiedPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type savePrivacyPreferencesPreVerifiedApiV1PrivacyPreferencesPreVerifiedPatchError = + savePrivacyPreferencesPreVerifiedApiV1PrivacyPreferencesPreVerifiedPatchErrors[keyof savePrivacyPreferencesPreVerifiedApiV1PrivacyPreferencesPreVerifiedPatchErrors]; + +export type savePrivacyPreferencesPreVerifiedApiV1PrivacyPreferencesPreVerifiedPatchResponses = + { + /** + * Successful Response + */ + 200: PreferencesSaved; + }; + +export type savePrivacyPreferencesPreVerifiedApiV1PrivacyPreferencesPreVerifiedPatchResponse = + savePrivacyPreferencesPreVerifiedApiV1PrivacyPreferencesPreVerifiedPatchResponses[keyof savePrivacyPreferencesPreVerifiedApiV1PrivacyPreferencesPreVerifiedPatchResponses]; + +export type getPrivacyPreferenceStatsApiV1PrivacyPreferenceStatsGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/privacy-preference-stats"; +}; + +export type getPrivacyPreferenceStatsApiV1PrivacyPreferenceStatsGetResponses = { + /** + * Successful Response + */ + 200: PrivacyPreferenceStats; +}; + +export type getPrivacyPreferenceStatsApiV1PrivacyPreferenceStatsGetResponse = + getPrivacyPreferenceStatsApiV1PrivacyPreferenceStatsGetResponses[keyof getPrivacyPreferenceStatsApiV1PrivacyPreferenceStatsGetResponses]; + +export type saveConsentServedViaPrivacyCenterApiV1ConsentRequestConsentRequestIdNoticesServedPatchData = + { + body: RecordConsentServedRequest; + path: { + /** + * Consent Request Id + */ + consent_request_id: string; + }; + query?: { + /** + * Validate + */ + validate?: boolean; + }; + url: "/api/v1/consent-request/{consent_request_id}/notices-served"; + }; + +export type saveConsentServedViaPrivacyCenterApiV1ConsentRequestConsentRequestIdNoticesServedPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type saveConsentServedViaPrivacyCenterApiV1ConsentRequestConsentRequestIdNoticesServedPatchError = + saveConsentServedViaPrivacyCenterApiV1ConsentRequestConsentRequestIdNoticesServedPatchErrors[keyof saveConsentServedViaPrivacyCenterApiV1ConsentRequestConsentRequestIdNoticesServedPatchErrors]; + +export type saveConsentServedViaPrivacyCenterApiV1ConsentRequestConsentRequestIdNoticesServedPatchResponses = + { + /** + * Successful Response + */ + 200: RecordsServedResponse; + }; + +export type saveConsentServedViaPrivacyCenterApiV1ConsentRequestConsentRequestIdNoticesServedPatchResponse = + saveConsentServedViaPrivacyCenterApiV1ConsentRequestConsentRequestIdNoticesServedPatchResponses[keyof saveConsentServedViaPrivacyCenterApiV1ConsentRequestConsentRequestIdNoticesServedPatchResponses]; + +export type saveConsentServedToUserApiV1NoticesServedPatchData = { + body: RecordConsentServedRequest; + path?: never; + query?: { + /** + * Validate + */ + validate?: boolean; + }; + url: "/api/v1/notices-served"; +}; + +export type saveConsentServedToUserApiV1NoticesServedPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type saveConsentServedToUserApiV1NoticesServedPatchError = + saveConsentServedToUserApiV1NoticesServedPatchErrors[keyof saveConsentServedToUserApiV1NoticesServedPatchErrors]; + +export type saveConsentServedToUserApiV1NoticesServedPatchResponses = { + /** + * Successful Response + */ + 200: RecordsServedResponse; +}; + +export type saveConsentServedToUserApiV1NoticesServedPatchResponse = + saveConsentServedToUserApiV1NoticesServedPatchResponses[keyof saveConsentServedToUserApiV1NoticesServedPatchResponses]; + +export type getPurposesApiV1PurposesGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/purposes"; +}; + +export type getPurposesApiV1PurposesGetResponses = { + /** + * Successful Response + */ + 200: PurposesResponse; +}; + +export type getPurposesApiV1PurposesGetResponse = + getPurposesApiV1PurposesGetResponses[keyof getPurposesApiV1PurposesGetResponses]; + +export type getPrivacyNoticeListApiV1PrivacyNoticeGetData = { + body?: never; + path?: never; + query?: { + /** + * Show Disabled + */ + show_disabled?: boolean | null; + /** + * Systems Applicable + */ + systems_applicable?: boolean | null; + /** + * Filter By Framework + */ + filter_by_framework?: boolean | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/privacy-notice"; +}; + +export type getPrivacyNoticeListApiV1PrivacyNoticeGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getPrivacyNoticeListApiV1PrivacyNoticeGetError = + getPrivacyNoticeListApiV1PrivacyNoticeGetErrors[keyof getPrivacyNoticeListApiV1PrivacyNoticeGetErrors]; + +export type getPrivacyNoticeListApiV1PrivacyNoticeGetResponses = { + /** + * Successful Response + */ + 200: Page_LimitedPrivacyNoticeResponseSchema_; +}; + +export type getPrivacyNoticeListApiV1PrivacyNoticeGetResponse = + getPrivacyNoticeListApiV1PrivacyNoticeGetResponses[keyof getPrivacyNoticeListApiV1PrivacyNoticeGetResponses]; + +export type createPrivacyNoticeApiV1PrivacyNoticePostData = { + body: PrivacyNoticeCreation; + path?: never; + query?: never; + url: "/api/v1/privacy-notice"; +}; + +export type createPrivacyNoticeApiV1PrivacyNoticePostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createPrivacyNoticeApiV1PrivacyNoticePostError = + createPrivacyNoticeApiV1PrivacyNoticePostErrors[keyof createPrivacyNoticeApiV1PrivacyNoticePostErrors]; + +export type createPrivacyNoticeApiV1PrivacyNoticePostResponses = { + /** + * Successful Response + */ + 201: PrivacyNoticeResponse; +}; + +export type createPrivacyNoticeApiV1PrivacyNoticePostResponse = + createPrivacyNoticeApiV1PrivacyNoticePostResponses[keyof createPrivacyNoticeApiV1PrivacyNoticePostResponses]; + +export type getPrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdGetData = { + body?: never; + path: { + /** + * Privacy Notice Id + */ + privacy_notice_id: string; + }; + query?: never; + url: "/api/v1/privacy-notice/{privacy_notice_id}"; +}; + +export type getPrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getPrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdGetError = + getPrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdGetErrors[keyof getPrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdGetErrors]; + +export type getPrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdGetResponses = { + /** + * Successful Response + */ + 200: PrivacyNoticeResponseWithRegions; +}; + +export type getPrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdGetResponse = + getPrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdGetResponses[keyof getPrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdGetResponses]; + +export type updatePrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdPatchData = { + body: PrivacyNoticeUpdate; + path: { + /** + * Privacy Notice Id + */ + privacy_notice_id: string; + }; + query?: never; + url: "/api/v1/privacy-notice/{privacy_notice_id}"; +}; + +export type updatePrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdPatchErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updatePrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdPatchError = + updatePrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdPatchErrors[keyof updatePrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdPatchErrors]; + +export type updatePrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdPatchResponses = + { + /** + * Successful Response + */ + 200: PrivacyNoticeResponse; + }; + +export type updatePrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdPatchResponse = + updatePrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdPatchResponses[keyof updatePrivacyNoticeApiV1PrivacyNoticePrivacyNoticeIdPatchResponses]; + +export type getOutOfTheBoxNoticeTranslationsApiV1PrivacyNoticePrivacyNoticeIdAvailableTranslationsGetData = + { + body?: never; + path: { + /** + * Privacy Notice Id + */ + privacy_notice_id: string; + }; + query?: never; + url: "/api/v1/privacy-notice/{privacy_notice_id}/available_translations"; + }; + +export type getOutOfTheBoxNoticeTranslationsApiV1PrivacyNoticePrivacyNoticeIdAvailableTranslationsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getOutOfTheBoxNoticeTranslationsApiV1PrivacyNoticePrivacyNoticeIdAvailableTranslationsGetError = + getOutOfTheBoxNoticeTranslationsApiV1PrivacyNoticePrivacyNoticeIdAvailableTranslationsGetErrors[keyof getOutOfTheBoxNoticeTranslationsApiV1PrivacyNoticePrivacyNoticeIdAvailableTranslationsGetErrors]; + +export type getOutOfTheBoxNoticeTranslationsApiV1PrivacyNoticePrivacyNoticeIdAvailableTranslationsGetResponses = + { + /** + * Response Get Out Of The Box Notice Translations Api V1 Privacy Notice Privacy Notice Id Available Translations Get + * + * Successful Response + */ + 200: Array; + }; + +export type getOutOfTheBoxNoticeTranslationsApiV1PrivacyNoticePrivacyNoticeIdAvailableTranslationsGetResponse = + getOutOfTheBoxNoticeTranslationsApiV1PrivacyNoticePrivacyNoticeIdAvailableTranslationsGetResponses[keyof getOutOfTheBoxNoticeTranslationsApiV1PrivacyNoticePrivacyNoticeIdAvailableTranslationsGetResponses]; + +export type privacyNoticeLimitedUpdateApiV1PrivacyNoticePrivacyNoticeIdLimitedUpdatePatchData = + { + body: PrivacyNoticeDisabledUpdate; + path: { + /** + * Privacy Notice Id + */ + privacy_notice_id: string; + }; + query?: never; + url: "/api/v1/privacy-notice/{privacy_notice_id}/limited_update"; + }; + +export type privacyNoticeLimitedUpdateApiV1PrivacyNoticePrivacyNoticeIdLimitedUpdatePatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type privacyNoticeLimitedUpdateApiV1PrivacyNoticePrivacyNoticeIdLimitedUpdatePatchError = + privacyNoticeLimitedUpdateApiV1PrivacyNoticePrivacyNoticeIdLimitedUpdatePatchErrors[keyof privacyNoticeLimitedUpdateApiV1PrivacyNoticePrivacyNoticeIdLimitedUpdatePatchErrors]; + +export type privacyNoticeLimitedUpdateApiV1PrivacyNoticePrivacyNoticeIdLimitedUpdatePatchResponses = + { + /** + * Successful Response + */ + 200: PrivacyNoticeDisabledResponse; + }; + +export type privacyNoticeLimitedUpdateApiV1PrivacyNoticePrivacyNoticeIdLimitedUpdatePatchResponse = + privacyNoticeLimitedUpdateApiV1PrivacyNoticePrivacyNoticeIdLimitedUpdatePatchResponses[keyof privacyNoticeLimitedUpdateApiV1PrivacyNoticePrivacyNoticeIdLimitedUpdatePatchResponses]; + +export type experienceConfigListApiV1ExperienceConfigGetData = { + body?: never; + path?: never; + query?: { + /** + * Show Disabled + */ + show_disabled?: boolean | null; + /** + * Component + */ + component?: ComponentType | null; + /** + * Region + */ + region?: PrivacyNoticeRegion | null; + /** + * Exclude Tcf + */ + exclude_tcf?: boolean | null; + /** + * Page + */ + page?: number; + /** + * Size + */ + size?: number; + }; + url: "/api/v1/experience-config"; +}; + +export type experienceConfigListApiV1ExperienceConfigGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type experienceConfigListApiV1ExperienceConfigGetError = + experienceConfigListApiV1ExperienceConfigGetErrors[keyof experienceConfigListApiV1ExperienceConfigGetErrors]; + +export type experienceConfigListApiV1ExperienceConfigGetResponses = { + /** + * Successful Response + */ + 200: Page_ExperienceConfigListViewResponse_; +}; + +export type experienceConfigListApiV1ExperienceConfigGetResponse = + experienceConfigListApiV1ExperienceConfigGetResponses[keyof experienceConfigListApiV1ExperienceConfigGetResponses]; + +export type experienceConfigCreateApiV1ExperienceConfigPostData = { + body: ExperienceConfigCreate; + path?: never; + query?: never; + url: "/api/v1/experience-config"; +}; + +export type experienceConfigCreateApiV1ExperienceConfigPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type experienceConfigCreateApiV1ExperienceConfigPostError = + experienceConfigCreateApiV1ExperienceConfigPostErrors[keyof experienceConfigCreateApiV1ExperienceConfigPostErrors]; + +export type experienceConfigCreateApiV1ExperienceConfigPostResponses = { + /** + * Successful Response + */ + 201: ExperienceConfigResponse; +}; + +export type experienceConfigCreateApiV1ExperienceConfigPostResponse = + experienceConfigCreateApiV1ExperienceConfigPostResponses[keyof experienceConfigCreateApiV1ExperienceConfigPostResponses]; + +export type experienceConfigDetailApiV1ExperienceConfigExperienceConfigIdGetData = + { + body?: never; + path: { + /** + * Experience Config Id + */ + experience_config_id: string; + }; + query?: never; + url: "/api/v1/experience-config/{experience_config_id}"; + }; + +export type experienceConfigDetailApiV1ExperienceConfigExperienceConfigIdGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type experienceConfigDetailApiV1ExperienceConfigExperienceConfigIdGetError = + experienceConfigDetailApiV1ExperienceConfigExperienceConfigIdGetErrors[keyof experienceConfigDetailApiV1ExperienceConfigExperienceConfigIdGetErrors]; + +export type experienceConfigDetailApiV1ExperienceConfigExperienceConfigIdGetResponses = + { + /** + * Successful Response + */ + 200: ExperienceConfigResponse; + }; + +export type experienceConfigDetailApiV1ExperienceConfigExperienceConfigIdGetResponse = + experienceConfigDetailApiV1ExperienceConfigExperienceConfigIdGetResponses[keyof experienceConfigDetailApiV1ExperienceConfigExperienceConfigIdGetResponses]; + +export type experienceConfigUpdateApiV1ExperienceConfigExperienceConfigIdPatchData = + { + body: ExperienceConfigUpdate; + path: { + /** + * Experience Config Id + */ + experience_config_id: string; + }; + query?: never; + url: "/api/v1/experience-config/{experience_config_id}"; + }; + +export type experienceConfigUpdateApiV1ExperienceConfigExperienceConfigIdPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type experienceConfigUpdateApiV1ExperienceConfigExperienceConfigIdPatchError = + experienceConfigUpdateApiV1ExperienceConfigExperienceConfigIdPatchErrors[keyof experienceConfigUpdateApiV1ExperienceConfigExperienceConfigIdPatchErrors]; + +export type experienceConfigUpdateApiV1ExperienceConfigExperienceConfigIdPatchResponses = + { + /** + * Successful Response + */ + 200: ExperienceConfigResponse; + }; + +export type experienceConfigUpdateApiV1ExperienceConfigExperienceConfigIdPatchResponse = + experienceConfigUpdateApiV1ExperienceConfigExperienceConfigIdPatchResponses[keyof experienceConfigUpdateApiV1ExperienceConfigExperienceConfigIdPatchResponses]; + +export type experienceConfigLimitedUpdateApiV1ExperienceConfigExperienceConfigIdLimitedUpdatePatchData = + { + body: ExperienceConfigDisabledUpdate; + path: { + /** + * Experience Config Id + */ + experience_config_id: string; + }; + query?: never; + url: "/api/v1/experience-config/{experience_config_id}/limited_update"; + }; + +export type experienceConfigLimitedUpdateApiV1ExperienceConfigExperienceConfigIdLimitedUpdatePatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type experienceConfigLimitedUpdateApiV1ExperienceConfigExperienceConfigIdLimitedUpdatePatchError = + experienceConfigLimitedUpdateApiV1ExperienceConfigExperienceConfigIdLimitedUpdatePatchErrors[keyof experienceConfigLimitedUpdateApiV1ExperienceConfigExperienceConfigIdLimitedUpdatePatchErrors]; + +export type experienceConfigLimitedUpdateApiV1ExperienceConfigExperienceConfigIdLimitedUpdatePatchResponses = + { + /** + * Successful Response + */ + 200: ExperienceConfigDisabledResponse; + }; + +export type experienceConfigLimitedUpdateApiV1ExperienceConfigExperienceConfigIdLimitedUpdatePatchResponse = + experienceConfigLimitedUpdateApiV1ExperienceConfigExperienceConfigIdLimitedUpdatePatchResponses[keyof experienceConfigLimitedUpdateApiV1ExperienceConfigExperienceConfigIdLimitedUpdatePatchResponses]; + +export type getExperienceConfigTemplateTranslationsApiV1ExperienceConfigExperienceConfigIdAvailableTranslationsGetData = + { + body?: never; + path: { + /** + * Experience Config Id + */ + experience_config_id: string; + }; + query?: never; + url: "/api/v1/experience-config/{experience_config_id}/available_translations"; + }; + +export type getExperienceConfigTemplateTranslationsApiV1ExperienceConfigExperienceConfigIdAvailableTranslationsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getExperienceConfigTemplateTranslationsApiV1ExperienceConfigExperienceConfigIdAvailableTranslationsGetError = + getExperienceConfigTemplateTranslationsApiV1ExperienceConfigExperienceConfigIdAvailableTranslationsGetErrors[keyof getExperienceConfigTemplateTranslationsApiV1ExperienceConfigExperienceConfigIdAvailableTranslationsGetErrors]; + +export type getExperienceConfigTemplateTranslationsApiV1ExperienceConfigExperienceConfigIdAvailableTranslationsGetResponses = + { + /** + * Response Get Experience Config Template Translations Api V1 Experience Config Experience Config Id Available Translations Get + * + * Successful Response + */ + 200: Array; + }; + +export type getExperienceConfigTemplateTranslationsApiV1ExperienceConfigExperienceConfigIdAvailableTranslationsGetResponse = + getExperienceConfigTemplateTranslationsApiV1ExperienceConfigExperienceConfigIdAvailableTranslationsGetResponses[keyof getExperienceConfigTemplateTranslationsApiV1ExperienceConfigExperienceConfigIdAvailableTranslationsGetResponses]; + +export type getSystemGroupsApiV1SystemGroupsGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/system-groups"; +}; + +export type getSystemGroupsApiV1SystemGroupsGetResponses = { + /** + * Response Get System Groups Api V1 System Groups Get + * + * Successful Response + */ + 200: Array; +}; + +export type getSystemGroupsApiV1SystemGroupsGetResponse = + getSystemGroupsApiV1SystemGroupsGetResponses[keyof getSystemGroupsApiV1SystemGroupsGetResponses]; + +export type createSystemGroupApiV1SystemGroupsPostData = { + body: SystemGroupCreate; + path?: never; + query?: never; + url: "/api/v1/system-groups"; +}; + +export type createSystemGroupApiV1SystemGroupsPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createSystemGroupApiV1SystemGroupsPostError = + createSystemGroupApiV1SystemGroupsPostErrors[keyof createSystemGroupApiV1SystemGroupsPostErrors]; + +export type createSystemGroupApiV1SystemGroupsPostResponses = { + /** + * Successful Response + */ + 201: SystemGroup; +}; + +export type createSystemGroupApiV1SystemGroupsPostResponse = + createSystemGroupApiV1SystemGroupsPostResponses[keyof createSystemGroupApiV1SystemGroupsPostResponses]; + +export type deleteSystemGroupApiV1SystemGroupsFidesKeyDeleteData = { + body?: never; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/system-groups/{fides_key}"; +}; + +export type deleteSystemGroupApiV1SystemGroupsFidesKeyDeleteErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteSystemGroupApiV1SystemGroupsFidesKeyDeleteError = + deleteSystemGroupApiV1SystemGroupsFidesKeyDeleteErrors[keyof deleteSystemGroupApiV1SystemGroupsFidesKeyDeleteErrors]; + +export type deleteSystemGroupApiV1SystemGroupsFidesKeyDeleteResponses = { + /** + * Successful Response + */ + 204: void; +}; + +export type deleteSystemGroupApiV1SystemGroupsFidesKeyDeleteResponse = + deleteSystemGroupApiV1SystemGroupsFidesKeyDeleteResponses[keyof deleteSystemGroupApiV1SystemGroupsFidesKeyDeleteResponses]; + +export type updateSystemGroupApiV1SystemGroupsFidesKeyPutData = { + body: SystemGroupUpdate; + path: { + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/system-groups/{fides_key}"; +}; + +export type updateSystemGroupApiV1SystemGroupsFidesKeyPutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateSystemGroupApiV1SystemGroupsFidesKeyPutError = + updateSystemGroupApiV1SystemGroupsFidesKeyPutErrors[keyof updateSystemGroupApiV1SystemGroupsFidesKeyPutErrors]; + +export type updateSystemGroupApiV1SystemGroupsFidesKeyPutResponses = { + /** + * Successful Response + */ + 200: SystemGroup; +}; + +export type updateSystemGroupApiV1SystemGroupsFidesKeyPutResponse = + updateSystemGroupApiV1SystemGroupsFidesKeyPutResponses[keyof updateSystemGroupApiV1SystemGroupsFidesKeyPutResponses]; + +export type listTaxonomiesApiV1TaxonomiesGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/taxonomies"; +}; + +export type listTaxonomiesApiV1TaxonomiesGetResponses = { + /** + * Response List Taxonomies Api V1 Taxonomies Get + * + * Successful Response + */ + 200: Array; +}; + +export type listTaxonomiesApiV1TaxonomiesGetResponse = + listTaxonomiesApiV1TaxonomiesGetResponses[keyof listTaxonomiesApiV1TaxonomiesGetResponses]; + +export type createTaxonomyApiV1TaxonomiesPostData = { + body: TaxonomyCreate; + path?: never; + query?: never; + url: "/api/v1/taxonomies"; +}; + +export type createTaxonomyApiV1TaxonomiesPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createTaxonomyApiV1TaxonomiesPostError = + createTaxonomyApiV1TaxonomiesPostErrors[keyof createTaxonomyApiV1TaxonomiesPostErrors]; + +export type createTaxonomyApiV1TaxonomiesPostResponses = { + /** + * Successful Response + */ + 201: TaxonomyResponse; +}; + +export type createTaxonomyApiV1TaxonomiesPostResponse = + createTaxonomyApiV1TaxonomiesPostResponses[keyof createTaxonomyApiV1TaxonomiesPostResponses]; + +export type deleteTaxonomyApiV1TaxonomiesTaxonomyTypeDeleteData = { + body?: never; + path: { + /** + * Taxonomy Type + */ + taxonomy_type: string; + }; + query?: never; + url: "/api/v1/taxonomies/{taxonomy_type}"; +}; + +export type deleteTaxonomyApiV1TaxonomiesTaxonomyTypeDeleteErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type deleteTaxonomyApiV1TaxonomiesTaxonomyTypeDeleteError = + deleteTaxonomyApiV1TaxonomiesTaxonomyTypeDeleteErrors[keyof deleteTaxonomyApiV1TaxonomiesTaxonomyTypeDeleteErrors]; + +export type deleteTaxonomyApiV1TaxonomiesTaxonomyTypeDeleteResponses = { + /** + * Successful Response + */ + 204: void; +}; + +export type deleteTaxonomyApiV1TaxonomiesTaxonomyTypeDeleteResponse = + deleteTaxonomyApiV1TaxonomiesTaxonomyTypeDeleteResponses[keyof deleteTaxonomyApiV1TaxonomiesTaxonomyTypeDeleteResponses]; + +export type updateTaxonomyApiV1TaxonomiesTaxonomyTypePutData = { + body: TaxonomyUpdate; + path: { + /** + * Taxonomy Type + */ + taxonomy_type: string; + }; + query?: never; + url: "/api/v1/taxonomies/{taxonomy_type}"; +}; + +export type updateTaxonomyApiV1TaxonomiesTaxonomyTypePutErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type updateTaxonomyApiV1TaxonomiesTaxonomyTypePutError = + updateTaxonomyApiV1TaxonomiesTaxonomyTypePutErrors[keyof updateTaxonomyApiV1TaxonomiesTaxonomyTypePutErrors]; + +export type updateTaxonomyApiV1TaxonomiesTaxonomyTypePutResponses = { + /** + * Successful Response + */ + 200: TaxonomyResponse; +}; + +export type updateTaxonomyApiV1TaxonomiesTaxonomyTypePutResponse = + updateTaxonomyApiV1TaxonomiesTaxonomyTypePutResponses[keyof updateTaxonomyApiV1TaxonomiesTaxonomyTypePutResponses]; + +export type listElementsApiV1TaxonomiesTaxonomyTypeElementsGetData = { + body?: never; + path: { + /** + * Taxonomy Type + */ + taxonomy_type: string; + }; + query?: { + /** + * Active Only + */ + active_only?: boolean; + /** + * Parent Key + */ + parent_key?: string | null; + }; + url: "/api/v1/taxonomies/{taxonomy_type}/elements"; +}; + +export type listElementsApiV1TaxonomiesTaxonomyTypeElementsGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type listElementsApiV1TaxonomiesTaxonomyTypeElementsGetError = + listElementsApiV1TaxonomiesTaxonomyTypeElementsGetErrors[keyof listElementsApiV1TaxonomiesTaxonomyTypeElementsGetErrors]; + +export type listElementsApiV1TaxonomiesTaxonomyTypeElementsGetResponses = { + /** + * Response List Elements Api V1 Taxonomies Taxonomy Type Elements Get + * + * Successful Response + */ + 200: Array; +}; + +export type listElementsApiV1TaxonomiesTaxonomyTypeElementsGetResponse = + listElementsApiV1TaxonomiesTaxonomyTypeElementsGetResponses[keyof listElementsApiV1TaxonomiesTaxonomyTypeElementsGetResponses]; + +export type createElementApiV1TaxonomiesTaxonomyTypeElementsPostData = { + body: TaxonomyElementCreate; + path: { + /** + * Taxonomy Type + */ + taxonomy_type: string; + }; + query?: never; + url: "/api/v1/taxonomies/{taxonomy_type}/elements"; +}; + +export type createElementApiV1TaxonomiesTaxonomyTypeElementsPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createElementApiV1TaxonomiesTaxonomyTypeElementsPostError = + createElementApiV1TaxonomiesTaxonomyTypeElementsPostErrors[keyof createElementApiV1TaxonomiesTaxonomyTypeElementsPostErrors]; + +export type createElementApiV1TaxonomiesTaxonomyTypeElementsPostResponses = { + /** + * Successful Response + */ + 201: TaxonomyElement; +}; + +export type createElementApiV1TaxonomiesTaxonomyTypeElementsPostResponse = + createElementApiV1TaxonomiesTaxonomyTypeElementsPostResponses[keyof createElementApiV1TaxonomiesTaxonomyTypeElementsPostResponses]; + +export type deleteElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyDeleteData = + { + body?: never; + path: { + /** + * Taxonomy Type + */ + taxonomy_type: string; + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/taxonomies/{taxonomy_type}/elements/{fides_key}"; + }; + +export type deleteElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyDeleteErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type deleteElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyDeleteError = + deleteElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyDeleteErrors[keyof deleteElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyDeleteErrors]; + +export type deleteElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyDeleteResponses = + { + /** + * Successful Response + */ + 204: void; + }; + +export type deleteElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyDeleteResponse = + deleteElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyDeleteResponses[keyof deleteElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyDeleteResponses]; + +export type updateElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyPutData = { + body: TaxonomyElementUpdate; + path: { + /** + * Taxonomy Type + */ + taxonomy_type: string; + /** + * Fides Key + */ + fides_key: string; + }; + query?: never; + url: "/api/v1/taxonomies/{taxonomy_type}/elements/{fides_key}"; +}; + +export type updateElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyPutError = + updateElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyPutErrors[keyof updateElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyPutErrors]; + +export type updateElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyPutResponses = + { + /** + * Successful Response + */ + 200: TaxonomyElement; + }; + +export type updateElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyPutResponse = + updateElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyPutResponses[keyof updateElementApiV1TaxonomiesTaxonomyTypeElementsFidesKeyPutResponses]; + +export type readPlusScopesApiV1OauthScopeGetData = { + body?: never; + path?: never; + query?: never; + url: "/api/v1/oauth/scope"; +}; + +export type readPlusScopesApiV1OauthScopeGetResponses = { + /** + * Response Read Plus Scopes Api V1 Oauth Scope Get + * + * Successful Response + */ + 200: Array; +}; + +export type readPlusScopesApiV1OauthScopeGetResponse = + readPlusScopesApiV1OauthScopeGetResponses[keyof readPlusScopesApiV1OauthScopeGetResponses]; + +export type getUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionGetData = + { + body?: never; + path: { + /** + * User Id + */ + user_id: string; + }; + query?: never; + url: "/api/v1/user/{user_id}/permission"; + }; + +export type getUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionGetError = + getUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionGetErrors[keyof getUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionGetErrors]; + +export type getUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionGetResponses = + { + /** + * Successful Response + */ + 200: UserPermissionsPlusResponse; + }; + +export type getUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionGetResponse = + getUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionGetResponses[keyof getUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionGetResponses]; + +export type createUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPostData = + { + body: UserPermissionsCreate; + path: { + /** + * User Id + */ + user_id: string; + }; + query?: never; + url: "/api/v1/user/{user_id}/permission"; + }; + +export type createUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPostError = + createUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPostErrors[keyof createUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPostErrors]; + +export type createUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPostResponses = + { + /** + * Successful Response + */ + 201: UserPermissionsPlusResponse; + }; + +export type createUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPostResponse = + createUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPostResponses[keyof createUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPostResponses]; + +export type updateUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPutData = + { + body: UserPermissionsEdit; + path: { + /** + * User Id + */ + user_id: string; + }; + query?: never; + url: "/api/v1/user/{user_id}/permission"; + }; + +export type updateUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPutErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPutError = + updateUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPutErrors[keyof updateUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPutErrors]; + +export type updateUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPutResponses = + { + /** + * Successful Response + */ + 200: UserPermissionsPlusResponse; + }; + +export type updateUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPutResponse = + updateUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPutResponses[keyof updateUserPermissionsWithPlusScopesMappingApiV1UserUserIdPermissionPutResponses]; + +export type createConsentRequestExtendedApiV1ConsentRequestPostData = { + body: ConsentRequestCreateExtended; + path?: never; + query?: never; + url: "/api/v1/consent-request"; +}; + +export type createConsentRequestExtendedApiV1ConsentRequestPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type createConsentRequestExtendedApiV1ConsentRequestPostError = + createConsentRequestExtendedApiV1ConsentRequestPostErrors[keyof createConsentRequestExtendedApiV1ConsentRequestPostErrors]; + +export type createConsentRequestExtendedApiV1ConsentRequestPostResponses = { + /** + * Successful Response + */ + 200: ConsentRequestResponse; +}; + +export type createConsentRequestExtendedApiV1ConsentRequestPostResponse = + createConsentRequestExtendedApiV1ConsentRequestPostResponses[keyof createConsentRequestExtendedApiV1ConsentRequestPostResponses]; + +export type submitSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdCompletePostData = + { + body?: Body_submit_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__complete_post; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + /** + * Manual Field Id + */ + manual_field_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/manual-field/{manual_field_id}/complete"; + }; + +export type submitSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdCompletePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type submitSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdCompletePostError = + submitSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdCompletePostErrors[keyof submitSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdCompletePostErrors]; + +export type submitSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdCompletePostResponses = + { + /** + * Successful Response + */ + 200: SingleFieldSubmissionResponse; + }; + +export type submitSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdCompletePostResponse = + submitSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdCompletePostResponses[keyof submitSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdCompletePostResponses]; + +export type skipSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdSkipPostData = + { + body: Body_skip_single_manual_field_api_v1_privacy_request__privacy_request_id__manual_field__manual_field_id__skip_post; + path: { + /** + * Privacy Request Id + */ + privacy_request_id: string; + /** + * Manual Field Id + */ + manual_field_id: string; + }; + query?: never; + url: "/api/v1/privacy-request/{privacy_request_id}/manual-field/{manual_field_id}/skip"; + }; + +export type skipSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdSkipPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type skipSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdSkipPostError = + skipSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdSkipPostErrors[keyof skipSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdSkipPostErrors]; + +export type skipSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdSkipPostResponses = + { + /** + * Successful Response + */ + 200: SingleFieldSubmissionResponse; + }; + +export type skipSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdSkipPostResponse = + skipSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdSkipPostResponses[keyof skipSingleManualFieldApiV1PrivacyRequestPrivacyRequestIdManualFieldManualFieldIdSkipPostResponses]; + +export type createPrivacyRequestAuthenticatedApiV1PrivacyRequestAuthenticatedPostData = + { + /** + * Data + */ + body: Array; + path?: never; + query?: never; + url: "/api/v1/privacy-request/authenticated"; + }; + +export type createPrivacyRequestAuthenticatedApiV1PrivacyRequestAuthenticatedPostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type createPrivacyRequestAuthenticatedApiV1PrivacyRequestAuthenticatedPostError = + createPrivacyRequestAuthenticatedApiV1PrivacyRequestAuthenticatedPostErrors[keyof createPrivacyRequestAuthenticatedApiV1PrivacyRequestAuthenticatedPostErrors]; + +export type createPrivacyRequestAuthenticatedApiV1PrivacyRequestAuthenticatedPostResponses = + { + /** + * Successful Response + */ + 200: BulkPostPrivacyRequests; + }; + +export type createPrivacyRequestAuthenticatedApiV1PrivacyRequestAuthenticatedPostResponse = + createPrivacyRequestAuthenticatedApiV1PrivacyRequestAuthenticatedPostResponses[keyof createPrivacyRequestAuthenticatedApiV1PrivacyRequestAuthenticatedPostResponses]; + +export type userLoginExtendedApiV1LoginPostData = { + body: UserLogin; + path?: never; + query?: { + /** + * Config Path Override + */ + config_path_override?: string; + /** + * Verbose + */ + verbose?: boolean; + }; + url: "/api/v1/login"; +}; + +export type userLoginExtendedApiV1LoginPostErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type userLoginExtendedApiV1LoginPostError = + userLoginExtendedApiV1LoginPostErrors[keyof userLoginExtendedApiV1LoginPostErrors]; + +export type userLoginExtendedApiV1LoginPostResponses = { + /** + * Successful Response + */ + 200: UserLoginResponse; +}; + +export type userLoginExtendedApiV1LoginPostResponse = + userLoginExtendedApiV1LoginPostResponses[keyof userLoginExtendedApiV1LoginPostResponses]; + +export type getEnabledAuthenticationMethodsApiV1PlusAuthenticationMethodsGetData = + { + body?: never; + path?: never; + query?: { + /** + * Config Path Override + */ + config_path_override?: string; + /** + * Verbose + */ + verbose?: boolean; + }; + url: "/api/v1/plus/authentication-methods"; + }; + +export type getEnabledAuthenticationMethodsApiV1PlusAuthenticationMethodsGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getEnabledAuthenticationMethodsApiV1PlusAuthenticationMethodsGetError = + getEnabledAuthenticationMethodsApiV1PlusAuthenticationMethodsGetErrors[keyof getEnabledAuthenticationMethodsApiV1PlusAuthenticationMethodsGetErrors]; + +export type getEnabledAuthenticationMethodsApiV1PlusAuthenticationMethodsGetResponses = + { + /** + * Successful Response + */ + 200: AuthenticationMethods; + }; + +export type getEnabledAuthenticationMethodsApiV1PlusAuthenticationMethodsGetResponse = + getEnabledAuthenticationMethodsApiV1PlusAuthenticationMethodsGetResponses[keyof getEnabledAuthenticationMethodsApiV1PlusAuthenticationMethodsGetResponses]; + +export type getStewardedMonitorsApiV1UserUserIdMonitorGetData = { + body?: never; + path: { + /** + * User Id + */ + user_id: string; + }; + query?: never; + url: "/api/v1/user/{user_id}/monitor"; +}; + +export type getStewardedMonitorsApiV1UserUserIdMonitorGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type getStewardedMonitorsApiV1UserUserIdMonitorGetError = + getStewardedMonitorsApiV1UserUserIdMonitorGetErrors[keyof getStewardedMonitorsApiV1UserUserIdMonitorGetErrors]; + +export type getStewardedMonitorsApiV1UserUserIdMonitorGetResponses = { + /** + * Response Get Stewarded Monitors Api V1 User User Id Monitor Get + * + * Successful Response + */ + 200: Array; +}; + +export type getStewardedMonitorsApiV1UserUserIdMonitorGetResponse = + getStewardedMonitorsApiV1UserUserIdMonitorGetResponses[keyof getStewardedMonitorsApiV1UserUserIdMonitorGetResponses]; + +export type instantiateConnectionFromTemplateExtendedApiV1ConnectionInstantiateConnectorTemplateTypePostData = + { + body: SaasConnectionTemplateValues; + path: { + /** + * Connector Template Type + */ + connector_template_type: string; + }; + query?: never; + url: "/api/v1/connection/instantiate/{connector_template_type}"; + }; + +export type instantiateConnectionFromTemplateExtendedApiV1ConnectionInstantiateConnectorTemplateTypePostErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type instantiateConnectionFromTemplateExtendedApiV1ConnectionInstantiateConnectorTemplateTypePostError = + instantiateConnectionFromTemplateExtendedApiV1ConnectionInstantiateConnectorTemplateTypePostErrors[keyof instantiateConnectionFromTemplateExtendedApiV1ConnectionInstantiateConnectorTemplateTypePostErrors]; + +export type instantiateConnectionFromTemplateExtendedApiV1ConnectionInstantiateConnectorTemplateTypePostResponses = + { + /** + * Successful Response + */ + 200: SaasConnectionTemplateResponse; + }; + +export type instantiateConnectionFromTemplateExtendedApiV1ConnectionInstantiateConnectorTemplateTypePostResponse = + instantiateConnectionFromTemplateExtendedApiV1ConnectionInstantiateConnectorTemplateTypePostResponses[keyof instantiateConnectionFromTemplateExtendedApiV1ConnectionInstantiateConnectorTemplateTypePostResponses]; + +export type getStagedResourceApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnGetData = + { + body?: never; + path: { + /** + * Staged Resource Urn + */ + staged_resource_urn: string; + }; + query?: never; + url: "/api/v1/plus/discovery-monitor/staged_resource/{staged_resource_urn}"; + }; + +export type getStagedResourceApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnGetErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type getStagedResourceApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnGetError = + getStagedResourceApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnGetErrors[keyof getStagedResourceApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnGetErrors]; + +export type getStagedResourceApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnGetResponses = + { + /** + * Response Get Staged Resource Api V1 Plus Discovery Monitor Staged Resource Staged Resource Urn Get + * + * Successful Response + */ + 200: DatastoreStagedResource | Database | Schema | Table | Field; + }; + +export type getStagedResourceApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnGetResponse = + getStagedResourceApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnGetResponses[keyof getStagedResourceApiV1PlusDiscoveryMonitorStagedResourceStagedResourceUrnGetResponses]; + +export type updateIdpStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPatchData = + { + body: StagedResourceUpdateRequest; + path: { + /** + * Monitor Config Key + */ + monitor_config_key: string; + /** + * Urn + */ + urn: string; + }; + query?: never; + url: "/api/v1/plus/identity-provider-monitors/{monitor_config_key}/results/{urn}"; + }; + +export type updateIdpStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPatchErrors = + { + /** + * Validation Error + */ + 422: HTTPValidationError; + }; + +export type updateIdpStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPatchError = + updateIdpStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPatchErrors[keyof updateIdpStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPatchErrors]; + +export type updateIdpStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPatchResponses = + { + /** + * Successful Response + */ + 200: StagedResourceAPIResponse; + }; + +export type updateIdpStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPatchResponse = + updateIdpStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPatchResponses[keyof updateIdpStagedResourceApiV1PlusIdentityProviderMonitorsMonitorConfigKeyResultsUrnPatchResponses]; + +export type dictionaryProxyApiV1PlusDictionaryRestOfPathGetData = { + body?: never; + path: { + /** + * Rest Of Path + */ + rest_of_path: string; + }; + query?: never; + url: "/api/v1/plus/dictionary/{rest_of_path}"; +}; + +export type dictionaryProxyApiV1PlusDictionaryRestOfPathGetErrors = { + /** + * Validation Error + */ + 422: HTTPValidationError; +}; + +export type dictionaryProxyApiV1PlusDictionaryRestOfPathGetError = + dictionaryProxyApiV1PlusDictionaryRestOfPathGetErrors[keyof dictionaryProxyApiV1PlusDictionaryRestOfPathGetErrors]; + +export type dictionaryProxyApiV1PlusDictionaryRestOfPathGetResponses = { + /** + * Response Dictionary Proxy Api V1 Plus Dictionary Rest Of Path Get + * + * Successful Response + */ + 200: { + [key: string]: unknown; + }; +}; + +export type dictionaryProxyApiV1PlusDictionaryRestOfPathGetResponse = + dictionaryProxyApiV1PlusDictionaryRestOfPathGetResponses[keyof dictionaryProxyApiV1PlusDictionaryRestOfPathGetResponses]; From e8dc8e97ef1b81e8f94b0f5767ed4cc93c5aefb9 Mon Sep 17 00:00:00 2001 From: Lucano Vera Date: Tue, 10 Mar 2026 00:36:46 -0400 Subject: [PATCH 5/8] =?UTF-8?q?perform=20these=20tasks:=20Generator=20conf?= =?UTF-8?q?ig=20fixes=20(Categories=202,=208)=20=E2=80=94=20fix=20in=20ope?= =?UTF-8?q?napi-ts-api.config.ts,=20regenerate,=20eliminates=20~15=20error?= =?UTF-8?q?s=20Import=20renames=20(Category=201)=20=E2=80=94=20mechanical?= =?UTF-8?q?=20find-and-replace,=20eliminates=20~17=20errors=20New=20enum?= =?UTF-8?q?=20member=20handling=20(Category=203)=20=E2=80=94=20add=20entri?= =?UTF-8?q?es=20in=20exhaustive=20maps,=20eliminates=20~4=20errors=20Stale?= =?UTF-8?q?=20directives=20(Category=209)=20=E2=80=94=20delete=20lines,=20?= =?UTF-8?q?eliminates=20~7=20errors?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- clients/admin-ui/openapi-ts-api.config.ts | 29 +++++++++++++++++++ .../chat-provider/ChatConfigurations.tsx | 16 +++++----- .../chat-provider/chatProvider.slice.ts | 20 ++++++------- .../features/common/RequestStatusBadge.tsx | 4 +++ .../consent-reporting.slice.ts | 4 +-- .../features/consent-reporting/constants.ts | 1 + .../action-center/action-center.slice.ts | 11 ++++--- .../components/InProgressMonitorTaskItem.tsx | 4 +-- .../components/InProgressMonitorTasksList.tsx | 4 +-- .../src/features/privacy-requests/cells.tsx | 4 +++ .../privacy-requests/dashboard/utils.test.ts | 7 ----- .../src/features/privacy-requests/helpers.ts | 1 + .../src/types/api/models/AllowedTypes.ts | 8 ++++- .../src/types/api/models/DATAMAP_GROUPING.ts | 13 +++++++-- 14 files changed, 86 insertions(+), 40 deletions(-) diff --git a/clients/admin-ui/openapi-ts-api.config.ts b/clients/admin-ui/openapi-ts-api.config.ts index fb11ed52d5c..07c33fc462a 100644 --- a/clients/admin-ui/openapi-ts-api.config.ts +++ b/clients/admin-ui/openapi-ts-api.config.ts @@ -22,6 +22,34 @@ export default defineConfig({ ); } }, + DATAMAP_GROUPING: (schema) => { + // Replace commas and spaces in enum values to produce valid identifier keys + if (schema.enum && Array.isArray(schema.enum)) { + // eslint-disable-next-line no-param-reassign + schema["x-enum-varnames"] = schema.enum.map((value: string) => + value + .toUpperCase() + .replace(/,\s*/g, "_") + .replace(/\s+/g, "_") + .replace(/-/g, "_"), + ); + } + }, + AllowedTypes: (schema) => { + // Assign distinct enum key names since both values would map to STRING + if (schema.enum && Array.isArray(schema.enum)) { + // eslint-disable-next-line no-param-reassign + schema["x-enum-varnames"] = schema.enum.map((value: string) => { + if (value === "string") { + return "STRING"; + } + if (value === "string[]") { + return "STRING_ARRAY"; + } + return value.toUpperCase().replace(/[^A-Z0-9]/g, "_"); + }); + } + }, }, }, hooks: { @@ -46,6 +74,7 @@ export default defineConfig({ return `models/${symbol.name}`; } // Let other symbols use default placement + return undefined; }, }, }, diff --git a/clients/admin-ui/src/features/chat-provider/ChatConfigurations.tsx b/clients/admin-ui/src/features/chat-provider/ChatConfigurations.tsx index 9dd8d1eb96d..63dd315a55b 100644 --- a/clients/admin-ui/src/features/chat-provider/ChatConfigurations.tsx +++ b/clients/admin-ui/src/features/chat-provider/ChatConfigurations.tsx @@ -20,7 +20,7 @@ import { getErrorMessage, isErrorResult } from "~/features/common/helpers"; import { CHAT_PROVIDERS_CONFIGURE_ROUTE } from "~/features/common/nav/routes"; import { useHasPermission } from "~/features/common/Restrict"; import { TableSkeletonLoader } from "~/features/common/table/v2"; -import { ChatProviderSettingsResponse, ScopeRegistryEnum } from "~/types/api"; +import { ChatConfigResponse, ScopeRegistryEnum } from "~/types/api"; import { useDeleteChatConfigMutation, @@ -71,7 +71,7 @@ export const ChatConfigurations = () => { // Delete modal state const [deleteModalOpen, setDeleteModalOpen] = useState(false); const [configToDelete, setConfigToDelete] = - useState(null); + useState(null); // Use items from the list response const tableData = useMemo(() => { @@ -86,7 +86,7 @@ export const ChatConfigurations = () => { ); const handleDeleteConfiguration = useCallback( - (config: ChatProviderSettingsResponse) => { + (config: ChatConfigResponse) => { setConfigToDelete(config); setDeleteModalOpen(true); }, @@ -134,12 +134,12 @@ export const ChatConfigurations = () => { }, []); // Column definitions - const columns: ColumnsType = useMemo( + const columns: ColumnsType = useMemo( () => [ { title: "Provider", key: ChatProviderColumnKeys.PROVIDER, - render: (_value: unknown, record: ChatProviderSettingsResponse) => { + render: (_value: unknown, record: ChatConfigResponse) => { const getProviderIcon = () => { switch (record.provider_type) { case "slack": @@ -172,7 +172,7 @@ export const ChatConfigurations = () => { { title: "Status", key: ChatProviderColumnKeys.STATUS, - render: (_value: unknown, record: ChatProviderSettingsResponse) => { + render: (_value: unknown, record: ChatConfigResponse) => { if (record.authorized) { return ( @@ -194,7 +194,7 @@ export const ChatConfigurations = () => { title: "Enabled", key: ChatProviderColumnKeys.ENABLED, width: 100, - render: (_value: unknown, record: ChatProviderSettingsResponse) => ( + render: (_value: unknown, record: ChatConfigResponse) => ( { { title: "Actions", key: ChatProviderColumnKeys.ACTIONS, - render: (_value: unknown, record: ChatProviderSettingsResponse) => ( + render: (_value: unknown, record: ChatConfigResponse) => ( {userCanUpdate && !record.authorized && record.client_id && (